---
title: "Get inbound plan"
method: GET
path: "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}"
tags: ["SP-API FBA Shipments"]
---

# Get inbound plan

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

## 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/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}`
- Auth: one of:
  - API key in query parameter `api_key`
  - API key in header `X-Api-Key`

Proxy to https://developer-docs.amazon.com/sp-api/reference/getinboundplan. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).

## Response `200`

Successful response

- GetInboundPlanResponse
  - `createdAt` string, date-time, required: The time at which the inbound plan was created. In 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 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` object[], nullable: Packing options for the inbound plan.
    - `packingOptionId` string, required: Identifier of a packing option.
    - `status` 'OFFERED' | 'ACCEPTED' | 'EXPIRED', required: The status of a packing option.
  - `placementOptions` object[], nullable: Placement options for the inbound plan.
    - `placementOptionId` string, required: The identifier of a placement option.
    - `status` 'OFFERED' | 'ACCEPTED', required: The status of a placement option.
  - `shipments` object[], nullable: A list of shipment IDs for the inbound plan.
    - `shipmentId` string, required: Identifier of a shipment.
    - `status` 'ABANDONED' | 'CANCELLED' | 'CHECKED_IN' | 'CLOSED' | 'DELETED' | 'DELIVERED' | 'IN_TRANSIT' | 'MIXED' | 'READY_TO_SHIP' | 'RECEIVING' | 'SHIPPED' | 'UNCONFIRMED' | 'WORKING', required: The status of a shipment.
  - `sourceAddress` Address, required
    - `addressLine1` string, required: Street address information.
    - `addressLine2` string, nullable: Additional street address information.
    - `city` string, required: The city.
    - `companyName` string, nullable: The name of the business.
    - `countryCode` string, required: The country code in two-character ISO 3166-1 alpha-2 format.
    - `email` string, nullable: The email address.
    - `name` string, required: The name of the individual who is the primary contact.
    - `phoneNumber` string, nullable: The phone number.
    - `postalCode` string, required: The postal code.
    - `stateOrProvinceCode` string, nullable: The state or province code.
  - `status` 'ACTIVE' | 'VOIDED' | 'SHIPPED' | 'ERRORED', required: Current status of the inbound plan.

## Other responses

- `402`: Payment Required - subscription expired or payment method required
- `403`: Access denied - insufficient permissions, invalid API key, or the API request limit is used up (`public_api_key_limit`)
- `422`: Business logic error - operation cannot be completed due to business rules
- `429`: Too many requests - rate limit exceeded
- `500`: Internal Error

---

[API](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api.md) · [All operations](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/revisions/5b3ecdbcadb6?raw)
