Refresh Inbound Plans
POST/api/amazon/:integrationInstance/new-inbound/plans/refresh
Refreshes the integration's FBA inbound plans from Amazon. The request synchronously pulls inbound plan summaries from the SP-API — first plans in SHIPPED status, then ACTIVE (some active plans already have shipments) — and upserts them, along with the ship-from address mappings found on those plans.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
It then queues background jobs that download each plan's full details, line items, and shipments, so plan data keeps loading after the response returns; there is no job id to poll — re-query the inbound plan list to see updated data. No request body or query parameters.
Because the summary fetch calls Amazon synchronously, the response can take several seconds on accounts with many plans.
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.