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.

POSThttps://api.shippify.co/v2/integrations/deliveries/files

Authorization

Basic_Auth

Body

multipart/form-data

Description goes here

files*file

Document to attach to the delivery.

type*enum

Type of document to attach.

Example: "fiscal_document"

fiscal_documentproof_of_delivery

deliveryId*string

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"

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Files uploaded successfully"

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v2/integrations/deliveries/files', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "type": "fiscal_document",
      "deliveryId": "t-shiinc-27946"
    }),
});
const data = await response.json();

Response

200401

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