listTransportationOptions

GET

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

Fulfillment Inbound

Last modified:2024-12-05 08:51:44

Maintainer:Not configured

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.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Query Params

pageSize

integer

optional

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

>= 1<= 20

Default:

paginationToken

string

optional

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.

>= 0 characters<= 1024 characters

placementOptionId

string

optional

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

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentId

string

optional

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

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//transportationOptions'

Responses

🟢200OK

application/json

ListTransportationOptions 200 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

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

Body

The `listTransportationOptions` response.

pagination

object (Pagination)

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

transportationOptions

array[object (TransportationOption) {8}]

required

Transportation options generated for the placement option.

carrier

object (Carrier)

required

The carrier for the inbound shipment.

carrierAppointment

object (CarrierAppointment)

optional

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[string]

required

Identifies a list of preconditions for confirming the transportation option.

quote

object (Quote)

optional

The estimated shipping cost associated with the transportation option.

shipmentId

string

required

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

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shippingMode

string

required

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.

>= 1 characters<= 1024 characters

shippingSolution

string

required

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

>= 1 characters<= 1024 characters

transportationOptionId

string

required

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

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Example

{
    "pagination": {
        "nextToken": "string"
    },
    "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"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

updateShipmentTrackingDetails

generateTransportationOptions