Interface FbaInboundApiGetShipmentsRequest

Request parameters for getShipments operation in FbaInboundApi.

Export

FbaInboundApiGetShipmentsRequest

interface FbaInboundApiGetShipmentsRequest {
    lastUpdatedAfter?: string;
    lastUpdatedBefore?: string;
    marketplaceId: string;
    nextToken?: string;
    queryType: "DATE_RANGE" | "NEXT_TOKEN" | "SHIPMENT";
    shipmentIdList?: string[];
    shipmentStatusList?: ("WORKING" | "ERROR" | "SHIPPED" | "RECEIVING" | "CANCELLED" | "DELETED" | "CLOSED" | "IN_TRANSIT" | "DELIVERED" | "CHECKED_IN" | "READY_TO_SHIP")[];
}

Properties

lastUpdatedAfter? lastUpdatedBefore? marketplaceId nextToken? queryType shipmentIdList? shipmentStatusList?

Properties

Optional Readonly lastUpdatedAfter

lastUpdatedAfter?: string

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.

Memberof

FbaInboundApiGetShipments

Optional Readonly lastUpdatedBefore

lastUpdatedBefore?: string

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.

Memberof

FbaInboundApiGetShipments

Readonly marketplaceId

marketplaceId: string

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

Memberof

FbaInboundApiGetShipments

Optional Readonly nextToken

nextToken?: string

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

Memberof

FbaInboundApiGetShipments

Readonly queryType

queryType: "DATE_RANGE" | "NEXT_TOKEN" | "SHIPMENT"

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.

Memberof

FbaInboundApiGetShipments

Optional Readonly shipmentIdList

shipmentIdList?: string[]

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.

Memberof

FbaInboundApiGetShipments

Optional Readonly shipmentStatusList

shipmentStatusList?: ("WORKING" | "ERROR" | "SHIPPED" | "RECEIVING" | "CANCELLED" | "DELETED" | "CLOSED" | "IN_TRANSIT" | "DELIVERED" | "CHECKED_IN" | "READY_TO_SHIP")[]

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

Memberof

FbaInboundApiGetShipments

Settings

Member Visibility

Theme

On This Page

lastUpdatedAfterlastUpdatedBeforemarketplaceIdnextTokenqueryTypeshipmentIdListshipmentStatusList