confirmTransportationOptions

POST

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

Fulfillment Inbound

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

Maintainer:Not configured

Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.

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 `confirmTransportationOptions` request.

transportationSelections

array[object (TransportationSelection) {3}]

required

Information needed to confirm one of the available transportation options.

>= 1 items

contactInformation

object (ContactInformation)

optional

The seller's contact information.

Example:

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

shipmentId

string

required

Shipment ID that the transportation Option is for.

>= 38 characters<= 38 characters

Match pattern:

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

transportationOptionId

string

required

Transportation option being selected for the provided shipment.

>= 38 characters<= 38 characters

Match pattern:

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

Example

{
    "transportationSelections": [
        {
            "contactInformation": {
                "email": "email@email.com",
                "name": "John Smithy",
                "phoneNumber": "1234567890"
            },
            "deliveryWindow": {
                "start": "2024-01-01T00:00Z"
            },
            "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
            "transportationOptionId": "to1234abcd-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/confirmation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transportationSelections": [
        {
            "contactInformation": {
                "email": "email@email.com",
                "name": "John Smithy",
                "phoneNumber": "1234567890"
            },
            "deliveryWindow": {
                "start": "2024-01-01T00:00Z"
            },
            "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
            "transportationOptionId": "to1234abcd-1234-abcd-5678-1234abcd5678"
        }
    ]
}'

Responses

🟢202Accepted

application/json

ConfirmTransportationOptions 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 `confirmTransportationOptions` 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

generateTransportationOptions

listItemComplianceDetails