Documentation
API Documentation
API Documentation
  • General Overview
    • Introduction
      • Before you start
      • Environments
      • Integration
    • Objects and IDs
      • Shipments Requests (Bookings)
      • Shipments
      • Tracking Points
      • Addresses
    • 📖Glossary
  • I am a shipper
    • Webhooks
      • Set up my webhooks
      • Payloads for Shipper
    • Documents
      • Download Documents
      • Upload Documents
  • I am a carrier
    • Bookings
      • Set up my webhooks
      • Payloads for Carrier
    • Trackings
    • Documents
      • Download Documents
      • Upload Documents
  • Full API
    • Swagger API Endpoints
Powered by GitBook
On this page
  1. I am a carrier
  2. Documents

Download Documents

Get documents thanks to Public Shiptify API

PreviousDocumentsNextUpload Documents

Last updated 1 year ago

Workflow

Endpoints to use

Downlaod Documents workflow

List of attachments for shipment by identifier.

get

List of attachments for shipment by identifier.

Authorizations
Path parameters
idintegerRequired

Shipment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

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
get
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
Path parameters
idintegerRequired

Attachment identifier.

Header parameters
X-Account-IDintegerOptional

Account identifier

Responses
200
OK
application/json
Responsestring

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
GET //attachments/{id}/download HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Accept: */*
text
  • Workflow
  • Endpoints to use
  • GETList of attachments for shipment by identifier.
  • GETGet link for download attachment.