generateShipmentContentUpdatePreviews

POST

/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews

Fulfillment Inbound

Last modified:2024-12-05 08:51:44

Maintainer:Not configured

Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.

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

Body Params application/json

The `GenerateShipmentContentUpdatePreviews` request.

boxes

array[object (BoxUpdateInput) {6}]

required

A list of boxes that will be present in the shipment after the update.

>= 1 items<= 5000 items

contentInformationSource

enum<string>

required

Indication of how box content is meant to be provided.

Allowed values:

BOX_CONTENT_PROVIDEDMANUAL_PROCESSBARCODE_2D

dimensions

object (Dimensions)

required

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

items

array[object (ItemInput) {6}]

optional

The items and their quantity in the box. This must be empty if the box contentInformationSource is BARCODE_2D or MANUAL_PROCESS.

packageId

string

optional

Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed

>= 38 characters<= 38 characters

Match pattern:

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

quantity

integer

required

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

>= 1<= 10000

weight

object (Weight)

required

The weight of the scheduled package

items

array[object (ItemInput) {6}]

required

A list of all items that will be present in the shipment after the update.

>= 1 items<= 2000 items

expiration

string

optional

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

Match pattern:

^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

labelOwner

enum<string>

required

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

Allowed values:

AMAZONSELLERNONE

manufacturingLotCode

string

optional

The manufacturing lot code.

>= 1 characters<= 256 characters

msku

string

required

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

>= 1 characters<= 40 characters

prepOwner

enum<string>

required

The owner of the preparations, if special preparations are required.

Allowed values:

AMAZONSELLERNONE

quantity

integer

required

The number of units of the specified MSKU that will be shipped.

>= 1<= 10000

Example

{
    "boxes": [
        {
            "contentInformationSource": "BOX_CONTENT_PROVIDED",
            "dimensions": {
                "height": 5,
                "length": 3,
                "unitOfMeasurement": "CM",
                "width": 4
            },
            "items": [
                {
                    "expiration": "2024-01-01",
                    "labelOwner": "AMAZON",
                    "manufacturingLotCode": "manufacturingLotCode",
                    "msku": "Sunglasses",
                    "prepOwner": "AMAZON",
                    "quantity": 10
                }
            ],
            "packageId": "pk1234abcd-1234-abcd-5678-1234abcd5678",
            "quantity": 2,
            "weight": {
                "unit": "KG",
                "value": 5.5
            }
        }
    ],
    "items": [
        {
            "expiration": "2024-01-01",
            "labelOwner": "AMAZON",
            "manufacturingLotCode": "manufacturingLotCode",
            "msku": "Sunglasses",
            "prepOwner": "AMAZON",
            "quantity": 10
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//shipments//contentUpdatePreviews' \
--header 'Content-Type: application/json' \
--data-raw '{
    "boxes": [
        {
            "contentInformationSource": "BOX_CONTENT_PROVIDED",
            "dimensions": {
                "height": 5,
                "length": 3,
                "unitOfMeasurement": "CM",
                "width": 4
            },
            "items": [
                {
                    "expiration": "2024-01-01",
                    "labelOwner": "AMAZON",
                    "manufacturingLotCode": "manufacturingLotCode",
                    "msku": "Sunglasses",
                    "prepOwner": "AMAZON",
                    "quantity": 10
                }
            ],
            "packageId": "pk1234abcd-1234-abcd-5678-1234abcd5678",
            "quantity": 2,
            "weight": {
                "unit": "KG",
                "value": 5.5
            }
        }
    ],
    "items": [
        {
            "expiration": "2024-01-01",
            "labelOwner": "AMAZON",
            "manufacturingLotCode": "manufacturingLotCode",
            "msku": "Sunglasses",
            "prepOwner": "AMAZON",
            "quantity": 10
        }
    ]
}'

Responses

🟢202Accepted

application/json

GenerateShipmentContentUpdatePreviews 202 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 `GenerateShipmentContentUpdatePreviews` response.

operationId

string

required

UUID for the given operation.

>= 36 characters<= 38 characters

Match pattern:

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

Example

{
    "operationId": "stringstringstringstringstringstring"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

listShipmentContentUpdatePreviews

getShipmentContentUpdatePreview