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

Anexar os documentos a uma entrega.

POSThttps://api.shippify.co/v2/integrations/deliveries/files

Authorization

Basic_Auth

Body

multipart/form-data

Aqui vai a descrição.

files*file

Documento que será anexado na entrega.

type*enum

Tipo de documento a ser anexado.

Example: "fiscal_document"

fiscal_documentproof_of_delivery

deliveryId*string

Identificador da entrega que se deseja anexar o arquivo.

Example: "t-shiinc-27946"

referenceIdstring

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

Example: "t-shiinc-27946"

extraDataNamestring

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

Example: "RUC_DEL_CLIENTE"

extraDataValuestring

Valor da extradata da entrega que se deseja anexar o arquivo

Example: "09902626382001"

Response

200401

Operação bem sucedida.

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Arquivos anexados com sucesso."

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v2/integrations/deliveries/files', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "type": "fiscal_document",
      "deliveryId": "t-shiinc-27946"
    }),
});
const data = await response.json();

Response

200401

{
  "code": "OK",
  "message": "Arquivos anexados 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.