listInboundPlans

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans

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.

Responses

Response body

object

inboundPlans

array of objects

A list of inbound plans with minimal information.

inboundPlans

object

createdAt

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

length between 38 and 38

Identifier of an inbound plan.

lastUpdatedAt

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 of strings

required

A list of marketplace IDs.

marketplaceIds*

name

string

required

Human-readable name of the inbound plan.

sourceAddress

object

required

Specific details to identify a place.

status

string

required

length between 1 and 1024

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

pagination

object

Contains tokens to fetch from a certain page.

nextToken

string

length between 1 and 1024

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

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?pageSize=10' \
3
     --header 'accept: application/json'


xxxxxxxxxx
29
}
1
{
2
  "inboundPlans": [
3
    {
4
      "createdAt": "2023-03-08T13:15:30Z",
5
      "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
6
      "lastUpdatedAt": "2023-03-08T13:15:30Z",
7
      "marketplaceIds": [
8
        "A2EUQ1WTGCTBG2"
9
      ],
10
      "name": "FBA (03/08/2023, 01:15 PM)",
11
      "sourceAddress": {
12
        "addressLine1": "123 example street",
13
        "addressLine2": "Floor 19",
14
        "city": "Toronto",
15
        "companyName": "Acme",
16
        "countryCode": "CA",
17
        "email": "email@email.com",
18
        "name": "name",
19
        "phoneNumber": "1234567890",
20
        "postalCode": "M1M1M1",
21
        "stateOrProvinceCode": "ON"
22
      },
23
      "status": "ACTIVE"
24
    }
25
  ],

200ListInboundPlans 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.