Refresh Shipment
POST/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/shipments/:plan_shipment/refresh
Synchronous on-demand refresh of one shipment from Amazon (the board's refresh button): runs SP-API getShipment (status + tracking) and listShipmentItems (shipped/received quantities), then recomputes the per-item discrepancy statuses. Returns the shipment's updated board entry. No request body.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Received quantities are only updated when Amazon includes a received-quantity key — absent keys never zero out previously synced values. The same refresh also runs hourly for all non-terminal shipments via the scheduled amazon:fba-inbound:sync-shipments sweep (terminal Amazon statuses: CLOSED, CANCELLED, DELETED).
Response: the updated shipment in Get Shipment Board entry shape (standard plan-shipment payload + days_since_shipped, units_shipped, units_received, boxes_count, claim_deadline, claim_days_remaining, reconciliation_status).
Errors:
- 404 — the shipment does not belong to this draft inbound plan
- 422 — Amazon rejected the request (SP-API client-error messages are parsed and surfaced per field)
Authentication: Bearer token (PAT).
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 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.