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

提交一个或多个供应商订单的发货请求。

使用计划：

速率（每秒请求数）	突发
10	10

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

请求参数

Body 参数application/json

SubmitShipments 操作的请求模式。

shipments

array[object (Shipment) {20}]

可选

一个包含一个或多个货物运输及其详细信息的列表。

vendorShipmentIdentifier

string

必需

由供应商创建的唯一运输ID（过去365天内不应使用）。

transactionType

enum<string>

必需

指示运输请求的类型，例如（新建、取消、确认和包裹标签请求）。每种交易类型都有一组独特的操作，并且每个操作都有相应的详细信息需要填写。

枚举值:

NewCancel

buyerReferenceNumber

string

可选

买方参考编号是买方为所有Collect/WePay运输生成的唯一标识符，当您提交运输请求时。此字段对于Collect/WePay运输是必填的。

transactionDate

string <date-time>

必需

提交运输请求的日期。

currentShipmentStatus

enum<string>

可选

指示当前货物运输状态。

枚举值:

CreatedTransportationRequestedCarrierAssignedShipped

currentshipmentStatusDate

string <date-time>

最后状态更新时间。

可选

shipmentStatusDetails

array[object (ShipmentStatusDetails) {2}]

可选

指示当前货物运输状态详细信息的列表，以及从承运人那里收到的最后更新时间，此信息可在货件详情响应中找到。

shipmentCreateDate

string <date-time>

可选

供应商创建的发货请求的日期和时间。

shipmentConfirmDate

string <date-time>

可选

货物从供应商地点出发的日期和时间。供应商需在从其仓库/配送中心出发后30分钟内，或在买方目的地仓库的预约时间前至少6小时，尽快发送ASN，以较早者为准。货物确认中的发货日期不得为未来日期。

packageLabelCreateDate

string <date-time>

可选

买方为货物生成的包裹标签的日期和时间。

shipmentFreightTerm

enum<string>

可选

指示此运输请求是 WePay/Collect 还是 TheyPay/Prepaid。这是一个必填信息。

枚举值:

CollectPrepaid

sellingParty

object (PartyIdentification)

必需

当事人的姓名/地址和税务详情。

shipFromParty

object (PartyIdentification)

必需

当事人的姓名/地址和税务详情。

shipToParty

object (PartyIdentification)

必需

当事人的姓名/地址和税务详情。

shipmentMeasurements

object (TransportShipmentMeasurements)

装运测量细节。

可选

collectFreightPickupDetails

object (CollectFreightPickupDetails)

可选

买方从供应商仓库提货的运输请求日期

purchaseOrders

array[object (PurchaseOrders) {4}]

可选

表示运输请求涉及的采购订单。该组是为每个采购订单创建的数组，并列出其相应的项目。此信息用于有效决定路线、卡车分配和存储。这是买方从供应商仓库（WePay/Collect）进行运输的重要信息。

importDetails

object (ImportDetails)

可选

仅在此货物为直接进口时提供这些字段。

containers

array[object (Containers) {10}]

可选

此运输中的物品列表及其相关的内包装细节。如果任何物品细节字段在纸箱或托盘级别上是共通的，请在相应的纸箱或托盘级别提供这些信息。

transportationDetails

object (TransportationDetails)

此货物的运输详情。

可选

示例

