List inbound plans

List of paginated inbound plans. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it here.

get/api/v1/fba/inboundPlans

Request

Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
URL: https://app.sellerassistant.app/api/v1/fba/inboundPlans
Auth: one of:
- API key in query parameter api_key
- API key in header X-Api-Key

Query parameters

1 to 30. Defaults to 10. The number of inbound plans to return in the response matching the given query.

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.

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

LAST_UPDATED_TIME or CREATION_TIME. Sort by field

ASC or DESC. The sort order.

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.

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.

Response

Successful response

Example response

{
  "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..."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.