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

listShipmentPallets

Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.

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 1000
Defaults to 10

The number of pallets to return in the response matching the given query.

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
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.

pallets
array of objects
required

The pallets in a shipment.

pallets*
object
dimensions
object

Measurement of a package's dimensions.

string
required
length between 38 and 38

Primary key to uniquely identify a Package (Box or Pallet).

integer
1 to 10000

The number of containers where all other properties like weight or dimensions are identical.

string

Indicates whether pallets will be stacked when carrier arrives for pick-up.

STACKABLE NON_STACKABLE

Show Details
STACKABLEA pallet that can be stacked on top of another pallet.
NON_STACKABLEA pallet that cannot be stacked on top of another pallet.
weight
object

The weight of a package.

Headers
object
string

Unique request reference identifier.

string

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

Language