Upload files

This endpoint lets you attach files like PDFs or images, directly to specific deliveries, using multipart form data. You can upload fiscal documents or proof of deliveries for shipment management.

Endpoint

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

Request

Supported Media Types

multipart/form-data

Headers

Property	Type	Description	Example value
Content-Type	string		"multipart/form-data"
Authorization	string	Company basic auth	"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Url Parameters

Property	Type	Description	Required	Constraints
deliveryId	string	Id of the task created within the system.	YES

Form Parameters

Property	Type	Description	Required
files	file	File to upload.	YES
type	string	fiscal_document or proof_of_delivery(default)	YES

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

Response

Property	Type	Description
code	string	Result code.
message	string	Result description.

Example

Fiscal Document

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

Proof of delivery

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