Skip to main content

Generate Transportation Options

POST 
/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/transportation-options/generate

Generate transportation options (carrier quotes) for the confirmed placement's shipments via the Amazon FBA Inbound API (v2024-03-20 generateTransportationOptions operation). Amazon returns partnered-carrier and own-carrier options per shipping mode for each shipment.

Authorization

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

This is an asynchronous endpoint: it dispatches a tracked background job and returns { "data": { "tracked_job_log_id": <id> } } immediately. Progress is visible via the tracked job log endpoints, and the underlying Amazon operation is resolved by the amazon_inbound_operations poller (a background job).

Tracked job name: Generate FBA Transportation Options: {plan name}. When the job completes, the offered options are persisted locally and can be retrieved with List Transportation Options or nested on List Shipments.

Request body fields:

  • shipments (array, required, min 1) — one entry per shipment to quote
  • shipments.*.shipment_id (integer, required) — LOCAL plan-shipment row id (not the Amazon shipment id); must belong to this draft inbound plan (422 otherwise)
  • shipments.*.ready_to_ship_date (date, required) — must be today or later (422: “The ready-to-ship date must be today or later.”)
  • shipments.*.pallets (array, optional) — pallet configuration, needed for freight (LTL/FTL) quotes
  • shipments.*.pallets.*.length / width / height (numeric, required, > 0)
  • shipments.*.pallets.*.weight (numeric, required, > 0)
  • shipments.*.pallets.*.dimension_unit (string, optional, IN or CM)
  • shipments.*.pallets.*.weight_unit (string, optional, LB or KG)
  • shipments.*.pallets.*.stackability (string, optional, nullable, STACKABLE or NON_STACKABLE)
  • shipments.*.pallets.*.quantity (integer, required, min 1)

Pre-flight validation (HTTP 422, checked synchronously before the job is dispatched):

  • a placement option must already be confirmed for the plan
  • every shipment_id must belong to this draft inbound plan

Request​

Responses​

OK

Response Headers
    Content-Type