Refresh Inbound Plans From Amazon
POST/api/amazon/:integrationInstance/draft-inbound-plans/refresh-from-amazon
Refresh the "Inbound Plans" tab from Amazon. Dispatches a tracked background job (follow it via the tracked job log endpoints) and returns its tracked_job_log_id.
Requires a Bearer token.
Body (all optional; defaults to a full re-sync):
- mode: all | since_latest | from_start_date | date_range
- latest_date: lower bound for since_latest (ISO 8601 / date)
- date_from: lower bound for from_start_date and date_range (Y-m-d)
- date_to: upper bound for date_range (Y-m-d)
Bounds are applied against each plan's lastUpdatedAt; Amazon's list is paged sorted by LAST_UPDATED_TIME DESC and stops once it passes the lower bound.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
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.
Unprocessable Content
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.