listShipmentContentUpdatePreviews

检索给定货件的分页货件内容更新预览列表。货件内容更新预览是一项请求的货件内容变更的总结，以及该变更的运输成本影响，这些影响仅在指定的到期日期之前可以确认。

使用计划：

速率（每秒请求数）	峰值
2	30

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

请求参数

Path 参数

inboundPlanId

string

入境计划的标识符。

必需

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

shipmentId

string

必需

货物的识别码。货物包含正在入库的箱子和单位。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

Query 参数

pageSize

integer

可选

返回的内容更新预览数量。

>= 1<= 20

默认值:

paginationToken

string

可选

一个令牌，用于在有多个页面结果时获取特定页面。此令牌的值从API响应中返回的pagination中获取。如果查询参数中没有令牌值，API将返回结果的第一页。

>= 0 字符<= 1024 字符

返回响应

🟢200成功

application/json

ListShipmentContentUpdatePreviews 200 响应

Headers

x-amzn-RequestId

string

可选

唯一请求参考标识符。

x-amzn-RateLimit-Limit

string

可选

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

Body

`ListShipmentContentUpdatePreviews` 响应。

contentUpdatePreviews

array[object (ContentUpdatePreview) {4}]

必需

货物中的内容更新预览列表。

contentUpdatePreviewId

string

必需

内容更新预览的标识符。

>= 38 字符<= 38 字符

正则匹配:

^[a-zA-Z0-9-]*$

expiration

string

必需

内容更新到期的ISO 8601格式日期。

正则匹配:

^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

requestedUpdates

object (RequestedUpdates)

必需

在更新请求中包含的对象。

transportationOption

object (TransportationOption)

必需

包含与运输选项及相关承运人有关的信息。

示例值:

{"carrier":{"alphaCode":"ABCD","name":"Carrier Name"},"carrierAppointment":{"endTime":"2024-01-06T14:48:00.000Z","startTime":"2024-01-05T14:48:00.000Z"},"preconditions":["CONFIRMED_DELIVERY_WINDOW"],"quote":{"cost":{"amount":5.5,"code":"CAD"},"expiration":"2024-01-06T14:48:00.000Z","voidableUntil":"2024-01-05T14:48:00.000Z"},"shipmentId":"sh1234abcd-1234-abcd-5678-1234abcd5678","shippingMode":"GROUND_SMALL_PARCEL","shippingSolution":"AMAZON_PARTNERED_CARRIER","transportationOptionId":"to1234abcd-1234-abcd-5678-1234abcd5678"}

pagination

object (Pagination)

可选

包含从某个页面获取的令牌。

nextToken

string

可选

在存在时，将此字符串令牌在下一个请求中传递，以返回下一个响应页面。

>= 1 字符<= 1024 字符

示例

{
    "contentUpdatePreviews": [
        {
            "contentUpdatePreviewId": "stringstringstringstringstringstringst",
            "expiration": "string",
            "requestedUpdates": {
                "boxes": [
                    {
                        "contentInformationSource": "BOX_CONTENT_PROVIDED",
                        "dimensions": {
                            "height": 0,
                            "length": 0,
                            "unitOfMeasurement": "IN",
                            "width": 0
                        },
                        "items": [
                            {
                                "expiration": "2024-01-01",
                                "labelOwner": "AMAZON",
                                "manufacturingLotCode": "manufacturingLotCode",
                                "msku": "Sunglasses",
                                "prepOwner": "AMAZON",
                                "quantity": 10
                            }
                        ],
                        "packageId": "stringstringstringstringstringstringst",
                        "quantity": 1,
                        "weight": {
                            "unit": "LB",
                            "value": 0
                        }
                    }
                ],
                "items": [
                    {
                        "expiration": "2024-01-01",
                        "labelOwner": "AMAZON",
                        "manufacturingLotCode": "manufacturingLotCode",
                        "msku": "Sunglasses",
                        "prepOwner": "AMAZON",
                        "quantity": 10
                    }
                ]
            },
            "transportationOption": {
                "carrier": {
                    "alphaCode": "ABCD",
                    "name": "Carrier Name"
                },
                "carrierAppointment": {
                    "endTime": "2024-01-06T14:48:00.000Z",
                    "startTime": "2024-01-05T14:48:00.000Z"
                },
                "preconditions": [
                    "CONFIRMED_DELIVERY_WINDOW"
                ],
                "quote": {
                    "cost": {
                        "amount": 5.5,
                        "code": "CAD"
                    },
                    "expiration": "2024-01-06T14:48:00.000Z",
                    "voidableUntil": "2024-01-05T14:48:00.000Z"
                },
                "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
                "shippingMode": "GROUND_SMALL_PARCEL",
                "shippingSolution": "AMAZON_PARTNERED_CARRIER",
                "transportationOptionId": "to1234abcd-1234-abcd-5678-1234abcd5678"
            }
        }
    ],
    "pagination": {
        "nextToken": "string"
    }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应