Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization identifier.

Example:

"org_1a2b3c4d"

shipmentId
string
required

Shipment identifier.

Example:

"shp_4d9e7a2f"

documentId
string
required

Document identifier.

Example:

"doc_8f3a2b1c"

Query Parameters

disposition
enum<string>
default:inline

Render the document inline (default) or force a download.

Available options:
inline,
attachment
Example:

"inline"

filename
string

Suggested filename (without extension) for attachment downloads.

Example:

"label"

Response

200

Default Response