Interface ReplenishmentApiModelGetSellingPartnerMetricsRequest

The request body for the getSellingPartnerMetrics operation.

Export

GetSellingPartnerMetricsRequest

interface ReplenishmentApiModelGetSellingPartnerMetricsRequest {
    aggregationFrequency?:
        | "WEEK"
        | "MONTH"
        | "QUARTER"
        | "YEAR"
        | ReplenishmentApiModelAggregationFrequency;
    marketplaceId: string;
    metrics?: (
        | ReplenishmentApiModelMetric
        | "SHIPPED_SUBSCRIPTION_UNITS"
        | "TOTAL_SUBSCRIPTIONS_REVENUE"
        | "ACTIVE_SUBSCRIPTIONS"
        | "NOT_DELIVERED_DUE_TO_OOS"
        | "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE"
        | "LOST_REVENUE_DUE_TO_OOS"
        | "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS"
        | "COUPONS_REVENUE_PENETRATION"
        | "REVENUE_BY_DELIVERIES"
        | "SUBSCRIBER_RETENTION"
        | "REVENUE_PENETRATION_BY_SELLER_FUNDING"
        | "SHARE_OF_COUPON_SUBSCRIPTIONS"
    )[];
    programTypes: (SubscribeAndSave | "SUBSCRIBE_AND_SAVE")[];
    timeInterval: ReplenishmentApiModelTimeInterval;
    timePeriodType:
        | ReplenishmentApiModelTimePeriodType
        | "PERFORMANCE"
        | "FORECAST";
}

Properties

aggregationFrequency? marketplaceId metrics? programTypes timeInterval timePeriodType

Properties

OptionalaggregationFrequency

aggregationFrequency?:
    | "WEEK"
    | "MONTH"
    | "QUARTER"
    | "YEAR"
    | ReplenishmentApiModelAggregationFrequency

Memberof

GetSellingPartnerMetricsRequest

marketplaceId

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.

Memberof

GetSellingPartnerMetricsRequest

Optionalmetrics

metrics?: (
    | ReplenishmentApiModelMetric
    | "SHIPPED_SUBSCRIPTION_UNITS"
    | "TOTAL_SUBSCRIPTIONS_REVENUE"
    | "ACTIVE_SUBSCRIPTIONS"
    | "NOT_DELIVERED_DUE_TO_OOS"
    | "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE"
    | "LOST_REVENUE_DUE_TO_OOS"
    | "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS"
    | "COUPONS_REVENUE_PENETRATION"
    | "REVENUE_BY_DELIVERIES"
    | "SUBSCRIBER_RETENTION"
    | "REVENUE_PENETRATION_BY_SELLER_FUNDING"
    | "SHARE_OF_COUPON_SUBSCRIPTIONS"
)[]

The list of metrics requested. If no metric value is provided, data for all of the metrics will be returned.

Memberof

GetSellingPartnerMetricsRequest

programTypes

programTypes: (SubscribeAndSave | "SUBSCRIBE_AND_SAVE")[]

A list of replenishment program types.

Memberof

GetSellingPartnerMetricsRequest

timeInterval

timeInterval: ReplenishmentApiModelTimeInterval

Memberof

GetSellingPartnerMetricsRequest

timePeriodType

timePeriodType: ReplenishmentApiModelTimePeriodType | "PERFORMANCE" | "FORECAST"

Memberof

GetSellingPartnerMetricsRequest

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR