Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface ExternalFulfillmentShipmentsApiGetShipmentsRequest

    Request parameters for getShipments operation in ExternalFulfillmentShipmentsApi.

    interface ExternalFulfillmentShipmentsApiGetShipmentsRequest {
        channelName?: string;
        lastUpdatedAfter?: string;
        lastUpdatedBefore?: string;
        locationId?: string;
        marketplaceId?: string;
        maxResults?: number;
        paginationToken?: string;
        status: GetShipmentsStatusEnum;
    }
    Index

    Properties

    channelName? lastUpdatedAfter? lastUpdatedBefore? locationId? marketplaceId? maxResults? paginationToken? status

    Properties

    channelName?: string

    The channel name associated with the location.

    lastUpdatedAfter?: string

    The response includes shipments whose latest update is after the specified time. In ISO 8601 date-time format.

    lastUpdatedBefore?: string

    The response includes shipments whose latest update is before the specified time. In ISO 8601 date-time format.

    locationId?: string

    The Amazon channel location identifier for the shipments you want to retrieve.

    marketplaceId?: string

    The marketplace ID associated with the location. To find the ID for your marketplace, refer to Marketplace IDs.

    maxResults?: number

    The maximum number of shipments to include in the response.

    paginationToken?: string

    A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    status: GetShipmentsStatusEnum

    The status of shipment you want to include in the response. To retrieve all new shipments, set this value to `ACCEPTED`.

    Settings

    Member Visibility

    On This Page

    Properties