---
title: "List plan shipments"
method: GET
path: "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments"
tags: ["FBA Inbound Shipments"]
---

# List plan shipments

`GET /api/v1/fba/inboundPlans/{inboundPlanId}/shipments`

## 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/{inboundPlanId}/shipments`
- Auth: one of:
  - API key in query parameter `api_key`
  - API key in header `X-Api-Key`

List plan shipments. 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

- ListPlanShipmentsResponse
  - `inboundPlan` InboundPlanSummary
    - `createdAt` string, 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: 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.
    - `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: The current status of the inbound plan.
  - `shipments` ShipmentSummary[]
    - `amazonReferenceId` string, nullable: A unique identifier created by Amazon that identifies this Amazon-partnered shipment.
    - `contactInformation` object, nullable
      - `email` string, nullable
      - `name` string: The contact's name.
      - `phoneNumber` string: The phone number.
    - `dates` object, nullable
      - `readyToShipWindow` object, nullable
        - `editableUntil` string, date-time
        - `end` string, date-time, required
        - `start` string, date-time, required
    - `destination` object
      - `address` Address
        - `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.
      - `destinationType` 'AMAZON_OPTIMIZED' | 'AMAZON_WAREHOUSE': The type of destination for this shipment.
      - `warehouseId` string, nullable
    - `freightInformation` object, nullable
      - `declaredValue` CurrencyValue
        - `amount` number, float, required: Decimal value of the currency.
        - `code` string, required: ISO 4217 standard of a currency code.
      - `freightClass` 'NONE' | 'FC_50' | 'FC_55' | 'FC_60' | 'FC_65' | 'FC_70' | 'FC_77_5' | 'FC_85' | 'FC_92_5' | 'FC_100' | 'FC_110' | 'FC_125' | 'FC_150' | 'FC_175' | 'FC_200' | 'FC_250' | 'FC_300' | 'FC_400' | 'FC_500', nullable
      - `name` string, nullable
    - `placementOptionId` string: The identifier of a placement option.
    - `selectedDeliveryWindow` object, nullable
      - `availabilityType` 'AVAILABLE' | 'CONGESTED', required: Identifies type of Delivery Window Availability.
      - `deliveryWindowOptionId` string, required: Identifier of a delivery window option.
      - `editableUntil` string, date-time, nullable
      - `endDate` string, date-time, required
      - `startDate` string, date-time, required
    - `selectedTransportationOptionId` string, nullable
    - `selfShipAppointmentDetails` object[], nullable
      - `appointmentId` number: Identifier for appointment.
      - `appointmentSlotTime` object
        - `endTime` string, date-time, required
        - `startTime` string, date-time, required
      - `appointmentStatus` string
    - `shipmentConfirmationId` string, nullable
    - `shipmentId` string: Identifier of a shipment.
    - `source` object
      - `address` Address
        - `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.
      - `sourceType` 'SELLER_FACILITY': The type of source for this shipment.
    - `status` 'ABANDONED' | 'CANCELLED' | 'CHECKED_IN' | 'CLOSED' | 'DELETED' | 'DELIVERED' | 'IN_TRANSIT' | 'MIXED' | 'READY_TO_SHIP' | 'RECEIVING' | 'SHIPPED' | 'UNCONFIRMED' | 'WORKING', nullable
    - `trackingDetails` object, nullable
      - `ltlTrackingDetail` object, nullable
        - `billOfLadingNumber` string, nullable
        - `freightBillNumber` string[], nullable
      - `spdTrackingDetail` object, nullable
        - `spdTrackingItems` object[], nullable
          - `boxId` string, nullable
          - `trackingId` string, nullable
          - `trackingNumberValidationStatus` 'VALIDATED' | 'NOT_VALIDATED', nullable

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