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

    Interface ListingsItemsApiSearchListingsItemsRequest

    Request parameters for searchListingsItems operation in ListingsItemsApi.

    interface ListingsItemsApiSearchListingsItemsRequest {
        createdAfter?: string;
        createdBefore?: string;
        identifiers?: string[];
        identifiersType?: SearchListingsItemsIdentifiersTypeEnum;
        includedData?: SearchListingsItemsIncludedDataEnum[];
        issueLocale?: string;
        lastUpdatedAfter?: string;
        lastUpdatedBefore?: string;
        marketplaceIds: string[];
        packageHierarchySku?: string;
        pageSize?: number;
        pageToken?: string;
        sellerId: string;
        sortBy?: SearchListingsItemsSortByEnum;
        sortOrder?: SearchListingsItemsSortOrderEnum;
        variationParentSku?: string;
        withIssueSeverity?: SearchListingsItemsWithIssueSeverityEnum[];
        withoutStatus?: SearchListingsItemsWithoutStatusEnum[];
        withStatus?: SearchListingsItemsWithStatusEnum[];
    }
    Index

    Properties

    createdAfter? createdBefore? identifiers? identifiersType? includedData? issueLocale? lastUpdatedAfter? lastUpdatedBefore? marketplaceIds packageHierarchySku? pageSize? pageToken? sellerId sortBy? sortOrder? variationParentSku? withIssueSeverity? withoutStatus? withStatus?

    Properties

    createdAfter?: string

    A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in ISO 8601 date-time format.

    createdBefore?: string

    A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in ISO 8601 date-time format.

    identifiers?: string[]

    A comma-delimited list of product identifiers that you can use to search for listings items. Note: 1. This is required when you specify `identifiersType`. 2. You cannot use 'identifiers' if you specify `variationParentSku` or `packageHierarchySku`.

    identifiersType?: SearchListingsItemsIdentifiersTypeEnum

    A type of product identifiers that you can use to search for listings items. Note: This is required when `identifiers` is provided.

    includedData?: SearchListingsItemsIncludedDataEnum[]

    A comma-delimited list of datasets that you want to include in the response. Default: `summaries`.

    issueLocale?: string

    A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". When a localization is not available in the specified locale, localized messages default to "en_US".

    lastUpdatedAfter?: string

    A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in ISO 8601 date-time format.

    lastUpdatedBefore?: string

    A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in ISO 8601 date-time format.

    marketplaceIds: string[]

    A comma-delimited list of Amazon marketplace identifiers for the request.

    packageHierarchySku?: string

    Filter results to include listing items that contain or are contained by the specified SKU. Note: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request.

    pageSize?: number

    The number of results that you want to include on each page.

    pageToken?: string

    A token that you can use to fetch a specific page when there are multiple pages of results.

    sellerId: string

    A selling partner identifier, such as a merchant account or vendor code.

    sortBy?: SearchListingsItemsSortByEnum

    An attribute by which to sort the returned listing items.

    sortOrder?: SearchListingsItemsSortOrderEnum

    The order in which to sort the result items.

    variationParentSku?: string

    Filters results to include listing items that are variation children of the specified SKU. Note: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request.

    withIssueSeverity?: SearchListingsItemsWithIssueSeverityEnum[]

    Filter results to include only listing items that have issues that match one or more of the specified severity levels.

    withoutStatus?: SearchListingsItemsWithoutStatusEnum[]

    Filter results to include only listing items that don't contain the specified statuses.

    withStatus?: SearchListingsItemsWithStatusEnum[]

    Filter results to include only listing items that have the specified status.

    Settings

    Member Visibility

    On This Page

    Properties