listShipmentBoxes

Provides a paginated list of box packages in a shipment.

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

Query Params

pageSize

integer

optional

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

>= 1<= 1000

Default:

paginationToken

string

optional

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.

>= 0 characters<= 1024 characters

Responses

🟢200OK

application/json

ListShipmentBoxes 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

The `listShipmentBoxes` response.

boxes

array[object (Box) {9}]

required

A list of boxes in a shipment.

boxId

string

optional

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.

>= 1 characters<= 1024 characters

contentInformationSource

enum<string>

optional

Indication of how box content is meant to be provided.

Allowed values:

BOX_CONTENT_PROVIDEDMANUAL_PROCESSBARCODE_2D

destinationRegion

object (Region)

optional

Representation of a location used within the inbounding experience.

dimensions

object (Dimensions)

optional

Dimensions of an Amazon catalog item or item in its packaging.

items

array[object (Item) {7}]

optional

Items contained within the box.

packageId

string

required

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

>= 38 characters<= 38 characters

Match pattern:

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

quantity

integer

optional

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

>= 1<= 10000

templateName

string

optional

Template name of the box.

>= 1 characters<= 1024 characters

weight

object (Weight)

optional

The weight of the scheduled package

pagination

object (Pagination)

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

Example

{
    "boxes": [
        {
            "boxId": "string",
            "contentInformationSource": "BOX_CONTENT_PROVIDED",
            "destinationRegion": {
                "countryCode": "string",
                "state": "string",
                "warehouseId": "string"
            },
            "dimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "items": [
                {
                    "sku": "string",
                    "summaries": [
                        {
                            "marketplaceId": "string",
                            "asin": "string",
                            "productType": "string",
                            "conditionType": "new_new",
                            "status": [
                                "BUYABLE"
                            ],
                            "fnSku": "string",
                            "itemName": "string",
                            "createdDate": "2019-08-24T14:15:22Z",
                            "lastUpdatedDate": "2019-08-24T14:15:22Z",
                            "mainImage": {
                                "link": "string",
                                "height": 0,
                                "width": 0
                            }
                        }
                    ],
                    "attributes": {},
                    "issues": [
                        {
                            "code": "string",
                            "message": "string",
                            "severity": "ERROR",
                            "attributeNames": [
                                "string"
                            ],
                            "categories": [
                                "INVALID_ATTRIBUTE"
                            ],
                            "enforcements": {
                                "actions": [
                                    {
                                        "action": "LISTING_SUPPRESSED"
                                    }
                                ],
                                "exemption": {
                                    "status": "EXEMPT",
                                    "expiryDate": "2023-10-28T00:36:48.914Z"
                                }
                            }
                        }
                    ],
                    "offers": [
                        {
                            "marketplaceId": "string",
                            "offerType": "B2C",
                            "price": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "points": {
                                "pointsNumber": 0,
                                "pointsMonetaryValue": {
                                    "currencyCode": "string",
                                    "amount": 0
                                }
                            },
                            "audience": {
                                "value": "ALL",
                                "displayName": "string"
                            }
                        }
                    ],
                    "fulfillmentAvailability": [
                        {
                            "fulfillmentChannelCode": "string",
                            "quantity": 0
                        }
                    ],
                    "procurement": [
                        {
                            "costPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "packageId": "stringstringstringstringstringstringst",
            "quantity": 1,
            "templateName": "string",
            "weight": {
                "value": 11,
                "unit": "Grams"
            }
        }
    ],
    "pagination": {
        "nextToken": "string"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses