Anexar documentos à entrega

Este endpoint permite anexar arquivos, como PDFs ou imagens, diretamente a entregas específicas, utilizando formulários multipart. Você pode carregar documentos fiscais ou comprovantes de entrega.

Anexar documentos

post

Anexar documentos a uma entrega.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Cuerpo

multipart/form-data

filesfileRequerido

Documento a ser anexado à entrega.

typestring · enumRequerido

Tipo de documento a anexar.

Example: fiscal_documentValores posibles:

deliveryIdstringRequerido

Identifier of the delivery to which the file is to be attached.

Example: t-shiinc-27946

referenceIdstringOpcional

Reference identifier of the delivery to which the file is to be attached.

Example: t-shiinc-27946

extraDataNamestringOpcional

Name of the extra data of the delivery to which the file is to be attached.

Example: CUSTOMER_TAX_ID

extraDataValuestringOpcional

Value of the extra data of the delivery to which the file is to be attached.

Example: 9999999999999

Respuestas

200

Operação bem-sucedida

application/json

codestringOpcionalExample: OK

messagestringOpcionalExample: Arquivos enviados com sucesso

401

Não autorizado

application/json

post

/v2/integrations/deliveries/files

HTTPcURLJavaScriptPython

POST /v2/integrations/deliveries/files HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 167

{
  "files": null,
  "type": "fiscal_document",
  "deliveryId": "t-shiinc-27946",
  "referenceId": "t-shiinc-27946",
  "extraDataName": "CUSTOMER_TAX_ID",
  "extraDataValue": "9999999999999"
}

{
  "code": "OK",
  "message": "Arquivos enviados com sucesso"
}

Casos de uso

Anexar documentos à uma entrega por id

Usar deliveryId nos parâmetros.

Anexar documentos à uma entrega por id de referência

Usar referenceId nos parâmetros.

Anexar documentos à uma entrega por dados extra

Usar extraDataName e extraDataValue nos parâmetros.