getShipmentContentUpdatePreview

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}

Retrieve a shipment content update preview which provides 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
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.

Responses

Response body

object

contentUpdatePreviewId

string

required

length between 38 and 38

Identifier of a content update preview.

expiration

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.

boxes

array of objects

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

boxes

object

contentInformationSource

string

required

Indication of how box content is meant to be provided.

BOX_CONTENT_PROVIDED MANUAL_PROCESS BARCODE_2D

Show Details

BOX_CONTENT_PROVIDED	Box contents have been provided by the seller.
MANUAL_PROCESS	Box contents will be manually processed during receive. This service incurs charges.
BARCODE_2D	Box 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.

dimensions

object

required

Measurement of a package's dimensions.

items

array of objects

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

items

object

expiration

string

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.

labelOwner

string

required

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

AMAZON SELLER NONE

Show Details

AMAZON	Amazon provides the information.
SELLER	Seller provides the information.
NONE	No owner is required for the labelling.

manufacturingLotCode

string

length between 1 and 256

The manufacturing lot code.

msku

string

required

length between 1 and 40

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

prepOwner

string

required

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

AMAZON SELLER NONE

Show Details

AMAZON	Amazon provides the information.
SELLER	The seller provides the information.
NONE	No owner is required for the preparations.

quantity

integer

required

1 to 10000

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

packageId

string

length between 38 and 38

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

quantity

integer

required

1 to 10000

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

weight

object

required

The weight of a package.

items

array of objects

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

items

object

expiration

string

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.

labelOwner

string

required

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

AMAZON SELLER NONE

Show Details

AMAZON	Amazon provides the information.
SELLER	Seller provides the information.
NONE	No owner is required for the labelling.

manufacturingLotCode

string

length between 1 and 256

The manufacturing lot code.

msku

string

required

length between 1 and 40

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

prepOwner

string

required

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

AMAZON SELLER NONE

Show Details

AMAZON	Amazon provides the information.
SELLER	The seller provides the information.
NONE	No owner is required for the preparations.

quantity

integer

required

1 to 10000

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

transportationOption

object

required

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

carrier

object

required

The carrier for the inbound shipment.

carrierAppointment

object

Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.

preconditions

array of strings

required

Identifies a list of preconditions for confirming the transportation option.

preconditions*

quote

object

The estimated shipping cost associated with the transportation option.

shipmentId

string

required

length between 38 and 38

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

shippingMode

string

required

length between 1 and 1024

Mode of shipment transportation that this option will provide.

Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS.

shippingSolution

string

required

length between 1 and 1024

Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER.

transportationOptionId

string

required

length between 38 and 38

Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

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

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/inboundPlanId/shipments/shipmentId/contentUpdatePreviews/contentUpdatePreviewId \
3
     --header 'accept: application/json'


xxxxxxxxxx
68
}
1
{
2
  "contentUpdatePreviewId": "string",
3
  "expiration": "2025-04-02T01:28:52.649Z",
4
  "requestedUpdates": {
5
    "boxes": [
6
      {
7
        "contentInformationSource": "BOX_CONTENT_PROVIDED",
8
        "dimensions": {
9
          "height": 0,
10
          "length": 0,
11
          "unitOfMeasurement": "IN",
12
          "width": 0
13
        },
14
        "items": [
15
          {
16
            "expiration": "2024-01-01",
17
            "labelOwner": "AMAZON",
18
            "manufacturingLotCode": "manufacturingLotCode",
19
            "msku": "Sunglasses",
20
            "prepOwner": "AMAZON",
21
            "quantity": 10
22
          }
23
        ],
24
        "packageId": "string",
25
        "quantity": 0,

200GetShipmentContentUpdatePreview 200 response

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.