listTransportationOptions

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions

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

Usage Plan:

Rate (requests per second)	Burst
2	6

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Path Params

inboundPlanId

string

required

length between 38 and 38

Identifier of an inbound plan.

Query Params

pageSize

integer

1 to 20

Defaults to 10

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

paginationToken

string

length between 0 and 1024

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.

placementOptionId

string

length between 38 and 38

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

shipmentId

string

length between 38 and 38

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

Responses

Response body

object

pagination

object

Contains tokens to fetch from a certain page.

nextToken

string

length between 1 and 1024

When present, pass this string token in the next request to return the next response page.

transportationOptions

array of objects

required

Transportation options generated for the placement option.

transportationOptions*

object

carrier

object

required

The carrier for the inbound shipment.

carrierAppointment

object

Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.

preconditions

array of strings

required

Identifies a list of preconditions for confirming the transportation option.

preconditions*

quote

object

The estimated shipping cost associated with the transportation option.

shipmentId

string

required

length between 38 and 38

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

shippingMode

string

required

length between 1 and 1024

Mode of shipment transportation that this option will provide.

Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS.

shippingSolution

string

required

length between 1 and 1024

Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER.

transportationOptionId

string

required

length between 38 and 38

Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/inboundPlanId/transportationOptions?pageSize=10' \
3
     --header 'accept: application/json'


xxxxxxxxxx
32
}
1
{
2
  "pagination": {
3
    "nextToken": "string"
4
  },
5
  "transportationOptions": [
6
    {
7
      "carrier": {
8
        "alphaCode": "ABCD",
9
        "name": "Carrier Name"
10
      },
11
      "carrierAppointment": {
12
        "endTime": "2024-01-06T14:48:00.000Z",
13
        "startTime": "2024-01-05T14:48:00.000Z"
14
      },
15
      "preconditions": [
16
        "CONFIRMED_DELIVERY_WINDOW"
17
      ],
18
      "quote": {
19
        "cost": {
20
          "amount": 5.5,
21
          "code": "CAD"
22
        },
23
        "expiration": "2024-01-06T14:48:00.000Z",
24
        "voidableUntil": "2024-01-05T14:48:00.000Z"
25
      },

200ListTransportationOptions 200 response

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.