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.