Get Order Raw Payloads
GET/api/pinnacle/instances/:instance/orders/:order/raw
Returns the raw Pinnacle data for an order: a live GetTrackingDetails pull (one rate-limited Pinnacle call) together with the stored CreateOrder request and response payloads. If the live pull fails, tracking_details is null, tracking_details_error explains why, and the stored payloads are still returned. Orders never registered with Pinnacle have no tracking number and return only the stored payloads.
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.