getRates - Amazon Selling Partner API (SP-API)-中文

返回可用的运输服务选项。

使用计划：

速率（每秒请求数）	突发
80	100

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如果可用）。上表指示了此操作的默认速率和突发值。业务需求要求更高吞吐量的销售合作伙伴可能会看到比这里显示的更高的速率和突发值。有关更多信息，请参阅 Selling Partner API 中的使用计划和速率限制。

请求参数

Header 参数

x-amzn-shipping-business-id

enum<string>

可选

亚马逊运输业务将承担此请求。默认值为 AmazonShipping_UK。

枚举值:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body 参数application/json

getRates操作的请求模式。当channelType为Amazon时，shipTo地址不是必需的，将被忽略。

shipTo

object (Address)

地址。

可选

name

string

必需

地址上的个人、企业或机构名称。

>= 1 字符<= 50 字符

addressLine1

string

地址的第一行。

必需

>= 1 字符<= 60 字符

addressLine2

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

addressLine3

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

companyName

string

可选

与该地址相关联的企业或机构名称。

stateOrRegion

string

必需

该人、企业或机构所在的州、县或地区。

city

string

必需

该人、企业或机构所在的城市或城镇。

countryCode

string

必需

两位数字的国家代码。遵循ISO 3166-1 alpha-2格式。

postalCode

string

必需

该地址的邮政编码。它包含一系列字母或数字或两者，有时包括空格或标点符号。

string

可选

与该地址相关的联系人的电子邮件地址。

<= 64 字符

phoneNumber

string

可选

位于该地址的个人、企业或机构的电话号码，包括国家拨号代码。

>= 1 字符<= 20 字符

geocode

object (Geocode)

可选

定义接入点的纬度和经度。

shipFrom

object (Address)

地址。

必需

returnTo

object (Address)

地址。

可选

shipDate

string <date-time>

可选

发货日期和时间（请求的取货时间）。默认为当前的日期和时间。

shipperInstruction

object (ShipperInstruction)

发货人指示。

可选

deliveryNotes

string

运输的交货单

可选

<= 256 字符

packages

array[object (Package) {8}]

必需

通过提供运输服务的包裹列表。

dimensions

object (Dimensions)

必需

一组三维物体的测量。

weight

object (Weight)

所示单位中的重量。

必需

insuredValue

object (Currency)

必需

按ISO 4217标准格式显示的所示货币的货币价值。

isHazmat

boolean

可选

当为真时，包裹包含危险材料。默认为假。

sellerDisplayName

string

可选

标签上显示的卖家名称。

charges

array[object (ChargeComponent) {2}]

可选

根据包裹所适用的航运服务费用的收费清单。

packageClientReferenceId

string

必需

客户提供了一个正在运输的包裹的唯一标识符。该值应由客户保存，以作为参数传递给 getShipmentDocuments 操作。

items

array[object (Item) {12}]

一份物品清单。

必需

valueAddedServices

object (ValueAddedServiceDetails)

可选

一系列支持的增值服务。

collectOnDelivery

object (CollectOnDelivery)

货到付款的金额。

可选

taxDetails

array[object (TaxDetail) {2}]

税务详细信息列表。

可选

taxType

enum<string>

指示税种类型。

必需

枚举值:

GST

taxRegistrationNumber

string

必需

与某些地区的海关合规目的相关联的发货人的税务登记号码。

channelDetails

object (ChannelDetails)

必需

货物来源渠道相关信息。

channelType

enum<string>

必需

货物发运源渠道类型。

枚举值:

AMAZONEXTERNAL

amazonOrderDetails

object (AmazonOrderDetails)

可选

亚马逊订单信息。如果发货渠道是亚马逊，这是必需的。

amazonShipmentDetails

object (AmazonShipmentDetails)

亚马逊运输信息。

可选

clientReferenceDetails

array[object (ClientReferenceDetail) {2}]

可选

对象以传递关于MCI集成器发货人类型的附加信息：ClientReferenceDetail列表

clientReferenceType

enum<string>

客户参考类型。

必需

枚举值:

IntegratorShipperIdIntegratorMerchantId

clientReferenceId

string

客户参考 ID。

必需

shipmentType

enum<string>

运输类型。

可选

枚举值:

FORWARDRETURNS

destinationAccessPointDetails

object (AccessPointDetails)

可选

accessPointId

string

接入点的唯一标识符

可选

示例

