listInboundPlans

Provides a list of inbound plans with minimal information.

Usage Plan:

Rate (requests per second)	Burst
2	6

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

Query Params

pageSize

integer

optional

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

>= 1<= 30

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

status

enum<string>

optional

The status of an inbound plan.

Allowed values:

ACTIVEVOIDEDSHIPPED

sortBy

enum<string>

optional

Sort by field.

Allowed values:

LAST_UPDATED_TIMECREATION_TIME

sortOrder

enum<string>

optional

The sort order.

Allowed values:

ASCDESC

Responses

🟢200OK

application/json

ListInboundPlans 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 `listInboundPlans` response.

inboundPlans

array[object (InboundPlanSummary) {7}]

optional

A list of inbound plans with minimal information.

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.

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

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

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.

marketplaceIds

array[string]

required

A list of marketplace IDs.

name

string

required

Human-readable name of the inbound plan.

sourceAddress

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

status

string

required

The current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

>= 1 characters<= 1024 characters

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

{
    "inboundPlans": [
        {
            "createdAt": "2023-03-08T13:15:30Z",
            "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
            "lastUpdatedAt": "2023-03-08T13:15:30Z",
            "marketplaceIds": [
                "A2EUQ1WTGCTBG2"
            ],
            "name": "FBA (03/08/2023, 01:15 PM)",
            "sourceAddress": {
                "addressLine1": "123 example street",
                "addressLine2": "Floor 19",
                "city": "Toronto",
                "companyName": "Acme",
                "countryCode": "CA",
                "email": "email@email.com",
                "name": "name",
                "phoneNumber": "1234567890",
                "postalCode": "M1M1M1",
                "stateOrProvinceCode": "ON"
            },
            "status": "ACTIVE"
        }
    ],
    "pagination": {
        "nextToken": "string"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses