Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Fulfillment Inbound v2024-03-20

listTransportationOptions

Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before becoming available.

get/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions

Path parameters

inboundPlanIdstring required

Identifier of an inbound plan.

Query parameters

pageSizeinteger

The number of transportation options to return in the response matching the given query.

paginationTokenstring

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

placementOptionIdstring

The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.

shipmentIdstring

The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.

Response

ListTransportationOptions 200 response

Example response

{
  "transportationOptions": [
    {
      "carrier": {
        "alphaCode": "ABCD",
        "name": "Carrier Name"
      },
      "carrierAppointment": {
        "endTime": "2024-01-06T14:48:00.000Z",
        "startTime": "2024-01-05T14:48:00.000Z"
      },
      "preconditions": [
        "CONFIRMED_DELIVERY_WINDOW"
      ],
      "quote": {
        "cost": {
          "amount": 5.5,
          "code": "CAD"
        },
        "expiration": "2024-01-06T14:48:00.000Z",
        "voidableUntil": "2024-01-05T14:48:00.000Z"
      },
      "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
      "shippingMode": "GROUND_SMALL_PARCEL",
      "shippingSolution": "AMAZON_PARTNERED_CARRIER",
      "transportationOptionId": "to1234abcd-1234-abcd-5678-1234abcd5678"
    }
  ]
}