Anexar documentos a uma remessa
Para anexar documentos na remessa, você deve utilizar o método POST na rota /v1/shipments/{identification}/attachments.
O paramêtro identification pode ser o ID da remessa ou o Tracking da remessa.
- ID da remessa: sempre retorna no campo
shipment_id - Tracking da remessa: sempre retorna no campo
tracking_code
Endpoint: /v1/shipments/{identification}/attachments
http
POST /v1/shipments/{identitication}/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
{ json | formData }
Este método suporta envio de arquivo binario no formato multipart/form-data ou urls publicar via json application/json.
Obs: O paramêtro de URL identitication pode ser o ID da remessa ou o código de rastreio.
Parametros:
| Property | Required | Type | Description |
|---|---|---|---|
| attachments | Y | Array | Array |
| document_code | N | String | If attachment is a document |
| file_name | Y | String | File name |
| url | Y | Integer | File Public URL |
Exemplos
Enviando json com urls:
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
{
"attachments" : [
{
"url" : "https://tristarexpress.com/wp-content/uploads/2022/07/AF_logotipo_tristar_EXPRESS_NEGATIVO.png",
"document_code" : "DOCUMENT"
},
{
"url" : "https://tristarexpress.com/wp-content/uploads/2022/07/AF_logotipo_tristar_EXPRESS_NEGATIVO.png",
"file_name" : "CPF.png",
"document_code" : "DOCUMENT"
}
]
}
Enviando arquivos binários:
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: multipart/form-data
Accept: application/json
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][file]"; filename="Arquivo.png"
Content-Type: <Content-Type header here>
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][document_code]"
DOCUMENT
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[1][document_code]"
DOCUMENT
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[1][file]"; filename="Arquvio2.png"
Content-Type: <Content-Type header here>
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--