Sync Orders
POST/api/pinnacle/instances/:instance/sync/orders
Queues a background job that reconciles Pinnacle orders (GetOrders) into SKU.io for a date window, creating or updating local order records. Returns immediately with the background job's id and name.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields (all optional):
- mode (string): since_last (default — from the last successful orders sync), from_start_date (from the instance's configured sync_start_date; 422 if none is set), custom_range (date_from..date_to), or specific (one tracking_number).
- date_from (string, Y-m-d): required when mode is custom_range.
- date_to (string, Y-m-d, on or after date_from): required when mode is custom_range.
- tracking_number (string, max 50): required when mode is specific.
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.