---
title: "listInboundPlans"
method: GET
path: "/inbound/fba/2024-03-20/inboundPlans"
tags: ["Fulfillment Inbound v2024-03-20"]
---

# listInboundPlans

`GET /inbound/fba/2024-03-20/inboundPlans`

Provides a list of inbound plans with minimal information.

## Query parameters

- `pageSize` integer
- `paginationToken` string
- `status` 'ACTIVE' | 'VOIDED' | 'SHIPPED'
- `sortBy` 'LAST_UPDATED_TIME' | 'CREATION_TIME'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

ListInboundPlans 200 response

- ListInboundPlansResponse — The `listInboundPlans` response.
  - `inboundPlans` InboundPlanSummary[] — 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
    - `inboundPlanId` string, required — Identifier of an inbound plan.
    - `lastUpdatedAt` string, date-time, required — The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
    - `marketplaceIds` string[], required — A list of marketplace IDs.
    - `name` string, required — Human-readable name of the inbound plan.
    - `sourceAddress` Address, required — Address of the party.
      - `name` string, required — The name of the person, business or institution at that address.
      - `addressLine1` string, required — First line of the address.
      - `addressLine2` string — Additional street address information, if required.
      - `addressLine3` string — Additional street address information, if required.
      - `city` string — The city where the person, business or institution is located.
      - `county` string — The county where person, business or institution is located.
      - `district` string — The district where person, business or institution is located.
      - `stateOrRegion` string — The state or region where person, business or institution is located.
      - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
      - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
      - `phone` string — The phone number of the person, business or institution located at that address.
    - `status` string, required — The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`.
  - `pagination` Pagination — The pagination elements required to retrieve the remaining data.
    - `nextToken` string — A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The resource specified does not exist.
- `413` — The request size exceeded the maximum accepted size.
- `415` — The request payload is in an unsupported format.
- `429` — The frequency of requests was greater than allowed.
- `500` — An unexpected condition occurred that prevented the server from fulfilling the request.
- `503` — Temporary overloading or maintenance of the server.

---

[API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)