Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface ListCasesRequest

    The request body for the listCases operation.

    interface ListCasesRequest {
        caseFilters?: CaseFilters;
        marketplaceId?: string;
        maxResults?: number;
        nextToken?: string;
        sortField?: ListCasesRequestSortFieldEnum;
        sortOrder?: ListCasesRequestSortOrderEnum;
    }
    Index
    caseFilters? marketplaceId? maxResults? nextToken? sortField? sortOrder?
    caseFilters?: CaseFilters
    marketplaceId?: string

    The marketplace identifier used for authorization only. This field does not impact the returned collection. For a list of possible values, refer to Marketplace IDs.

    maxResults?: number

    Maximum number of results to return.

    nextToken?: string

    A token to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. 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.

    sortField?: ListCasesRequestSortFieldEnum

    The field to sort cases by. Defaults to CREATION_DATE when absent.

    sortOrder?: ListCasesRequestSortOrderEnum

    The sort direction. Defaults to DESC when absent.

    Settings
    Member Visibility

    On This Page
    Properties