getRates - Amazon SP API

Returns the available shipping service offerings.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body Params application/json

The payload schema for the getRates operation.

shipTo

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

shipFrom

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

serviceTypes

array[string]

required

A list of service types that can be used to send the shipment.

Allowed values:

Amazon Shipping GroundAmazon Shipping StandardAmazon Shipping Premium

shipDate

string <date-time>

optional

The start date and time. This defaults to the current date and time.

containerSpecifications

array[object (ContainerSpecification) {2}]

required

A list of container specifications.

dimensions

object (Dimensions)

required

Dimensions of an Amazon catalog item or item in its packaging.

weight

object (Weight)

required

The weight of the scheduled package

Example

{
    "shipTo": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "shipFrom": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "serviceTypes": [
        "Amazon Shipping Ground"
    ],
    "shipDate": "2019-08-24T14:15:22Z",
    "containerSpecifications": [
        {
            "dimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "weight": {
                "value": 11,
                "unit": "Grams"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the getRates operation.

payload

object (GetRatesResult)

optional

The payload schema for the getRates operation.

serviceRates

array[object (ServiceRate) {4}]

required

A list of service rates.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "requestToken": "6DCCEDD3FF961C15FEB94F342D41C",
    "rates": [
        {
            "rateId": "F4B68849F969E239FF9FCA9C12E35",
            "carrierId": "FOOSHIPGRD",
            "carrierName": "FOO SHIP GRD",
            "billedWeight": {
                "value": 5,
                "unit": "GRAMS"
            },
            "totalCharge": {
                "value": 7,
                "unit": "USD"
            },
            "serviceId": "FOORSID",
            "serviceName": "FOO RS ID",
            "promise": {
                "deliveryWindow": {
                    "start": "2018-08-24T08:22:30.737Z",
                    "end": "2018-08-24T20:22:30.737Z"
                },
                "pickupWindow": {
                    "start": "2018-08-23T08:22:30.737Z",
                    "end": "2018-08-23T20:22:30.737Z"
                }
            },
            "supportedDocumentSpecifications": [
                {
                    "format": "PNG",
                    "size": {
                        "length": 6,
                        "width": 4,
                        "unit": "INCH"
                    },
                    "printOptions": [
                        {
                            "supportedDPIs": [
                                300,
                                203
                            ],
                            "supportedPageLayouts": [
                                "LEFT",
                                "RIGHT"
                            ],
                            "supportedFileJoiningOptions": [
                                true,
                                false
                            ],
                            "supportedDocumentDetails": [
                                {
                                    "name": "LABEL",
                                    "isMandatory": true
                                }
                            ]
                        }
                    ]
                },
                {
                    "format": "ZPL",
                    "size": {
                        "length": 6,
                        "width": 4,
                        "unit": "INCH"
                    },
                    "printOptions": [
                        {
                            "supportedDPIs": [
                                300,
                                203
                            ],
                            "supportedPageLayouts": [
                                "LEFT",
                                "RIGHT"
                            ],
                            "supportedFileJoiningOptions": [
                                true,
                                false
                            ],
                            "supportedDocumentDetails": [
                                {
                                    "name": "LABEL",
                                    "isMandatory": true
                                }
                            ]
                        }
                    ]
                }
            ],
            "availableValueAddedServiceGroups": [
                {
                    "groupId": "SIG_VERIFICATION",
                    "groupDescription": "Signature Verification",
                    "isRequired": true,
                    "valueAddedServices": [
                        {
                            "id": "CUST_SIG_VERIFICATION",
                            "name": "Customer Signature Verification",
                            "cost": {
                                "unit": "USD",
                                "value": 2
                            }
                        }
                    ]
                }
            ],
            "requiresAdditionalInputs": false,
            "rateItemList": [
                {
                    "rateItemCharge": {
                        "unit": "INR",
                        "value": "2.00000"
                    },
                    "rateItemID": "BASE_RATE",
                    "rateItemNameLocalization": "Base Rate",
                    "rateItemType": "MANDATORY"
                },
                {
                    "rateItemCharge": {
                        "unit": "INR",
                        "value": "1.20000"
                    },
                    "rateItemID": "DELIVERY_CONFIRMATION",
                    "rateItemNameLocalization": "Delivery Confirmation",
                    "rateItemType": "INCLUDED"
                },
                {
                    "rateItemCharge": {
                        "unit": "INR",
                        "value": "2.00"
                    },
                    "rateItemID": "VAT",
                    "rateItemNameLocalization": "VAT",
                    "rateItemType": "MANDATORY"
                }
            ],
            "paymentType": "PAY_THROUGH_AMAZON"
        }
    ],
    "ineligibleRates": [
        {
            "carrierId": "FOOSTDGRD",
            "serviceId": "FOO8420430",
            "carrierName": "FOOSTDGRD",
            "serviceName": "FOO8420430",
            "ineligibilityReasons": [
                {
                    "code": "NO_COVERAGE",
                    "message": "Required shipping network coverage doesn't exist for the offering"
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable