Refresh Order Tracking
POST/api/pinnacle/instances/:instance/orders/:order/refresh
Synchronously pulls the latest GetTrackingDetails snapshot for one order (one rate-limited Pinnacle call) and applies it: new tracking events, status, pickup/delivery dates and, when the configured shipped event is reached, the shipment and fulfillment. Returns the refreshed order. No request body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
422 codes: not_registered (no tracking number) and api_error (Pinnacle could not be reached, rate-limited the call, or returned an error).
Authentication: requires a Bearer token (Personal Access Token).
Requires the integrations.sync permission; without it the request is refused with 403.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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
Unprocessable Entity
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.