Refresh All (Sync from Amazon)
POST/api/amazon/unified/new-inbound-shipments/refresh
Dispatches a background job to (re)sync new FBA inbound shipments (via their plans) from Amazon for one or more integration instances. Returns immediately with a tracked_job_log_id that the frontend uses to render progress via the tracked job log endpoints.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body / query params:
integration_instance_ids(optional) — comma-separated string or array of AmazonIntegrationInstance IDs. When omitted, the job runs for every Amazon integration instance.
The job name is Sync FBA New Inbound Shipments: <instance name | N Integrations> — frontend watchers should match on that startsWith.
Request
Responses
- 200
- 401
- 403
- 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.
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.
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.