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

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idintegerRequired

Shipment identifier.

Header parameters

X-Account-IDintegerOptional

Account identifier

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found Error

application/json

500

Internal Error

application/json

post

/shipments/{id}/upload

HTTPcURLJavaScriptPython

POST /shipments/{id}/upload HTTP/1.1
Host: api.shiptify.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "attachments": [
    {
      "url": "https://example.com/example-doc.pdf",
      "fileName": "Some document name without extension",
      "documentType": "arrival_notice",
      "save": true,
      "authRequired": true
    }
  ]
}

{
  "successful": true
}