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 os documentos a uma entrega.

Authorizations

Body

filesfilerequired

Documento que será anexado na entrega.

typestring · enumrequired

Tipo de documento a ser anexado.

Example: fiscal_documentAvailable options:

deliveryIdstringrequired

Identificador da entrega que se deseja anexar o arquivo.

Example: t-shiinc-27946

referenceIdstringoptional

Id de referência da entrega que se deseja anexar o arquivo.

Example: t-shiinc-27946

extraDataNamestringoptional

Nome da extradata da entrega que se deseja anexar o arquivo.

Example: RUC_DEL_CLIENTE

extraDataValuestringoptional

Valor da extradata da entrega que se deseja anexar o arquivo

Example: 09902626382001

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shippify.co/v2/integrations/deliveries/files' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=null' \
  --form 'type=fiscal_document' \
  --form 'deliveryId=t-shiinc-27946' \
  --form 'referenceId=t-shiinc-27946' \
  --form 'extraDataName=RUC_DEL_CLIENTE' \
  --form 'extraDataValue=09902626382001'

200

401

200

{
  "code": "OK",
  "message": "Arquivos anexados com sucesso."
}

Operação bem sucedida.

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.