Skip to main content

List Shipments

GET 
/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/shipments

List the plan shipments of the draft FBA inbound plan with all placement/transport details nested: items, pallets, transportation_options, and delivery_window_options.

Authorization

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

Note: once a placement option has been confirmed, only the confirmed split's shipments are returned — preview shipments belonging to the rejected (expired) placement options are excluded.

Field notes:

  • local_status — lowercase, one of pending, ready, shipped, checked_in, receiving, closed, cancelled
  • amazon_status — Amazon's raw shipment status (e.g. UNCONFIRMED, WORKING, SHIPPED)
  • confirmed_delivery_window — populated after a delivery window option is confirmed for the shipment
  • transportation_options[] / delivery_window_options[] — same shape as the corresponding list endpoints
  • tracking_summary / freight_bill_numbers / shipped_at — filled in later by the shipping workflow

Each shipment includes distance_miles (integer|null): the great-circle distance in miles from the plan origin (source warehouse) to that fulfillment center, computed from internal zip coordinates. Null when a zip cannot be geocoded.

Request​

Responses​

OK

Response Headers
    Content-Type