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

    Interface GetEscrowDetailItem

    GetEscrowDetailItem sub-interface for GetEscrowDetailOrderIncome

    interface GetEscrowDetailItem {
        activity_id?: any;
        activity_type?: string;
        ams_commission_fee?: number;
        bcrs_deposit?: number;
        discount_from_coin?: number;
        discount_from_voucher_seller?: number;
        discount_from_voucher_shopee?: number;
        discounted_price?: number;
        is_b2c_shop_item?: boolean;
        is_kit?: boolean;
        is_main_item?: boolean;
        item_id?: number;
        item_name?: string;
        item_sku?: string;
        kit_items?: GetEscrowDetailKitItem;
        line_item_id?: number;
        model_id?: number;
        model_name?: string;
        model_sku?: string;
        original_price?: number;
        original_price_pri?: number;
        promotion_list?: GetEscrowDetailPromotion[];
        quantity_purchased?: number;
        seller_discount?: number;
        selling_price?: number;
        shopee_discount?: number;
    }
    Index

    Properties

    activity_id? activity_type? ams_commission_fee? bcrs_deposit? discount_from_coin? discount_from_voucher_seller? discount_from_voucher_shopee? discounted_price? is_b2c_shop_item? is_kit? is_main_item? item_id? item_name? item_sku? kit_items? line_item_id? model_id? model_name? model_sku? original_price? original_price_pri? promotion_list? quantity_purchased? seller_discount? selling_price? shopee_discount?

    Properties

    activity_id?: any

    If bundle_deal the is id of bundle deal, if add_on_deal this is id of add on deal.

    activity_type?: string

    The type of the item, default is "". If the item is a bundle item the value is "bundle_deal", and if a add on deal item, the value is "add_on_deal"

    ams_commission_fee?: number

    The amount of affiliate commission fee. Applicable for items sold via the Affiliate Program.

    bcrs_deposit?: number

    The deposit fee paid by buyer of $0.10 per container as part of the SG Beverage Container Return Scheme mandated by the National Environment Agency (NEA). This will be an initial value and will not update after RR/cancellation.

    discount_from_coin?: number

    The offset of this item when the buyer consumed Shopee Coins upon checkout. In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0.

    discount_from_voucher_seller?: number

    The offset of this item when the buyer use seller-specific voucher.

    discount_from_voucher_shopee?: number

    The offset of this item when the buyer use Shopee voucher.

    discounted_price?: number

    The after-discount price of the item in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1. If there is no discount, this value will be the same as that of original_price.

    is_b2c_shop_item?: boolean

    Indicates whether this is a B2C owned item.

    is_kit?: boolean

    Indicates if this item is a kit. (only for BR local seller)

    is_main_item?: boolean

    Meaning a main or sub item for add_on_deal.

    item_id?: number

    ID of item

    item_name?: string

    Name of item

    item_sku?: string

    A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.

    kit_items?: GetEscrowDetailKitItem

    only applicable for BR local seller

    line_item_id?: number

    The identity of order item. In case the order item is a bundle deal, this value will be unique to distinguish the order item.

    model_id?: number

    ID of the model that belongs to the same item.

    model_name?: string

    Name of the model that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.

    model_sku?: string

    A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.

    original_price?: number

    The original price of the item before ANY promotion/discount in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1.

    original_price_pri?: number

    The agreed settlement price of items used as settlement basis, amount is in the primary currency. (Only display for CB SIP affiliate shop.)

    promotion_list?: GetEscrowDetailPromotion[]
    quantity_purchased?: number

    This value indicates the number of identical items purchased at the same time by the same buyer from one listing/item.

    seller_discount?: number

    The discount provided by seller for this item

    selling_price?: number

    For non-bundle deal case, this value will be same like item original_price; For bundle deal case, this value will be price of sum of item price before bundle deal promo but after item promo. It returns the subtotal of that specific item if quantity exceeds 1 (Only display for non cb sip affiliate shop.)

    shopee_discount?: number

    Final sum of each item Shopee discount of a specific order. This amount will return remaining rebate value (i.e. remaining Shopee Item Rebate + remaining Shopee PIX Rebate) to seller. (Only display for non cb sip affiliate order. )

    Settings

    Member Visibility

    On This Page

    Properties