getShipment

返回现有货件的运输信息。

使用计划：

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

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

返回响应

🟢200成功

application/json

成功

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

响应模式。

payload

object (Shipment)

可选

货物的详细信息，包括货物状态。

ShipmentId

string

必需

亚马逊定义的货件标识符。

AmazonOrderId

string

必需

亚马逊定义的订单标识符，格式为3-7-7。

SellerOrderId

string

可选

卖方定义的订单标识符。

<= 64 字符

ItemList

array[object (Item) {9}]

必需

装运中要包含的物品清单。

ShipFromAddress

object (Address)

邮政地址信息。

必需

ShipToAddress

object (Address)

邮政地址信息。

必需

PackageDimensions

object (PackageDimensions)

货物中包裹的尺寸。

必需

Weight

object (Weight)

重量。

必需

Insurance

object (CurrencyAmount)

货币类型和金额。

必需

ShippingService

object (ShippingService)

必需

承运人提供的运输服务报价。

Label

object (Label)

必需

用于创建运输标签的数据和打印标签的尺寸。

Status

enum<string>

发货状态。

必需

枚举值:

PurchasedRefundPendingRefundRejectedRefundApplied

TrackingId

string

可选

承运人提供的货物追踪标识符。

CreatedDate

string <date-time>

必需

日期时间格式的时间戳。

LastUpdatedDate

string <date-time>

可选

日期时间格式的时间戳。

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

一种以人类可读的形式描述错误状态的消息。

details

string

可选

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

示例

{
    "payload": {
        "ShipmentId": "string",
        "AmazonOrderId": "string",
        "SellerOrderId": "string",
        "ItemList": [
            {
                "OrderItemId": "string",
                "Quantity": 0,
                "ItemWeight": {
                    "Value": 0,
                    "Unit": "oz"
                },
                "ItemDescription": "string",
                "TransparencyCodeList": [
                    "string"
                ],
                "ItemLevelSellerInputsList": [
                    {
                        "AdditionalInputFieldName": "string",
                        "AdditionalSellerInput": {
                            "DataType": "string",
                            "ValueAsString": "string",
                            "ValueAsBoolean": true,
                            "ValueAsInteger": 0,
                            "ValueAsTimestamp": "2019-08-24T14:15:22Z",
                            "ValueAsAddress": {
                                "Name": "string",
                                "AddressLine1": "string",
                                "AddressLine2": "string",
                                "AddressLine3": "string",
                                "DistrictOrCounty": "string",
                                "Email": "string",
                                "City": "string",
                                "StateOrProvinceCode": "string",
                                "PostalCode": "string",
                                "CountryCode": "string",
                                "Phone": "string"
                            },
                            "ValueAsWeight": {
                                "Value": 0,
                                "Unit": "oz"
                            },
                            "ValueAsDimension": {
                                "value": 0,
                                "unit": "inches"
                            },
                            "ValueAsCurrency": {
                                "CurrencyCode": "str",
                                "Amount": 0
                            }
                        }
                    }
                ],
                "LiquidVolume": {
                    "Unit": "ML",
                    "Value": 0
                },
                "IsHazmat": true,
                "DangerousGoodsDetails": {
                    "UnitedNationsRegulatoryId": "string",
                    "TransportationRegulatoryClass": "string",
                    "PackingGroup": "I",
                    "PackingInstruction": "PI965_SECTION_IA"
                }
            }
        ],
        "ShipFromAddress": {
            "Name": "string",
            "AddressLine1": "string",
            "AddressLine2": "string",
            "AddressLine3": "string",
            "DistrictOrCounty": "string",
            "Email": "string",
            "City": "string",
            "StateOrProvinceCode": "string",
            "PostalCode": "string",
            "CountryCode": "string",
            "Phone": "string"
        },
        "ShipToAddress": {
            "Name": "string",
            "AddressLine1": "string",
            "AddressLine2": "string",
            "AddressLine3": "string",
            "DistrictOrCounty": "string",
            "Email": "string",
            "City": "string",
            "StateOrProvinceCode": "string",
            "PostalCode": "string",
            "CountryCode": "string",
            "Phone": "string"
        },
        "PackageDimensions": {
            "Length": 0,
            "Width": 0,
            "Height": 0,
            "Unit": "inches",
            "PredefinedPackageDimensions": "FedEx_Box_10kg"
        },
        "Weight": {
            "Value": 0,
            "Unit": "oz"
        },
        "Insurance": {
            "CurrencyCode": "str",
            "Amount": 0
        },
        "ShippingService": {
            "ShippingServiceName": "string",
            "CarrierName": "string",
            "ShippingServiceId": "string",
            "ShippingServiceOfferId": "string",
            "ShipDate": "2019-08-24T14:15:22Z",
            "EarliestEstimatedDeliveryDate": "2019-08-24T14:15:22Z",
            "LatestEstimatedDeliveryDate": "2019-08-24T14:15:22Z",
            "Rate": {
                "CurrencyCode": "str",
                "Amount": 0
            },
            "ShippingServiceOptions": {
                "DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
                "DeclaredValue": {
                    "CurrencyCode": "str",
                    "Amount": 0
                },
                "CarrierWillPickUp": true,
                "CarrierWillPickUpOption": "CarrierWillPickUp",
                "LabelFormat": "PDF"
            },
            "AvailableShippingServiceOptions": {
                "AvailableCarrierWillPickUpOptions": [
                    {
                        "CarrierWillPickUpOption": "CarrierWillPickUp",
                        "Charge": {
                            "CurrencyCode": "str",
                            "Amount": 0
                        }
                    }
                ],
                "AvailableDeliveryExperienceOptions": [
                    {
                        "DeliveryExperienceOption": "DeliveryConfirmationWithAdultSignature",
                        "Charge": {
                            "CurrencyCode": "str",
                            "Amount": 0
                        }
                    }
                ]
            },
            "AvailableLabelFormats": [
                "PDF"
            ],
            "AvailableFormatOptionsForLabel": [
                {
                    "IncludePackingSlipWithLabel": true,
                    "LabelFormat": "PDF"
                }
            ],
            "RequiresAdditionalSellerInputs": true,
            "Benefits": {
                "IncludedBenefits": [
                    "string"
                ],
                "ExcludedBenefits": [
                    {
                        "Benefit": "string",
                        "ReasonCodes": [
                            "string"
                        ]
                    }
                ]
            }
        },
        "Label": {
            "CustomTextForLabel": "string",
            "Dimensions": {
                "Length": 0,
                "Width": 0,
                "Unit": "inches"
            },
            "FileContents": {
                "Contents": "string",
                "FileType": "application/pdf",
                "Checksum": "string"
            },
            "LabelFormat": "PDF",
            "StandardIdForLabel": "AmazonOrderId"
        },
        "Status": "Purchased",
        "TrackingId": "string",
        "CreatedDate": "2019-08-24T14:15:22Z",
        "LastUpdatedDate": "2019-08-24T14:15:22Z"
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应