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.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Cuerpo

multipart/form-data

filesfileRequerido

Document to attach to the delivery.

typestring · enumRequerido

Type of document to attach.

Example: fiscal_documentValores posibles:

deliveryIdstringRequerido

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

Example: t-shiinc-27946

referenceIdstringOpcional

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

Example: t-shiinc-27946

extraDataNamestringOpcional

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

Example: CUSTOMER_TAX_ID

extraDataValuestringOpcional

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

Example: 9999999999999

Respuestas

200

Successful operation

application/json

401

Unauthorized

application/json

post

/v2/integrations/deliveries/files

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: 167

{
  "files": null,
  "type": "fiscal_document",
  "deliveryId": "t-shiinc-27946",
  "referenceId": "t-shiinc-27946",
  "extraDataName": "CUSTOMER_TAX_ID",
  "extraDataValue": "9999999999999"
}

{
  "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.