Sync Orders

POST 
/api/shipstation/integration-instances/:integration_instance/orders/sync

Queue a background orders sync from ShipStation into the local cache. Dispatches a tracked job (a background job, job name Sync ShipStation Orders: {instance name}) and returns its tracked_job_log_id for polling via the tracked job log endpoints or the sync-progress endpoint.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Body parameters (all optional):

• mode — string. One of since_latest | date_range | all. With all the job ignores any start date and pulls full history; with date_range use date_from/date_to; with since_latest the job resumes from the most recently synced order.
• date_from — date/datetime string (Carbon-parseable). Start bound for the fetch. (since_date is accepted as a deprecated alias for backward compatibility with the previous one-click refresh payload.)
• date_to — date/datetime string (Carbon-parseable). Optional end bound (date_range mode).

Authentication: Requires Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.