{
    "shipments": [
        {
            "vendorShipmentIdentifier": "string",
            "transactionType": "New",
            "buyerReferenceNumber": "string",
            "transactionDate": "2019-08-24T14:15:22Z",
            "currentShipmentStatus": "Created",
            "currentshipmentStatusDate": "2019-08-24T14:15:22Z",
            "shipmentStatusDetails": [
                {
                    "shipmentStatus": "Created",
                    "shipmentStatusDate": "2019-08-24T14:15:22Z"
                }
            ],
            "shipmentCreateDate": "2019-08-24T14:15:22Z",
            "shipmentConfirmDate": "2019-08-24T14:15:22Z",
            "packageLabelCreateDate": "2019-08-24T14:15:22Z",
            "shipmentFreightTerm": "Collect",
            "sellingParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipFromParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipToParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipmentMeasurements": {
                "totalCartonCount": 0,
                "totalPalletStackable": 0,
                "totalPalletNonStackable": 0,
                "shipmentWeight": {
                    "unitOfMeasure": "G",
                    "value": "string"
                },
                "shipmentVolume": {
                    "unitOfMeasure": "CuFt",
                    "value": "string"
                }
            },
            "collectFreightPickupDetails": {
                "requestedPickUp": "2019-08-24T14:15:22Z",
                "scheduledPickUp": "2019-08-24T14:15:22Z",
                "carrierAssignmentDate": "2019-08-24T14:15:22Z"
            },
            "purchaseOrders": [
                {
                    "purchaseOrderNumber": "string",
                    "purchaseOrderDate": "2019-08-24T14:15:22Z",
                    "shipWindow": "string",
                    "items": [
                        {
                            "itemSequenceNumber": "string",
                            "buyerProductIdentifier": "string",
                            "vendorProductIdentifier": "string",
                            "shippedQuantity": {
                                "amount": 0,
                                "unitOfMeasure": "Cases",
                                "unitSize": 0
                            },
                            "maximumRetailPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "importDetails": {
                "methodOfPayment": "PaidByBuyer",
                "sealNumber": "string",
                "route": {
                    "stops": [
                        {
                            "functionCode": "PortOfDischarge",
                            "locationIdentification": {
                                "type": "string",
                                "locationCode": "string",
                                "countryCode": "string"
                            },
                            "arrivalTime": "2019-08-24T14:15:22Z",
                            "departureTime": "2019-08-24T14:15:22Z"
                        }
                    ]
                },
                "importContainers": "string",
                "billableWeight": {
                    "unitOfMeasure": "G",
                    "value": "string"
                },
                "estimatedShipByDate": "2019-08-24T14:15:22Z",
                "handlingInstructions": "Oversized"
            },
            "containers": [
                {
                    "containerType": "carton",
                    "containerSequenceNumber": "string",
                    "containerIdentifiers": [
                        {
                            "containerIdentificationType": "SSCC",
                            "containerIdentificationNumber": "string"
                        }
                    ],
                    "trackingNumber": "string",
                    "dimensions": {
                        "length": "string",
                        "width": "string",
                        "height": "string",
                        "unitOfMeasure": "In"
                    },
                    "weight": {
                        "unitOfMeasure": "G",
                        "value": "string"
                    },
                    "tier": 0,
                    "block": 0,
                    "innerContainersDetails": {
                        "containerCount": 0,
                        "containerSequenceNumbers": [
                            {
                                "containerSequenceNumber": "string"
                            }
                        ]
                    },
                    "packedItems": [
                        {
                            "itemSequenceNumber": "string",
                            "buyerProductIdentifier": "string",
                            "vendorProductIdentifier": "string",
                            "packedQuantity": {
                                "amount": 0,
                                "unitOfMeasure": "Cases",
                                "unitSize": 0
                            },
                            "itemDetails": {
                                "purchaseOrderNumber": "string",
                                "lotNumber": "string",
                                "expiry": {
                                    "manufacturerDate": "2019-08-24T14:15:22Z",
                                    "expiryDate": "2019-08-24T14:15:22Z",
                                    "expiryAfterDuration": {
                                        "durationUnit": "Days",
                                        "durationValue": 0
                                    }
                                }
                            }
                        }
                    ]
                }
            ],
            "transportationDetails": {
                "shipMode": "TruckLoad",
                "transportationMode": "Road",
                "shippedDate": "2019-08-24T14:15:22Z",
                "estimatedDeliveryDate": "2019-08-24T14:15:22Z",
                "shipmentDeliveryDate": "2019-08-24T14:15:22Z",
                "carrierDetails": {
                    "name": "string",
                    "code": "string",
                    "phone": "string",
                    "email": "string",
                    "shipmentReferenceNumber": "string"
                },
                "billOfLadingNumber": "string"
            }
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/vendor/shipping/v1/shipments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipments": [
        {
            "vendorShipmentIdentifier": "string",
            "transactionType": "New",
            "buyerReferenceNumber": "string",
            "transactionDate": "2019-08-24T14:15:22Z",
            "currentShipmentStatus": "Created",
            "currentshipmentStatusDate": "2019-08-24T14:15:22Z",
            "shipmentStatusDetails": [
                {
                    "shipmentStatus": "Created",
                    "shipmentStatusDate": "2019-08-24T14:15:22Z"
                }
            ],
            "shipmentCreateDate": "2019-08-24T14:15:22Z",
            "shipmentConfirmDate": "2019-08-24T14:15:22Z",
            "packageLabelCreateDate": "2019-08-24T14:15:22Z",
            "shipmentFreightTerm": "Collect",
            "sellingParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipFromParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipToParty": {
                "address": {
                    "name": "string",
                    "addressLine1": "string",
                    "addressLine2": "string",
                    "addressLine3": "string",
                    "city": "string",
                    "county": "string",
                    "district": "string",
                    "stateOrRegion": "string",
                    "postalCode": "string",
                    "countryCode": "string",
                    "phone": "string"
                },
                "partyId": "string",
                "taxRegistrationDetails": [
                    {
                        "taxRegistrationType": "VAT",
                        "taxRegistrationNumber": "string"
                    }
                ]
            },
            "shipmentMeasurements": {
                "totalCartonCount": 0,
                "totalPalletStackable": 0,
                "totalPalletNonStackable": 0,
                "shipmentWeight": {
                    "unitOfMeasure": "G",
                    "value": "string"
                },
                "shipmentVolume": {
                    "unitOfMeasure": "CuFt",
                    "value": "string"
                }
            },
            "collectFreightPickupDetails": {
                "requestedPickUp": "2019-08-24T14:15:22Z",
                "scheduledPickUp": "2019-08-24T14:15:22Z",
                "carrierAssignmentDate": "2019-08-24T14:15:22Z"
            },
            "purchaseOrders": [
                {
                    "purchaseOrderNumber": "string",
                    "purchaseOrderDate": "2019-08-24T14:15:22Z",
                    "shipWindow": "string",
                    "items": [
                        {
                            "itemSequenceNumber": "string",
                            "buyerProductIdentifier": "string",
                            "vendorProductIdentifier": "string",
                            "shippedQuantity": {
                                "amount": 0,
                                "unitOfMeasure": "Cases",
                                "unitSize": 0
                            },
                            "maximumRetailPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "importDetails": {
                "methodOfPayment": "PaidByBuyer",
                "sealNumber": "string",
                "route": {
                    "stops": [
                        {
                            "functionCode": "PortOfDischarge",
                            "locationIdentification": {
                                "type": "string",
                                "locationCode": "string",
                                "countryCode": "string"
                            },
                            "arrivalTime": "2019-08-24T14:15:22Z",
                            "departureTime": "2019-08-24T14:15:22Z"
                        }
                    ]
                },
                "importContainers": "string",
                "billableWeight": {
                    "unitOfMeasure": "G",
                    "value": "string"
                },
                "estimatedShipByDate": "2019-08-24T14:15:22Z",
                "handlingInstructions": "Oversized"
            },
            "containers": [
                {
                    "containerType": "carton",
                    "containerSequenceNumber": "string",
                    "containerIdentifiers": [
                        {
                            "containerIdentificationType": "SSCC",
                            "containerIdentificationNumber": "string"
                        }
                    ],
                    "trackingNumber": "string",
                    "dimensions": {
                        "length": "string",
                        "width": "string",
                        "height": "string",
                        "unitOfMeasure": "In"
                    },
                    "weight": {
                        "unitOfMeasure": "G",
                        "value": "string"
                    },
                    "tier": 0,
                    "block": 0,
                    "innerContainersDetails": {
                        "containerCount": 0,
                        "containerSequenceNumbers": [
                            {
                                "containerSequenceNumber": "string"
                            }
                        ]
                    },
                    "packedItems": [
                        {
                            "itemSequenceNumber": "string",
                            "buyerProductIdentifier": "string",
                            "vendorProductIdentifier": "string",
                            "packedQuantity": {
                                "amount": 0,
                                "unitOfMeasure": "Cases",
                                "unitSize": 0
                            },
                            "itemDetails": {
                                "purchaseOrderNumber": "string",
                                "lotNumber": "string",
                                "expiry": {
                                    "manufacturerDate": "2019-08-24T14:15:22Z",
                                    "expiryDate": "2019-08-24T14:15:22Z",
                                    "expiryAfterDuration": {
                                        "durationUnit": "Days",
                                        "durationValue": 0
                                    }
                                }
                            }
                        }
                    ]
                }
            ],
            "transportationDetails": {
                "shipMode": "TruckLoad",
                "transportationMode": "Road",
                "shippedDate": "2019-08-24T14:15:22Z",
                "estimatedDeliveryDate": "2019-08-24T14:15:22Z",
                "shipmentDeliveryDate": "2019-08-24T14:15:22Z",
                "carrierDetails": {
                    "name": "string",
                    "code": "string",
                    "phone": "string",
                    "email": "string",
                    "shipmentReferenceNumber": "string"
                },
                "billOfLadingNumber": "string"
            }
        }
    ]
}'

返回响应

🟢202成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

SubmitShipmentConfirmations 操作的响应架构。

payload

object (TransactionReference)

可选

提交装运确认操作的响应有效负载。

transactionId

string

可选

买方分配给该交易的GUID。此值可与交易状态API一起使用，以返回该交易的状态。

errors

array[object (Error) {3}]

可选

请求失败时返回的错误响应列表。

code

string

必需

一个标识发生错误类型的错误代码。

message

string

必需

描述错误状态的消息。

details

string

可选

可以帮助拨打者理解或解决问题的附加细节。

示例

{
    "payload": {
        "transactionId": "string"
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障