Retrieve printable documents for a purchased shipment

Returns the label, customs, and other printable documents associated with a previously-purchased shipment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

shipmentIdstringRequired
Identifier of the shipment whose documents to retrieve.

Query parameters

packageClientReferenceIdstringOptional

Optional package-level reference id to retrieve documents for a specific package within a multi-package shipment.

formatenumOptional

Requested document format (defaults to PDF).

Allowed values:

Response

Documents returned successfully
payloadobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error