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

购买运输服务并返回与购买相关的详细信息和文件。

注意：您必须在运输服务提供商创建费率后10分钟内完成购买。如果您在10分钟过期后发出请求，将收到错误响应，错误代码为“TOKENS_EXPIRED”。如果收到此错误响应，则必须再次获取该货物的费率。

使用计划：

费率（每秒请求）	突发
80	100

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

请求参数

Header 参数

x-amzn-IdempotencyKey

string

可选

服务器用来识别后续重试相同请求的唯一值。

x-amzn-shipping-business-id

enum<string>

可选

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

枚举值:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body 参数application/json

购买发货操作的请求模式。

requestToken

string

必需

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

rateId

string

必需

由运输服务提供商提供的运费（运输报价）的标识符。

requestedDocumentSpecification

object (RequestedDocumentSpecification)

必需

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

format

enum<string>

文档的文件格式。

必需

枚举值:

PDFPNGZPL

size

object (DocumentSize)

标签的尺寸。

必需

dpi

integer

可选

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

pageLayout

string

可选

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

needFileJoining

boolean

必需

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

requestedDocumentTypes

array[string]

必需

所请求的文件类型列表。

枚举值:

PACKSLIPLABELRECEIPTCUSTOM_FORM

requestedValueAddedServices

array[object (RequestedValueAddedService) {1}]

可选

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

string

必需

所选增值服务的标识符。必须在getRates操作返回的响应中。

additionalInputs

object

可选

购买运输服务所需的额外输入，采用 JSON 格式。此处提供的 JSON 必须遵循在 getAdditionalInputs 操作的响应中返回的 JSON 模式。

只有在 getRates 操作的响应中通过 requiresAdditionalInputs 属性指示时，才需要额外输入。

额外字段

integer | number | string | boolean

可选

示例

{
    "requestToken": "string",
    "rateId": "string",
    "requestedDocumentSpecification": {
        "format": "PDF",
        "size": {
            "width": 0,
            "length": 0,
            "unit": "INCH"
        },
        "dpi": 0,
        "pageLayout": "string",
        "needFileJoining": true,
        "requestedDocumentTypes": [
            "PACKSLIP"
        ]
    },
    "requestedValueAddedServices": [
        {
            "id": "string"
        }
    ],
    "additionalInputs": {
        "property1": null,
        "property2": null
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

购买发货操作的响应模式。

payload

object (PurchaseShipmentResult)

可选

购买发货操作的有效载荷。

shipmentId

string

必需

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

packageDocumentDetails

array[object (PackageDocumentDetail) {3}]

必需

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

promise

object (Promise)

必需

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

示例

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

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障