Amazon SP API

generateTransportationOptions

POST

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

Fulfillment Inbound

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

Maintainer:Not configured

Generates available transportation options for a given placement option.

Usage Plan:

Rate (requests per second)	Burst
2	2

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-]*$

Body Params application/json

The `generateTransportationOptions` request.

placementOptionId

string

required

The placement option to generate transportation options for.

>= 38 characters<= 38 characters

Match pattern:

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

shipmentTransportationConfigurations

array[object (ShipmentTransportationConfiguration) {5}]

required

List of shipment transportation configurations.

>= 1 items

contactInformation

object (ContactInformation)

optional

The seller's contact information.

Example:

{"email":"email@email.com","name":"name","phoneNumber":"1234567890"}

freightInformation

object (FreightInformation)

optional

Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided.

Example:

{"declaredValue":{"amount":5.5,"code":"CAD"},"freightClass":"FC_50"}

pallets

array[object (PalletInput) {4}]

optional

List of pallet configuration inputs.

readyToShipWindow

object (WindowInput)

required

Contains only a starting DateTime.

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-]*$

Example

{
    "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
    "shipmentTransportationConfigurations": [
        {
            "contactInformation": {
                "email": "email@email.com",
                "name": "John Smithy",
                "phoneNumber": "1234567890"
            },
            "freightInformation": {
                "declaredValue": {
                    "amount": 5.5,
                    "code": "CAD"
                },
                "freightClass": "FC_50"
            },
            "pallets": [
                {
                    "dimensions": {
                        "height": 5,
                        "length": 3,
                        "unitOfMeasurement": "CM",
                        "width": 4
                    },
                    "quantity": 2,
                    "stackability": "STACKABLE",
                    "weight": {
                        "unit": "KG",
                        "value": 5.5
                    }
                }
            ],
            "readyToShipWindow": {
                "start": "2024-01-01T00:00Z"
            },
            "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//transportationOptions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
    "shipmentTransportationConfigurations": [
        {
            "contactInformation": {
                "email": "email@email.com",
                "name": "John Smithy",
                "phoneNumber": "1234567890"
            },
            "freightInformation": {
                "declaredValue": {
                    "amount": 5.5,
                    "code": "CAD"
                },
                "freightClass": "FC_50"
            },
            "pallets": [
                {
                    "dimensions": {
                        "height": 5,
                        "length": 3,
                        "unitOfMeasurement": "CM",
                        "width": 4
                    },
                    "quantity": 2,
                    "stackability": "STACKABLE",
                    "weight": {
                        "unit": "KG",
                        "value": 5.5
                    }
                }
            ],
            "readyToShipWindow": {
                "start": "2024-01-01T00:00Z"
            },
            "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678"
        }
    ]
}'

Responses

🟢202Accepted

application/json

GenerateTransportationOptions 202 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 `generateTransportationOptions` response.

operationId

string

required

UUID for the given operation.

>= 36 characters<= 38 characters

Match pattern:

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

Example

{
    "operationId": "stringstringstringstringstringstring"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

listTransportationOptions

confirmTransportationOptions