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

    Request parameters for searchOrders operation in OrdersApi.

    interface OrdersApiSearchOrdersRequest {
        createdAfter?: string;
        createdBefore?: string;
        fulfilledBy?: SearchOrdersFulfilledByEnum[];
        fulfillmentStatuses?: SearchOrdersFulfillmentStatusesEnum[];
        includedData?: SearchOrdersIncludedDataEnum[];
        lastUpdatedAfter?: string;
        lastUpdatedBefore?: string;
        marketplaceIds?: string[];
        maxResultsPerPage?: number;
        paginationToken?: string;
    }
    Index

    Properties

    createdAfter?: string

    The response includes orders created at or after this time. The date must be in ISO 8601 format. Note: You must provide exactly one of `createdAfter` and `lastUpdatedAfter` in your request. If `createdAfter` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.

    createdBefore?: string

    The response includes orders created at or before this time. The date must be in ISO 8601 format. Note: If you include `createdAfter` in the request, `createdBefore` is optional, and if provided must be equal to or after the `createdAfter` date and at least two minutes before the time of the request. If `createdBefore` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.

    The response includes orders that are fulfilled by the parties that you include in this list.

    fulfillmentStatuses?: SearchOrdersFulfillmentStatusesEnum[]

    A list of `FulfillmentStatus` values you can use to filter the results.

    A list of datasets to include in the response.

    lastUpdatedAfter?: string

    The response includes orders updated at or after this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format. Note: You must provide exactly one of `createdAfter` and `lastUpdatedAfter`. If `lastUpdatedAfter` is provided, neither `createdAfter` nor `createdBefore` may be provided.

    lastUpdatedBefore?: string

    The response includes orders updated at or before this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format. Note: If you include `lastUpdatedAfter` in the request, `lastUpdatedBefore` is optional, and if provided must be equal to or after the `lastUpdatedAfter` date and at least two minutes before the time of the request. If `lastUpdatedBefore` is provided, neither `createdAfter` nor `createdBefore` may be provided.

    marketplaceIds?: string[]

    The response includes orders that were placed in marketplaces you include in this list. Refer to Marketplace IDs for a complete list of `marketplaceId` values.

    maxResultsPerPage?: number

    The maximum number of orders that can be returned per page. The value must be between 1 and 100. Default: 100.

    paginationToken?: string

    Pagination occurs when a request produces a response that exceeds the `maxResultsPerPage`. This means that the response is divided into individual pages. To retrieve the next page, you must pass the `nextToken` value as the `paginationToken` query parameter in the next request. You will not receive a `nextToken` value on the last page.