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.

Autorizaciones
Cuerpo
filesfileRequerido

Documento que será anexado na entrega.

typestring · enumRequerido

Tipo de documento a ser anexado.

Example: fiscal_documentValores posibles:
deliveryIdstringRequerido

Identificador da entrega que se deseja anexar o arquivo.

Example: t-shiinc-27946
referenceIdstringOpcional

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

Example: t-shiinc-27946
extraDataNamestringOpcional

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

Example: RUC_DEL_CLIENTE
extraDataValuestringOpcional

Valor da extradata da entrega que se deseja anexar o arquivo

Example: 09902626382001
Respuestas
200
Operação bem sucedida.
application/json
post
POST /v2/integrations/deliveries/files HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 168

{
  "files": null,
  "type": "fiscal_document",
  "deliveryId": "t-shiinc-27946",
  "referenceId": "t-shiinc-27946",
  "extraDataName": "RUC_DEL_CLIENTE",
  "extraDataValue": "09902626382001"
}
{
  "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.

Última actualización