HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

listShipmentBoxes

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//shipments//boxes

Provides a paginated list of box packages in a shipment.

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 boxes 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
boxes
array of objects
required

A list of boxes in a shipment.

boxes*
object
string
length between 1 and 1024

The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.

string

Indication of how box content is meant to be provided.

BOX_CONTENT_PROVIDED MANUAL_PROCESS BARCODE_2D

Show Details
BOX_CONTENT_PROVIDEDBox contents have been provided by the seller.
MANUAL_PROCESSBox contents will be manually processed during receive. This service incurs charges.
BARCODE_2DBox contents information is provided by a barcode on the shipment. For more information, refer to [Using 2D barcodes for box content information](https://sellercentral.amazon.com/help/hub/reference/GJWALJCN6JKWJX5A) on Seller Central.
destinationRegion
object

Representation of a location used within the inbounding experience.

dimensions
object

Measurement of a package's dimensions.

string
length between 1 and 1024

The external identifier for this container / box.

string
length between 1 and 1024

Type of the external identifier used. Can be: AMAZON, SSCC.

items
array of objects

Items contained within the box.

items
object
string
required
length between 1 and 10

The Amazon Standard Identification Number (ASIN) of the item.

string

The expiration date of the MSKU. In ISO 8601 datetime format with patternYYYY-MM-DD. The same MSKU with different expiration dates cannot go into the same box.

string
required
length between 1 and 10

A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.

string
required
length between 1 and 1024

Specifies who will label the items. Options include AMAZON, SELLER, and NONE.

string
length between 1 and 256

The manufacturing lot code.

string
required
length between 1 and 40

The merchant SKU, a merchant-supplied identifier of a specific SKU.

prepInstructions
array of objects
required

Special preparations that are required for an item.

prepInstructions*
object
fee
object

The type and amount of currency.

string
length between 1 and 1024

In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include AMAZON, SELLER or NONE.

string
length between 1 and 1024

Type of preparation that should be done.

Possible values: ITEM_LABELING, ITEM_BUBBLEWRAP, ITEM_POLYBAGGING, ITEM_TAPING, ITEM_BLACK_SHRINKWRAP, ITEM_HANG_GARMENT, ITEM_BOXING, ITEM_SETCREAT, ITEM_RMOVHANG, ITEM_SUFFOSTK, ITEM_CAP_SEALING, ITEM_DEBUNDLE, ITEM_SETSTK, ITEM_SIOC, ITEM_NO_PREP, ADULT, BABY, TEXTILE, HANGER, FRAGILE, LIQUID, SHARP, SMALL, PERFORATED, GRANULAR, SET, FC_PROVIDED, UNKNOWN, NONE.

integer
required
1 to 10000

The number of the specified MSKU.

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
length between 1 and 1024

Template name of the box.

weight
object

The weight of a package.

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.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?