Attach documents to a delivery

This endpoint allows you to attach files such as PDFs or images directly to specific deliveries using multipart forms. You can upload fiscal documents or proof of delivery.

Attach Documents

Attach documents to a delivery.

post

/v2/integrations/deliveries/files

Authorizations

Body

filesfilerequired

Document to attach to the delivery.

deliveryIdstringrequired

Identifier of the delivery to which the file is to be attached.

Example: t-shiinc-27946

referenceIdstring

Reference identifier of the delivery to which the file is to be attached.

Example: t-shiinc-27946

extraDataNamestring

Name of the extra data of the delivery to which the file is to be attached.

Example: CUSTOMER_TAX_ID

extraDataValuestring

Value of the extra data of the delivery to which the file is to be attached.

Example: 09902626382001

typestring · enumrequired

Type of document to attach.

Example: fiscal_document

Options: fiscal_document, proof_of_delivery

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shippify.co/v2/integrations/deliveries/files' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=null' \
  --form 'deliveryId=t-shiinc-27946' \
  --form 'referenceId=t-shiinc-27946' \
  --form 'extraDataName=CUSTOMER_TAX_ID' \
  --form 'extraDataValue=09902626382001' \
  --form 'type=fiscal_document'

200

401

200

{
  "code": "OK",
  "message": "Files uploaded successfully"
}

Successful operation

Use cases

Attach documents to a delivery by the ID

Use deliveryId in the parameters.

Attach documents to a delivery by the referenceID

Use referenceId in the parameters.

Attach documents to a delivery by extra data

Use extraDataName and extraDataValue in the parameters.