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

# getInboundPlan

`GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}`

Fetches the top level information about an inbound plan.

## Path parameters

- `inboundPlanId` string, required

## Response `200`

GetInboundPlan 200 response

- InboundPlan — Inbound plan containing details of the inbound workflow.
  - `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 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.
  - `packingOptions` PackingOptionSummary[] — Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details.
    - `packingOptionId` string, required — Identifier of a packing option.
    - `status` string, required — The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'.
  - `placementOptions` PlacementOptionSummary[] — Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details.
    - `placementOptionId` string, required — The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
    - `status` string, required — The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`.
  - `shipments` ShipmentSummary[] — A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details.
    - `shipmentId` string, required — Identifier of a shipment. A shipment contains the boxes and units being inbounded.
    - `status` string, required — The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`
  - `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 — Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`.

## 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)