---
title: "getShipments"
method: GET
path: "/fba/inbound/v0/shipments"
tags: ["Fulfillment Inbound v0"]
---

# getShipments

`GET /fba/inbound/v0/shipments`

Returns a list of inbound shipments based on criteria that you specify.

**Usage Plan:**

| Rate (requests per second) | Burst |
| ---- | ---- |
| 2 | 30 |

The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

## Query parameters

- `ShipmentStatusList` string[]
- `ShipmentIdList` string[]
- `LastUpdatedAfter` string, date-time
- `LastUpdatedBefore` string, date-time
- `QueryType` 'SHIPMENT' | 'DATE_RANGE' | 'NEXT_TOKEN', required
- `NextToken` string
- `MarketplaceId` string, required

## Response `200`

Success.

- GetShipmentsResponse — The response schema for the getShipments operation.
  - `payload` GetShipmentsResult — Result for the get shipments operation
    - `ShipmentData` InboundShipmentInfo[] — A list of inbound shipment information.
      - `ShipmentId` string — The shipment identifier submitted in the request.
      - `ShipmentName` string — The name for the inbound shipment.
      - `ShipFromAddress` 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.
      - `DestinationFulfillmentCenterId` string — An Amazon fulfillment center identifier created by Amazon.
      - `ShipmentStatus` 'ReadyForPickup' | 'PickedUp' | 'RefusedPickup' — The shipment status to apply.
      - `LabelPrepType` 'NO_LABEL' | 'SELLER_LABEL' | 'AMAZON_LABEL' — The type of label preparation that is required for the inbound shipment.
      - `AreCasesRequired` boolean, required — Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.
      - `ConfirmedNeedByDate` string, date — Type containing date in string format
      - `BoxContentsSource` 'NONE' | 'FEED' | '2D_BARCODE' | 'INTERACTIVE' — Where the seller provided box contents information for a shipment.
      - `EstimatedBoxContentsFee` BoxContentsFeeDetails — The manual processing fee per unit and total fee for a shipment.
        - `TotalUnits` integer — The item quantity.
        - `FeePerUnit` Amount — A quantity based on the specified unit of measurement.
          - `unitOfMeasure` 'Eaches', required — The unit of measure for the amount.
          - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `TotalFee` Amount — A quantity based on the specified unit of measurement.
          - `unitOfMeasure` 'Eaches', required — The unit of measure for the amount.
          - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
    - `NextToken` string — When present and not empty, pass this string token in the next request to return the next response page.
  - `errors` Error[] — A list of error responses returned when a request is unsuccessful.
    - `code` string, required — An error code that identifies the type of error that occurred.
    - `message` string, required — A message that describes the error condition.
    - `details` string — Additional details that can help the caller understand or fix the issue.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `401` — The request's Authorization header is not formatted correctly or does not contain a valid token.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The specified resource does not exist.
- `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/versions/815a5b6dbaa6/schema)
