HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

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
230

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.

Path Params
string
required
length between 38 and 38

Identifier of an inbound plan.

string
required
length between 38 and 38

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

Query Params
integer
1 to 20
Defaults to 10

The number of content update previews to return.

string
length between 0 and 1024

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.

Responses

Response body
object
contentUpdatePreviews
array of objects
required

A list of content update previews in a shipment.

contentUpdatePreviews*
object
string
required
length between 38 and 38

Identifier of a content update preview.

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
required

Objects that were included in the update request.

transportationOption
object
required

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

pagination
object

Contains tokens to fetch from a certain page.

string
length between 1 and 1024

When present, pass this string token in the next request to return the next response page.

Headers
object
string

Unique request reference identifier.

string

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

Language