Enviar arquivos

Este endpoint permite que você anexe arquivos como PDFs ou imagens diretamente a entregas específicas, usando dados de formulário multipart. Você pode fazer upload de documentos fiscais ou comprovante

Endpoint

POST {{SHIPPIFY_API_URL}}/v2/integrations/deliveries/:deliveryId/files

Request

Tipos de mídias suportadas

multipart/form-data

Headers

Propriedade	Tipo	Descrição	Exemplo
Content-Type	string		"multipart/form-data"
Authorization	string	Autenticação básica da empresa.	"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Url Parâmetros

Propriedade	Tipo	Descrição	Required	Constraints
deliveryId	string	ID da tarefa criada dentro do sistema.	YES

Parâmetros de formulário

Propriedade	Tipo	Descrição	Obrigatório
files	file	Arquivo a enviar.	SIM
type	string	fiscal_document or proof_of_delivery(padrão)	SIM

The supported file extensions are pdf, jpeg, jpg, png, txt.

Response

Propriedade	Tipo	Descrição
code	string	Código do resultado.
message	string	Descrição do resultado.

Exemplo

Documentos fiscais

Request

curl --location 'https://api.shippify.co/v2/integrations/deliveries/t-shippify2-9/files' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--form 'files=@"document.pdf"' \
--form 'type="fiscal_document"'

200 Success

{
    "code": "OK",
    "message": "Upload success"
}

412 Precondition

{
    "code": "PF",
    "message": "Precondition failed. File type not supported."
}

500 Error

{
    "code":"UE",
    "message":"Server Error"
}

Comprovante de entrega

Request

curl --location 'https://api.shippify.co/v2/integrations/deliveries/t-shippify2-9/files' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--form 'files=@"image.png"' \
--form 'type="proof_of_delivery"'

200 Success

{
    "code": "OK",
    "message": "Upload success"
}

412 Precondition

{
    "code": "PF",
    "message": "Precondition failed. File type not supported."
}

500 Error

{
    "code":"UE",
    "message":"Server Error"
}