Documentation
Carrier API (Galaxy)
API DocumentationSSO (Single sign-on)Carrier API (Galaxy)
Carrier API (Galaxy)
API DocumentationSSO (Single sign-on)Carrier API (Galaxy)
  • Carrier [Galaxy]
    • General considerations
      • Resources [api]
        • Metadata [Dictionary]
        • Shipment Modes [Dictionary]
        • Tracking points [Sample]
        • Documents Types [Sample]
        • Content Types [Sample]
        • My accounts
        • *My Active Shippers
      • Postman Project
      • Full Swagger
    • Shipments [webhook]
      • Setting up webhooks
      • Securing webhooks
      • Retry Mechanism
      • Carrier Payloads
    • Trackings [api]
      • By SH ID
        • TPs by SH ID
        • Create TP by SH ID
        • Replan Pickup by SH ID
        • Confirm Pickup by SH ID
        • Replan Delivery by SH ID
        • Confirm Delivery by SH ID
      • By TP ID
        • Update TP location by TP ID
        • Cancel TP by TP ID
        • Replan TP by TP ID
        • Confirm TP by TP ID
    • Metadata [api]
      • Shipment_request scope
        • Get MD by SR ID
        • Create MD by SR ID
        • Update MD by SR ID
      • Shipment scope
        • Get MD by SH ID
        • Create MD by SH ID
        • Update MD by SH ID
    • Documents [api]
      • Shipment scope
        • *Get Attachments by SH_ID
        • Upload Attachment by SH_ID
      • Shipment Request scope
        • *Get Attachments by SR_ID
      • Get Attachment by Attachment ID
Powered by GitBook
On this page
  • Scopes
  • Download Flow
  • Upload Key Fields
  • Document Types
  1. Carrier [Galaxy]

Documents [api]

Scopes

You can upload or download documents at either of the following scopes:

  • Shipment Request scope (Download only)

  • Shipment scope

Download Flow

To download a document, you must first retrieve its Attachment ID from either the Shipment Request or the Shipment. Then, use the dedicated endpoint to download the document.

Upload Key Fields

  • accessType: Defines the accessibility of the document. Possible values are "public", "limited", and "private".

  • save: Indicates whether the document should be saved in the system.

  • authRequired: Indicates whether authentication is required. Supported authentication methods include Basic Auth, Key-Value in Header, and Query String Parameter.

Document Types

In resources, you can find some examples of the different document types that can be specified in the documentType field.

Last updated 5 months ago