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

    Interface ListOfferMetricsRequestFilters

    Use these parameters to filter results. Any result must match all provided parameters. For parameters that accept multiple values (arrays), the API returns results that match at least one value in the array.

    interface ListOfferMetricsRequestFilters {
        aggregationFrequency?: AggregationFrequency;
        asins?: Set<string>;
        brandNames?: Set<string>;
        fulfillmentChannelTypes?: Set<FulfillmentChannelType>;
        marketplaceId: string;
        productGroups?: Set<string>;
        programTypes: Set<"SUBSCRIBE_AND_SAVE">;
        skus?: Set<string>;
        timeInterval: TimeInterval;
        timePeriodType: TimePeriodType;
    }
    Index

    Properties

    aggregationFrequency? asins? brandNames? fulfillmentChannelTypes? marketplaceId productGroups? programTypes skus? timeInterval timePeriodType

    Properties

    aggregationFrequency?: AggregationFrequency
    asins?: Set<string>

    A list of Amazon Standard Identification Numbers (ASINs) to filter by.

    brandNames?: Set<string>

    [Applicable only for US marketplace] A list of brand names to filter by.

    fulfillmentChannelTypes?: Set<FulfillmentChannelType>

    [Applicable only for Sellers] The fulfillment channel types to filter by.

    marketplaceId: string

    The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE, and JP. The supported marketplaces for vendors only are BR, AU, MX, AE, and NL. Refer to Marketplace IDs to find the identifier for the marketplace.

    productGroups?: Set<string>

    [Applicable only for Vendors] A list of product group names to filter by.

    programTypes: Set<"SUBSCRIBE_AND_SAVE">

    A list of replenishment program types.

    skus?: Set<string>

    [Applicable only for Sellers] A list of SKUs to filter by.

    timeInterval: TimeInterval
    timePeriodType: TimePeriodType

    Settings

    Member Visibility

    On This Page

    Properties