{
    "shipTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "shipFrom": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "returnTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "packages": [
        {
            "dimensions": {
                "length": 0,
                "width": 0,
                "height": 0,
                "unit": "INCH"
            },
            "weight": {
                "unit": "GRAM",
                "value": 0
            },
            "insuredValue": {
                "value": 0,
                "unit": "str"
            },
            "isHazmat": true,
            "sellerDisplayName": "string",
            "charges": [
                {
                    "amount": {
                        "value": 0,
                        "unit": "str"
                    },
                    "chargeType": "TAX"
                }
            ],
            "packageClientReferenceId": "string",
            "items": [
                {
                    "itemValue": {
                        "value": 0,
                        "unit": "str"
                    },
                    "description": "string",
                    "itemIdentifier": "string",
                    "quantity": 0,
                    "weight": {
                        "unit": "GRAM",
                        "value": 0
                    },
                    "liquidVolume": {
                        "unit": "ML",
                        "value": 0
                    },
                    "isHazmat": true,
                    "dangerousGoodsDetails": {
                        "unitedNationsRegulatoryId": "string",
                        "transportationRegulatoryClass": "string",
                        "packingGroup": "I",
                        "packingInstruction": "PI965_SECTION_IA"
                    },
                    "productType": "string",
                    "invoiceDetails": {
                        "invoiceNumber": "string",
                        "invoiceDate": "2019-08-24T14:15:22Z"
                    },
                    "serialNumbers": [
                        "string"
                    ],
                    "directFulfillmentItemIdentifiers": {
                        "lineItemID": "string",
                        "pieceNumber": "string"
                    }
                }
            ]
        }
    ],
    "valueAddedServices": {
        "collectOnDelivery": {
            "amount": {
                "value": 0,
                "unit": "str"
            }
        }
    },
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "shipmentType": "FORWARD",
    "destinationAccessPointDetails": {
        "accessPointId": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/shipping/v2/shipments/rates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "shipFrom": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "returnTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "companyName": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "string",
        "postalCode": "string",
        "email": "string",
        "phoneNumber": "string",
        "geocode": {
            "latitude": "string",
            "longitude": "string"
        }
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "packages": [
        {
            "dimensions": {
                "length": 0,
                "width": 0,
                "height": 0,
                "unit": "INCH"
            },
            "weight": {
                "unit": "GRAM",
                "value": 0
            },
            "insuredValue": {
                "value": 0,
                "unit": "str"
            },
            "isHazmat": true,
            "sellerDisplayName": "string",
            "charges": [
                {
                    "amount": {
                        "value": 0,
                        "unit": "str"
                    },
                    "chargeType": "TAX"
                }
            ],
            "packageClientReferenceId": "string",
            "items": [
                {
                    "itemValue": {
                        "value": 0,
                        "unit": "str"
                    },
                    "description": "string",
                    "itemIdentifier": "string",
                    "quantity": 0,
                    "weight": {
                        "unit": "GRAM",
                        "value": 0
                    },
                    "liquidVolume": {
                        "unit": "ML",
                        "value": 0
                    },
                    "isHazmat": true,
                    "dangerousGoodsDetails": {
                        "unitedNationsRegulatoryId": "string",
                        "transportationRegulatoryClass": "string",
                        "packingGroup": "I",
                        "packingInstruction": "PI965_SECTION_IA"
                    },
                    "productType": "string",
                    "invoiceDetails": {
                        "invoiceNumber": "string",
                        "invoiceDate": "2019-08-24T14:15:22Z"
                    },
                    "serialNumbers": [
                        "string"
                    ],
                    "directFulfillmentItemIdentifiers": {
                        "lineItemID": "string",
                        "pieceNumber": "string"
                    }
                }
            ]
        }
    ],
    "valueAddedServices": {
        "collectOnDelivery": {
            "amount": {
                "value": 0,
                "unit": "str"
            }
        }
    },
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "shipmentType": "FORWARD",
    "destinationAccessPointDetails": {
        "accessPointId": "string"
    }
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

getRates 操作的响应模式。

payload

object (GetRatesResult)

可选

getRates 操作的有效载荷。

requestToken

string

必需

用于识别 getRates 操作的唯一令牌。

rates

array[object (Rate) {14}]

必需

符合条件的运输服务选项列表。

ineligibleRates

array[object (IneligibleRate) {5}]

可选

不合格的运输服务提供列表。

示例

{
    "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"
                }
            ]
        }
    ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障