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

购买一个运输服务标识符，并返回与购买相关的详细信息和文件。

使用计划：

速率（每秒请求数）	冲击
80	100

x-amzn-RateLimit-Limit 响应头返回应用于请求操作的使用计划速率限制（如适用）。上表指出了此操作的默认速率和冲击值。对业务需求需要更高吞吐量的销售合作伙伴，可能会看到比这里显示的更高的速率和冲击值。有关更多信息，请参见销售伙伴 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

OneClickShipment 操作的请求模式。当 channelType 不是 Amazon 时，必须提供 shipTo；当 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>

可选

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

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

一份物品清单。

必需

valueAddedServicesDetails

array[object (OneClickShipmentValueAddedService) {2}]

可选

将增加到运输服务购买中的增值服务。

string

必需

所选增值服务的标识符。

amount

object (Currency)

可选

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

taxDetails

array[object (TaxDetail) {2}]

税务详细信息列表。

可选

taxType

enum<string>

指示税种类型。

必需

枚举值:

GST

taxRegistrationNumber

string

必需

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

channelDetails

object (ChannelDetails)

必需

货物来源渠道相关信息。

channelType

enum<string>

必需

货物发运源渠道类型。

枚举值:

AMAZONEXTERNAL

amazonOrderDetails

object (AmazonOrderDetails)

可选

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

amazonShipmentDetails

object (AmazonShipmentDetails)

亚马逊运输信息。

可选

labelSpecifications

object (RequestedDocumentSpecification)

必需

所请求的文档规范。对于对purchaseShipment操作的调用，如果指定的文档规范不在getRates操作的响应中返回的规范之内，则货物采购会失败。

format

enum<string>

文档的文件格式。

必需

枚举值:

PDFPNGZPL

size

object (DocumentSize)

标签的尺寸。

必需

dpi

integer

可选

每英寸的点数（DPI）值用于打印。该值代表文档分辨率的测量标准。

pageLayout

string

可选

指示标签在纸张上的位置。应与getRates响应中返回的值相同。

needFileJoining

boolean

必需

如果为真，则应将文件拼接在一起。否则，文件应分别返回。默认值为假。

requestedDocumentTypes

array[string]

必需

所请求的文件类型列表。

枚举值:

PACKSLIPLABELRECEIPTCUSTOM_FORM

serviceSelection

object (ServiceSelection)

服务选择标准。

必需

serviceId

array[string]

服务ID列表。

必需

shipperInstruction

object (ShipperInstruction)

发货人指示。

可选

deliveryNotes

string

运输的交货单

可选

<= 256 字符

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",
    "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"
                    }
                }
            ]
        }
    ],
    "valueAddedServicesDetails": [
        {
            "id": "string",
            "amount": {
                "value": 0,
                "unit": "str"
            }
        }
    ],
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "labelSpecifications": {
        "format": "PDF",
        "size": {
            "width": 0,
            "length": 0,
            "unit": "INCH"
        },
        "dpi": 0,
        "pageLayout": "string",
        "needFileJoining": true,
        "requestedDocumentTypes": [
            "PACKSLIP"
        ]
    },
    "serviceSelection": {
        "serviceId": [
            "string"
        ]
    },
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "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/oneClickShipment' \
--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",
    "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"
                    }
                }
            ]
        }
    ],
    "valueAddedServicesDetails": [
        {
            "id": "string",
            "amount": {
                "value": 0,
                "unit": "str"
            }
        }
    ],
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "labelSpecifications": {
        "format": "PDF",
        "size": {
            "width": 0,
            "length": 0,
            "unit": "INCH"
        },
        "dpi": 0,
        "pageLayout": "string",
        "needFileJoining": true,
        "requestedDocumentTypes": [
            "PACKSLIP"
        ]
    },
    "serviceSelection": {
        "serviceId": [
            "string"
        ]
    },
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "destinationAccessPointDetails": {
        "accessPointId": "string"
    }
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

OneClickShipment 操作的响应模式。

payload

object (OneClickShipmentResult)

可选

OneClickShipment API 的有效载荷。

shipmentId

string

必需

由运输服务提供的独特货运标识符。

packageDocumentDetails

array[object (PackageDocumentDetail) {3}]

必需

关于将通过快递服务发送的包裹的购买后详细信息列表。

promise

object (Promise)

必需

承诺的取货和送货事件的时间窗口。

carrier

object (Carrier)

承运人相关信息

必需

service

object (Service)

服务相关信息

必需

totalCharge

object (Currency)

必需

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

示例

{
    "shipmentId": "87852211788104",
    "packageDocumentDetails": [
        {
            "packageClientReferenceId": "#abcd",
            "packageDocuments": [
                {
                    "type": "LABEL",
                    "format": "PNG",
                    "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
                }
            ],
            "trackingId": 1578648261977
        }
    ],
    "promise": {
        "pickupWindow": {
            "start": "2019-12-11T07:09:05.513Z",
            "end": "2019-12-11T09:09:05.513Z"
        },
        "deliveryWindow": {
            "start": "2019-12-13T07:09:05.513Z",
            "end": "2019-12-13T09:09:05.513Z"
        }
    },
    "carrier": {
        "id": "AMZN_UK",
        "name": "Amazon Shipping"
    },
    "service": {
        "id": "SWA-UK-PREM",
        "name": "Amazon Shipping One Day"
    },
    "totalCharge": {
        "unit": "GBP",
        "value": 4.76
    }
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障