Sync Tracking
POST/api/pinnacle/instances/:instance/sync/tracking
Queues a background job that pulls GetTrackingDetails for the next rotating slice of open (non-terminal) orders, oldest-synced first, and applies new tracking events, status changes and shipments. Pinnacle allows one request per second per account, so each run is bounded. To refresh a single order use Refresh Order Tracking instead.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields (all optional):
- limit (integer|null, 1–1000): number of orders to poll in this run; defaults to the configured slice size.
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.