Download Proof of Delivery
GET/api/pinnacle/instances/:instance/shipments/:shipment/pods/:index
Downloads a stored proof-of-delivery file as an attachment with its original filename. {shipment} must be the local shipment id (numeric) and {index} the file's zero-based position in the shipment's pod_files list; each pod_files entry already carries this path as download_url.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The response is a file (typically application/pdf or an image), not JSON. Returns 404 when the shipment does not belong to the instance, the index does not exist, or the file is no longer available.
Authentication: requires a Bearer token (Personal Access Token).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.