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

    Interface ExternalFulfillmentReturnsApiListReturnsRequest

    Request parameters for listReturns operation in ExternalFulfillmentReturnsApi.

    interface ExternalFulfillmentReturnsApiListReturnsRequest {
        createdSince?: string;
        createdUntil?: string;
        lastUpdatedAfter?: string;
        lastUpdatedBefore?: string;
        lastUpdatedSince?: string;
        lastUpdatedUntil?: string;
        maxResults?: number;
        nextToken?: string;
        returnLocationId?: string;
        reverseTrackingId?: string;
        rmaId?: string;
        status?: ListReturnsStatusEnum;
    }
    Index

    Properties

    createdSince? createdUntil? lastUpdatedAfter? lastUpdatedBefore? lastUpdatedSince? lastUpdatedUntil? maxResults? nextToken? returnLocationId? reverseTrackingId? rmaId? status?

    Properties

    createdSince?: string

    Return items created after the specified date are included in the response. In ISO 8601 date-time format.

    createdUntil?: string

    Return items created before the specified date are included in the response. In ISO 8601 date-time format.

    lastUpdatedAfter?: string

    DEPRECATED. Use the `createdSince` parameter.

    lastUpdatedBefore?: string

    DEPRECATED. Use the `createdUntil` parameter.

    lastUpdatedSince?: string

    Return items updated after the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.

    lastUpdatedUntil?: string

    Return items whose most recent update is before the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.

    maxResults?: number

    The number of return items you want to include in the response. Default: 10 Maximum: 100

    nextToken?: 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.

    returnLocationId?: string

    The SmartConnect location ID of the location from which you want to retrieve return items.

    reverseTrackingId?: string

    The reverse tracking ID of the return items you want to list.

    rmaId?: string

    The RMA ID of the return items you want to list.

    status?: ListReturnsStatusEnum

    The status of return items you want to list. You can retrieve all new return items with the `CREATED` status.

    Settings

    Member Visibility

    On This Page

    Properties