listShipmentContentUpdatePreviews

Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.

Usage Plan:

Rate (requests per second)	Burst
2	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

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

shipmentId

string

required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

>= 38 characters<= 38 characters

Match pattern:

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

Query Params

pageSize

integer

optional

The number of content update previews to return.

>= 1<= 20

Default:

paginationToken

string

optional

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

>= 0 characters<= 1024 characters

Responses

🟢200OK

application/json

ListShipmentContentUpdatePreviews 200 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

Body

The `ListShipmentContentUpdatePreviews` response.

contentUpdatePreviews

array[object (ContentUpdatePreview) {4}]

required

A list of content update previews in a shipment.

contentUpdatePreviewId

string

required

Identifier of a content update preview.

>= 38 characters<= 38 characters

Match pattern:

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

expiration

string <date-time>

required

The time at which the content update expires. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.

requestedUpdates

object (RequestedUpdates)

required

Objects that were included in the update request.

transportationOption

object (TransportationOption)

required

Contains information pertaining to a transportation option and the related carrier.

Example:

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

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

Example

{
    "contentUpdatePreviews": [
        {
            "contentUpdatePreviewId": "stringstringstringstringstringstringst",
            "expiration": "2019-08-24T14:15:22Z",
            "requestedUpdates": {
                "boxes": [
                    {
                        "contentInformationSource": "BOX_CONTENT_PROVIDED",
                        "dimensions": {
                            "height": {
                                "unit": "string",
                                "value": 0
                            },
                            "length": {
                                "unit": "string",
                                "value": 0
                            },
                            "weight": {
                                "unit": "string",
                                "value": 0
                            },
                            "width": {
                                "unit": "string",
                                "value": 0
                            }
                        },
                        "items": [
                            {
                                "expiration": "2024-01-01",
                                "labelOwner": "AMAZON",
                                "manufacturingLotCode": "manufacturingLotCode",
                                "msku": "Sunglasses",
                                "prepOwner": "AMAZON",
                                "quantity": 10
                            }
                        ],
                        "packageId": "stringstringstringstringstringstringst",
                        "quantity": 1,
                        "weight": {
                            "value": 11,
                            "unit": "Grams"
                        }
                    }
                ],
                "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"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

listShipmentContentUpdatePreviews

Request

Request samples

Responses