getShipments

get https://sellingpartnerapi-na.amazon.com/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.

Query Params

ShipmentStatusList

array of strings

A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
READY_TO_SHIP	The seller has printed box labels (for Small parcel shipments) or pallet labels (for Less Than Truckload shipments).
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

ShipmentStatusList

ShipmentIdList

array of strings

length ≤ 999

A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

ShipmentIdList

LastUpdatedAfter

date-time

A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

LastUpdatedBefore

date-time

A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

QueryType

string

required

Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

NextToken

string

A string token returned in the response to your previous request.

MarketplaceId

string

required

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Result for the get shipments operation

ShipmentData

array of objects

A list of inbound shipment information.

ShipmentData

object

ShipmentId

string

The shipment identifier submitted in the request.

ShipmentName

string

The name for the inbound shipment.

ShipFromAddress

object

required

Specific details to identify a place.

DestinationFulfillmentCenterId

string

An Amazon fulfillment center identifier created by Amazon.

ShipmentStatus

string

WORKING SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN

Show Details

WORKING	The shipment was created by the seller, but has not yet shipped.
SHIPPED	The shipment was picked up by the carrier.
RECEIVING	The shipment has arrived at the fulfillment center, but not all items have been marked as received.
CANCELLED	The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
DELETED	The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
CLOSED	The shipment has arrived at the fulfillment center and all items have been marked as received.
ERROR	There was an error with the shipment and it was not processed by Amazon.
IN_TRANSIT	The carrier has notified the fulfillment center that it is aware of the shipment.
DELIVERED	The shipment was delivered by the carrier to the fulfillment center.
CHECKED_IN	The shipment was checked-in at the receiving dock of the fulfillment center.

LabelPrepType

string

The type of label preparation that is required for the inbound shipment.

NO_LABEL SELLER_LABEL AMAZON_LABEL

Show Details

NO_LABEL	No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
SELLER_LABEL	Label preparation by the seller is required.
AMAZON_LABEL	Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

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

date

Type containing date in string format

BoxContentsSource

string

Where the seller provided box contents information for a shipment.

NONE FEED 2D_BARCODE INTERACTIVE

Show Details

NONE	There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEED	Box contents information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
2D_BARCODE	Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVE	Box contents information is provided by an interactive source, such as a web tool.

EstimatedBoxContentsFee

object

The manual processing fee per unit and total fee for a shipment.

NextToken

string

When present and not empty, pass this string token in the next request to return the next response page.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occured.

message

string

required

A message that describes the error condition in a human-readable form.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments?QueryType=SHIPMENT' \
3
     --header 'accept: application/json'


xxxxxxxxxx
45
}
1
{
2
  "payload": {
3
    "ShipmentData": [
4
      {
5
        "ShipmentId": "string",
6
        "ShipmentName": "string",
7
        "ShipFromAddress": {
8
          "Name": "string",
9
          "AddressLine1": "string",
10
          "AddressLine2": "string",
11
          "DistrictOrCounty": "string",
12
          "City": "string",
13
          "StateOrProvinceCode": "string",
14
          "CountryCode": "string",
15
          "PostalCode": "string"
16
        },
17
        "DestinationFulfillmentCenterId": "string",
18
        "ShipmentStatus": "WORKING",
19
        "LabelPrepType": "NO_LABEL",
20
        "AreCasesRequired": true,
21
        "ConfirmedNeedByDate": "2025-04-01",
22
        "BoxContentsSource": "NONE",
23
        "EstimatedBoxContentsFee": {
24
          "TotalUnits": 0,
25
          "FeePerUnit": {

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.