Get shipment fees - 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

shipmentId

required

Shipment ID, either the old format (FBA...) or the new format (sh...). Requests using the old format may take longer to process.

Example:

sh7059be6b-54b3-4320-8553-f913d3472cc3

Query Params

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

placementFees

array[object (PlacementOption) {6}]

optional

discounts

array[object (Incentive) {4}]

required

Discount for the offered option.

expiration

string <date-time> | null

optional

The expiration date of the placement option.

Example:

2025-12-31T23:59:59.999Z

fees

array[object (Incentive) {4}]

required

The fee for the offered option.

placementOptionId

string

required

The identifier of a placement option.

>= 38 characters<= 38 characters

Example:

PLACE1234567890ABCDEFGH1234567890ABCD

shipmentIds

array[string]

required

Shipment ids.

Example:

["SHIP1234567890ABCDEFGH1234567890ABCDEF"]

status

enum<string>

required

The status of a placement option.

>= 1 characters<= 1024 characters

Allowed values:

OFFEREDACCEPTEDEXPIRED

Example:

OFFERED

transportationFees

array[object (TransportationOption) {8}]

optional

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

{
    "placementFees": [
        {
            "discounts": [
                {
                    "description": "10% discount on fulfillment fees",
                    "target": "Placement Services",
                    "type": "FEE",
                    "value": {
                        "amount": 10.5,
                        "code": "USD"
                    }
                }
            ],
            "expiration": "2025-12-31T23:59:59.999Z",
            "fees": [
                {
                    "description": "10% discount on fulfillment fees",
                    "target": "Placement Services",
                    "type": "FEE",
                    "value": {
                        "amount": 10.5,
                        "code": "USD"
                    }
                }
            ],
            "placementOptionId": "PLACE1234567890ABCDEFGH1234567890ABCD",
            "shipmentIds": [
                "SHIP1234567890ABCDEFGH1234567890ABCDEF"
            ],
            "status": "OFFERED"
        }
    ],
    "transportationFees": [
        {
            "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