Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface GetShopPerformanceMetric

    GetShopPerformanceMetric sub-interface for GetShopPerformanceResponseData

    interface GetShopPerformanceMetric {
        current_period?: number;
        exemption_end_date?: string;
        last_period?: number;
        metric_id?: number;
        metric_name?: string;
        metric_type?: number;
        parent_metric_id?: number;
        target?: GetShopPerformanceTarget;
        unit?: number;
    }
    Index

    Properties

    current_period? exemption_end_date? last_period? metric_id? metric_name? metric_type? parent_metric_id? target? unit?

    Properties

    current_period?: number

    The performance of the metric at current period.

    exemption_end_date?: string

    (Only for whitelist TW sellers) The exemption_end_date value will not be empty if ALL conditions are met: - The shop is in the "POL Shop Whitelist"- Within the "Exemption Period"- The metric_id is 12 (Pre-order Listing %) or 15 (Days of Pre-order Listing Violation)

    last_period?: number

    The performance of the metric at last period.

    metric_id?: number

    ID of metric.If metric_id < 0, it means that this is not a real metric, but a group of metrics.Non-Responded Chats = -1Late Shipment Rate (All Channels) = 1Non-Fulfilment Rate (All Channels) = 3Preparation Time = 4Chat Response Rate = 11Pre-order Listing % = 12Days of Pre-order Listing Violation = 15Response Time = 21Shop Rating = 22No. of Non-Responded Chats = 23Fast Handover Rate = 25On-time Pickup Failure Rate = 27On-time Pickup Failure Rate Violation Value = 28Average Response Time = 29Cancellation Rate (All Channels) = 42Return-refund Rate (All Channels) = 43Severe Listing Violations = 52Other Listing Violations = 53Prohibited Listings = 54Counterfeit/IP infringement = 55Spam Listings = 56Late Shipment Rate (NDD) = 85Non-fulfilment Rate (NDD) = 88Cancellation Rate (NDD) = 91Return-refund Rate (NDD) = 92Customer Satisfaction = 95% SDD Listings = 96% NDD Listings = 97Fast Handover Rate - SLS = 2001Fast Handover Rate - FBS = 2002Fast Handover Rate - 3PF = 2003Poor Quality Products = 2011% HD Listings = 2030% HD Free Shipping Enabled = 2031Saturday Shipment = 2032Preparation Time PS = 2033OTDR Logistic Rate = 2036OTDR DD Rate = 2037

    metric_name?: string

    Default name of metric.

    metric_type?: number

    Type of metric: Fulfillment Performance = 1Listing Performance = 2Customer Service Performance = 3

    parent_metric_id?: number

    ID of parent metric.

    target?: GetShopPerformanceTarget
    unit?: number

    Unit of metric: Number = 1Percentage = 2Second = 3Day = 4Hour = 5

    Settings

    Member Visibility

    On This Page

    Properties