Carga de archivos

Este endpoint te permite adjuntar archivos como PDF o imágenes, directamente a entregas específicas, utilizando formularios multiparte. Puedes cargar documentos fiscales o comprobantes de entrega.

Endpoint

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

Request

Tipos de soportes admitidos

multipart/form-data

Headers

Propiedad	Tipo	Descripción	Valor de ejemplo
Content-Type	string		"multipart/form-data"
Authorization	string	Autenticación básica de la empresa.	"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Parámetros de la URL

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
deliveryId	string	Id de la tarea creada en el sistema.	SI

Parámetros del formulario

Propiedad	Tipo	Descripción	Required
files	file	Archivo a cargar.	YES
type	string	fiscal_document o proof_of_delivery(default)	YES

Las extensiones de archivo admitidas son pdf, jpeg, jpg, png, txt.

Response

Propiedad	Tipo	Descripción
code	string	Código del resultado.
message	string	Descripción del resultado.

Ejemplo

Documento fiscal

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"
}

Prueba 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"
}