Skip to main content

Get Shipment Board

GET 
/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/tracking/board

Post-ship shipment board for a draft inbound plan: every shipment of the plan's confirmed placement option with its items, extended with the Phase 7 monitoring fields. Data is refreshed hourly by the scheduled amazon:fba-inbound:sync-shipments sweep (and on demand via Refresh Shipment).

Authorization

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

Board-only fields (on top of the standard plan-shipment payload):

  • days_since_shipped (integer|null) — whole days since shipped_at; null when not yet marked shipped
  • units_shipped / units_received (integer) — sums of the item quantities
  • boxes_count (integer) — number of boxes on the shipment
  • claim_deadline (date|null) — shipped_at + 60 days (Amazon's reimbursement claim window, policy since Oct 2024); null when not shipped
  • claim_days_remaining (integer|null) — whole days until claim_deadline (negative once lapsed); null when not shipped
  • reconciliation_status (string) — shipment-level rollup of the item discrepancy statuses: pending (nothing decided yet, or some items still PENDING/undecided), match (every item MATCH), short (any SHORT), over (any OVER), mixed (both SHORT and OVER present)

Discrepancy mapping (per item, recomputed on every sync):

  • amazon_status NOT in (RECEIVING, CLOSED) → null (too early to judge)
  • received == shipped → MATCH
  • received > shipped → OVER
  • received < shipped and amazon_status = CLOSED → SHORT (final shortage)
  • received < shipped and amazon_status = RECEIVING → PENDING (still being received)

Responses include items (id, msku, fnsku, quantity_shipped, quantity_received). Pallets, transportation options, and delivery window options are NOT loaded on the board endpoint — use List Shipments (Placement & Transport) for those.

Authentication: Bearer token (PAT).

Request​

Responses​

OK

Response Headers
    Content-Type