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.
Path parameters
Identifier of an inbound plan.
Identifier of a shipment. A shipment contains the boxes and units being inbounded.
Query parameters
The number of content update previews to return.
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.
Response
ListShipmentContentUpdatePreviews 200 response
Example response
{
"contentUpdatePreviews": [
{
"requestedUpdates": {
"boxes": [
{
"items": [
{
"expiration": "2024-01-01",
"labelOwner": "AMAZON",
"manufacturingLotCode": "manufacturingLotCode",
"msku": "Sunglasses",
"prepOwner": "AMAZON",
"quantity": 10
}
]
}
],
"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"
}
}
]
}