getShipmentContentUpdatePreview

Retrieve a shipment content update preview which provides 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-]*$

contentUpdatePreviewId

string

required

Identifier of a content update preview.

>= 38 characters<= 38 characters

Match pattern:

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

GetShipmentContentUpdatePreview 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

Preview of the changes that will be applied to the 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.

boxes

array[object (BoxUpdateInput) {6}]

optional

A list of boxes that will be present in the shipment after the update.

items

array[object (ItemInput) {6}]

optional

A list of all items that will be present in the shipment after the update.

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

carrier

object (Carrier)

required

The carrier for the inbound shipment.

carrierAppointment

object (CarrierAppointment)

optional

Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.

preconditions

array[string]

required

Identifies a list of preconditions for confirming the transportation option.

quote

object (Quote)

optional

The estimated shipping cost associated with the transportation option.

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-]*$

shippingMode

string

required

Mode of shipment transportation that this option will provide.

Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS.

>= 1 characters<= 1024 characters

shippingSolution

string

required

Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER.

>= 1 characters<= 1024 characters

transportationOptionId

string

required

Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

>= 38 characters<= 38 characters

Match pattern:

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

Example

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

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable