List shipment items - Seller Assistant API

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Path Params

inboundPlanId

required

Inbound Plan id (Workflow Id).

Example:

wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2

shipmentId

required

Shipment ID, either the old format (FBA...) or the new format (sh...). Requests using the old format may take longer to process.

Example:

sh7059be6b-54b3-4320-8553-f913d3472cc3

Query Params

pageSize

optional

Integer 1 to 1000. Defaults to 10. The number of placement options to return in the response matching the given query.

Example:

paginationToken

optional

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.

detailed

optional

When set to true, includes additional details such as quantityShipped, quantityReceived, and quantityInCase for each shipment item. Note: Enabling this option may significantly slow down the response time.

Example:

false

domain

optional

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Example:

amazon.com

marketplaceId

optional

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Example:

ATVPDKIKX0DER

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful response

Body

items

array [object {8}]

required

The items in a shipment.

asin

string

required

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

>= 1 characters<= 10 characters

expiration

string <date> | null

optional

The expiration date of the MSKU in YYYY-MM-DD format.

Match pattern:

^\d{4}-\d{2}-\d{2}$

fnsku

string

required

A unique identifier assigned by Amazon to products stored in fulfillment centers.

>= 1 characters<= 10 characters

labelOwner

enum<string>

required

Specifies who will label the items.

>= 1 characters<= 1024 characters

Allowed values:

AMAZONSELLERNONE

manufacturingLotCode

string | null

optional

>= 1 characters<= 256 characters

msku

string

required

The merchant SKU identifier.

>= 1 characters<= 40 characters

prepInstructions

array [object {3}]

required

quantity

integer

required

The number of the specified MSKU.

>= 1<= 10000

pagination

object | null

optional

nextToken

string | null

optional

Token for pagination to fetch next page of results.

>= 1 characters<= 1024 characters

Example

{
    "items": [
        {
            "asin": "string",
            "expiration": "2019-08-24",
            "fnsku": "string",
            "labelOwner": "AMAZON",
            "manufacturingLotCode": "string",
            "msku": "string",
            "prepInstructions": [
                {
                    "fee": {
                        "amount": 10.5,
                        "code": "USD"
                    },
                    "prepOwner": "AMAZON",
                    "prepType": "ITEM_LABELING"
                }
            ],
            "quantity": 1
        }
    ],
    "pagination": {
        "nextToken": "string"
    }
}

🟠402402

🟠403Forbidden

🟠422Parameter Error

🟠429429

🔴500Server Error