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

post

Attach documents to a delivery.

Authorizations

Body

filesfilerequired

Document to attach to the delivery.

typestring · enumrequired

Type of document to attach.

Example: fiscal_documentAvailable options:

deliveryIdstringrequired

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

Example: t-shiinc-27946

referenceIdstringoptional

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

Example: t-shiinc-27946

extraDataNamestringoptional

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

Example: CUSTOMER_TAX_ID

extraDataValuestringoptional

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

Example: 09902626382001

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

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": "CUSTOMER_TAX_ID",
  "extraDataValue": "09902626382001"
}

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

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.