Get Order
GET/api/pinnacle/instances/:instance/orders/:order
Returns one Pinnacle order by local id or tracking number. Includes everything in the list row plus the item lines that were sent (each SKU resolved to its product id), every labelled piece (16-digit barcode), the full tracking event timeline (newest first; closure_reason is set for cancellation/closure events), proof-of-delivery files with download URLs, the shipment, and the exact CreateOrder request and response payloads. external_url links to the order in the Pinnacle portal when one is configured for the environment, otherwise null. can_cancel / can_refresh indicate whether Cancel Order / Refresh Order Tracking apply.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
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.