Download Documents

Get documents thanks to Public Shiptify API

Workflow

Downlaod Documents workflow

Endpoints to use

List of attachments for shipment by identifier.

get

List of attachments for shipment by identifier.

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idintegerRequired

Shipment identifier.

Header parameters

X-Account-IDintegerOptional

Account identifier

Responses

200

OK

application/json

Attachment

idintegerRequiredExample: 1

namestringOptional

File name

Example: unspecified.png

typestring · enumOptionalExample: arrival_noticePossible values:

statusstring · enumOptional

Status of attachment

Example: activePossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found Error

application/json

500

Internal Error

application/json

get

/shipments/{id}/attachments

HTTPcURLJavaScriptPython

GET /shipments/{id}/attachments HTTP/1.1
Host: api.shiptify.com/
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "unspecified.png",
    "type": "arrival_notice",
    "status": "active"
  }
]

Get link for download attachment.

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idintegerRequired

Attachment identifier.

Header parameters

X-Account-IDintegerOptional

Account identifier

Responses

200

OK

application/json

stringOptional

link for download attachments

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found Error

application/json

500

Internal Error

application/json

get

/attachments/{id}/download

HTTPcURLJavaScriptPython

GET /attachments/{id}/download HTTP/1.1
Host: api.shiptify.com/
Authorization: YOUR_API_KEY
Accept: */*

text