Download Documents

Get documents thanks to Public Shiptify API

Workflow

Downlaod Documents workflow

Endpoints to use

List of attachments for shipment by identifier.

List of attachments for shipment by identifier.

GEThttps://api.shiptify.com//shipments/{id}/attachments

Authorization

ApiKey

Path parameters

id*integer

Shipment identifier.

Header parameters

Response

200400401404500

OK

Body

application/json

id*integer

Example: 1

namestring

File name

Example: "unspecified.png"

typeenum

Example: "arrival_notice"

invoiceordercustomspacking_listpickup_detailsdelivery_detailsexpected_departuredeparture_noticebill_of_ladingquality_checkorigin_certificatetemperature_dataotherarrival_noticepacking_notedelivery_notereturn_notecmr_at_departurelabelhazardous_material_declarationquotetdsbusiness_invoiceclaimweighing_ticketAvoircontainer_placementawbmsdsasnvgmcustoms_code_declarationquality_certificatecmrsigned_cmr_at_arrivalhouse_bill_of_ladinghouse_air_way_billother_customsproof_of_deliverydestruction_certificatedrafteasaletter_of_creditclaimsecurity_protocolfreight_forwarder_invoice

statusenum

Status of attachment

Example: "active"

activedeactivated

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//shipments/{id}/attachments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404500

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

Get link for download attachment.

GEThttps://api.shiptify.com//attachments/{id}/download

Authorization

ApiKey

Path parameters

id*integer

Attachment identifier.

Header parameters

Response

200400401403404500

OK

Body

application/json

string

link for download attachments

Request

JavaScriptCurlPython

const response = await fetch('https://api.shiptify.com//attachments/{id}/download', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

text