List transportation options - Seller Assistant API

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Path Params

inboundPlanId

required

Inbound Plan id (Workflow Id).

Example:

wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2

Query Params

placementOptionId

optional

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

Example:

pl3b508968-de24-408a-b708-dbbb3915e070

shipmentId

optional

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

Example:

sh7059be6b-54b3-4320-8553-f913d3472cc3

pageSize

optional

Integer 1 to 20. Defaults to 10. The number of placement options to return in the response matching the given query.

Example:

paginationToken

optional

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.

domain

optional

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Example:

amazon.com

marketplaceId

optional

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Example:

ATVPDKIKX0DER

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful response

Body

pagination

object

optional

nextToken

string | null

optional

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

>= 1 characters<= 1024 characters

transportationOptions

array[object (TransportationOption) {8}]

required

Transportation options generated for the placement option.

carrier

object

required

carrierAppointment

object | null

optional

preconditions

array[string]

required

Identifies a list of preconditions for confirming the transportation option.

quote

object | null

optional

shipmentId

string

required

Identifier of a shipment.

>= 38 characters<= 38 characters

Example:

SHIP1234567890ABCDEFGH1234567890ABCDEF

shippingMode

enum<string>

required

Mode of shipment transportation.

>= 1 characters<= 1024 characters

Allowed values:

GROUND_SMALL_PARCELFREIGHT_LTLFREIGHT_FTL_PALLETFREIGHT_FTL_NONPALLETOCEAN_LCLOCEAN_FCLAIR_SMALL_PARCELAIR_SMALL_PARCEL_EXPRESS

Example:

GROUND_SMALL_PARCEL

shippingSolution

enum<string>

required

Shipping program for the option.

>= 1 characters<= 1024 characters

Allowed values:

AMAZON_PARTNERED_CARRIERUSE_YOUR_OWN_CARRIER

Example:

AMAZON_PARTNERED_CARRIER

transportationOptionId

string

required

Identifier of a transportation option.

>= 38 characters<= 38 characters

Example:

TRANS1234567890ABCDEFGH1234567890ABCD

Example

{
    "pagination": {
        "nextToken": "string"
    },
    "transportationOptions": [
        {
            "carrier": {
                "alphaCode": "USPS",
                "name": "United States Postal Service"
            },
            "carrierAppointment": {
                "endTime": "2025-12-31T23:59:59.999Z",
                "startTime": "2025-12-31T09:00:00.000Z"
            },
            "preconditions": [
                "string"
            ],
            "quote": {
                "cost": {
                    "amount": 10.5,
                    "code": "USD"
                },
                "expiration": "2025-12-31T23:59:59.999Z",
                "voidableUntil": "2025-12-31T23:59:59.999Z"
            },
            "shipmentId": "SHIP1234567890ABCDEFGH1234567890ABCDEF",
            "shippingMode": "GROUND_SMALL_PARCEL",
            "shippingSolution": "AMAZON_PARTNERED_CARRIER",
            "transportationOptionId": "TRANS1234567890ABCDEFGH1234567890ABCD"
        }
    ]
}

🟠402402

🟠403Forbidden

🟠422Parameter Error

🟠429429

🔴500Server Error