List inbound plans

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: ********************

Query Params

pageSize

optional

1 to 30. Defaults to 10. The number of inbound plans 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.

status

optional

ACTIVE or VOIDED or SHIPPED. The status of an inbound plan.

Example:

ACTIVE

sortBy

optional

LAST_UPDATED_TIME or CREATION_TIME. Sort by field

Example:

LAST_UPDATED_TIME

sortOrder

optional

ASC or DESC. The sort order.

Example:

DESC

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

Responses

🟢200OK

application/json

Successful response

Body

inboundPlans

array[object (InboundPlanSummary) {7}]

optional

A list of inbound plans.

createdAt

string <date-time>

required

The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

Example:

2025-05-26T09:36:00Z

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Example:

ABCDEFGH1234567890ABCDEFGH1234567890

lastUpdatedAt

string <date-time>

required

The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

Example:

2025-05-26T10:36:00Z

marketplaceIds

array[string]

required

A list of marketplace IDs.

Example:

["ATVPDKIKX0DER"]

name

string

required

Human-readable name of the inbound plan.

Example:

Summer 2025 Inventory Shipment

sourceAddress

object (Address)

required

status

enum<string>

required

The current status of the inbound plan.

>= 1 characters<= 1024 characters

Allowed values:

ACTIVEVOIDEDSHIPPEDERRORED

Example:

ACTIVE

pagination

object | null

optional

nextToken

string | null

optional

When present, pass this string token in the next request to return the next response page.

>= 1 characters<= 1024 characters

Example:

eyJNYXJrZXJ...

Example

{
    "inboundPlans": [
        {
            "createdAt": "2025-05-26T09:36:00Z",
            "inboundPlanId": "ABCDEFGH1234567890ABCDEFGH1234567890",
            "lastUpdatedAt": "2025-05-26T10:36:00Z",
            "marketplaceIds": [
                "ATVPDKIKX0DER"
            ],
            "name": "Summer 2025 Inventory Shipment",
            "sourceAddress": {
                "addressLine1": "123 Main St",
                "addressLine2": "Suite 100",
                "city": "Seattle",
                "companyName": "Acme Inc",
                "countryCode": "US",
                "email": "contact@example.com",
                "name": "John Doe",
                "phoneNumber": "+12065551234",
                "postalCode": "98109",
                "stateOrProvinceCode": "WA"
            },
            "status": "ACTIVE"
        }
    ],
    "pagination": {
        "nextToken": "eyJNYXJrZXJ..."
    }
}

🟠402402

🟠403Forbidden

🟠422Parameter Error

🟠429429

🔴500Server Error

Request

Request samples

Responses