Upload Documents

Hosted on Shiptify or not

Thanks to save attribute, you have the choice to:

• Either provide the link to a document hosted out of Shiptify

• Or provide the file itself so the document is hosted within Shiptify

Authentication

Please be in touch with your Shiptify contact for Authentication questions.

Endpoint to use

Upload files to shipment

post

/shipments/{id}/upload

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

attachmentsobject[]

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shiptify.com//shipments/{id}/upload' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "attachments": [
      {
        "url": "https://example.com/example-doc.pdf",
        "fileName": "Some document name without extension",
        "save": true,
        "authRequired": true,
        "documentType": "arrival_notice"
      }
    ]
  }'

200

400

401

404

500

200

{
  "successful": true
}

OK