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

    Interface GetEscrowDetailBatchOrderIncome

    GetEscrowDetailBatchOrderIncome sub-interface for GetEscrowDetailBatchEscrowDetail

    interface GetEscrowDetailBatchOrderIncome {
        actual_shipping_fee?: number;
        ads_escrow_top_up_fee_or_technical_support_fee?: number;
        aff_currency?: string;
        bcrs_deposit?: number;
        buyer_paid_packaging_fee?: number;
        buyer_payment_method?: number;
        buyer_total_amount_pri?: number;
        campaign_fee?: number;
        coins?: number;
        commission_fee?: number;
        commission_fee_pri?: number;
        cost_of_goods_sold?: number;
        credit_card_promotion?: number;
        credit_card_transaction_fee?: number;
        cross_border_tax?: number;
        delivery_seller_protection_fee_premium_amount?: number;
        drc_adjustable_refund?: number;
        drc_adjustable_refund_pri?: number;
        escrow_amount?: number;
        escrow_amount_pri?: number;
        escrow_tax?: number;
        estimated_shipping_fee?: number;
        exchange_rate?: number;
        fbs_fee?: number;
        final_escrow_product_gst?: number;
        final_escrow_shipping_gst?: number;
        final_product_protection?: number;
        final_product_vat_tax?: number;
        final_return_to_seller_shipping_fee?: number;
        final_shipping_fee?: number;
        final_shipping_vat_tax?: number;
        fsf_seller_protection_fee_claim_amount?: number;
        instalment_plan?: number;
        items?: GetEscrowDetailBatchItem[];
        net_commission_fee?: number;
        net_commission_fee_info_list?: GetEscrowDetailBatchNetCommissionFeeInfo[];
        net_service_fee?: number;
        net_service_fee_info_list?: GetEscrowDetailBatchNetServiceFeeInfo[];
        order_ams_commission_fee?: number;
        order_discounted_price?: number;
        order_original_price?: number;
        order_seller_discount?: number;
        order_selling_price?: number;
        original_cost_of_goods_sold?: number;
        original_price?: number;
        original_price_pri?: number;
        original_shopee_discount?: number;
        overseas_return_service_fee?: number;
        payment_promotion?: number;
        pix_discount?: number;
        pri_currency?: string;
        prorated_coins_value_offset_return_items?: number;
        prorated_payment_channel_promo_bank_offset_return_items?: number;
        prorated_payment_channel_promo_shopee_offset_return_items?: number;
        prorated_pix_discount_offset_return_items?: number;
        prorated_seller_voucher_offset_return_items?: number;
        prorated_shopee_voucher_offset_return_items?: number;
        refund_amount_to_buyer?: number;
        remaining_voucher?: number;
        reverse_shipping_fee?: number;
        reverse_shipping_fee_sst?: number;
        rsf_seller_protection_fee_claim_amount?: number;
        rsf_seller_protection_fee_premium_amount?: number;
        sales_tax_on_lvg?: number;
        seller_coin_cash_back?: number;
        seller_discount?: number;
        seller_lost_compensation?: number;
        seller_order_processing_fee?: number;
        seller_product_rebate?: GetEscrowDetailBatchSellerProductRebate;
        seller_return_refund_pri?: number;
        seller_shipping_discount?: number;
        seller_transaction_fee?: number;
        seller_voucher_code?: number;
        service_fee?: number;
        service_fee_pri?: number;
        shipping_fee_discount_from_pl?: number;
        shipping_fee_sst?: number;
        shipping_seller_protection_fee_amount?: number;
        shopee_discount?: number;
        shopee_shipping_rebate?: number;
        sip_subsidy?: number;
        sip_subsidy_pri?: number;
        tax_registration_code?: string;
        th_import_duty?: number;
        trade_in_bonus_seller?: number;
        vat_on_imported_goods?: number;
        voucher_from_external_party?: number;
        voucher_from_seller?: number;
        voucher_from_shopee?: number;
        withholding_cit_tax?: number;
        withholding_pit_tax?: number;
        withholding_tax?: number;
        withholding_vat_tax?: number;
    }
    Index

    Properties

    actual_shipping_fee? ads_escrow_top_up_fee_or_technical_support_fee? aff_currency? bcrs_deposit? buyer_paid_packaging_fee? buyer_payment_method? buyer_total_amount_pri? campaign_fee? coins? commission_fee? commission_fee_pri? cost_of_goods_sold? credit_card_promotion? credit_card_transaction_fee? cross_border_tax? delivery_seller_protection_fee_premium_amount? drc_adjustable_refund? drc_adjustable_refund_pri? escrow_amount? escrow_amount_pri? escrow_tax? estimated_shipping_fee? exchange_rate? fbs_fee? final_escrow_product_gst? final_escrow_shipping_gst? final_product_protection? final_product_vat_tax? final_return_to_seller_shipping_fee? final_shipping_fee? final_shipping_vat_tax? fsf_seller_protection_fee_claim_amount? instalment_plan? items? net_commission_fee? net_commission_fee_info_list? net_service_fee? net_service_fee_info_list? order_ams_commission_fee? order_discounted_price? order_original_price? order_seller_discount? order_selling_price? original_cost_of_goods_sold? original_price? original_price_pri? original_shopee_discount? overseas_return_service_fee? payment_promotion? pix_discount? pri_currency? prorated_coins_value_offset_return_items? prorated_payment_channel_promo_bank_offset_return_items? prorated_payment_channel_promo_shopee_offset_return_items? prorated_pix_discount_offset_return_items? prorated_seller_voucher_offset_return_items? prorated_shopee_voucher_offset_return_items? refund_amount_to_buyer? remaining_voucher? reverse_shipping_fee? reverse_shipping_fee_sst? rsf_seller_protection_fee_claim_amount? rsf_seller_protection_fee_premium_amount? sales_tax_on_lvg? seller_coin_cash_back? seller_discount? seller_lost_compensation? seller_order_processing_fee? seller_product_rebate? seller_return_refund_pri? seller_shipping_discount? seller_transaction_fee? seller_voucher_code? service_fee? service_fee_pri? shipping_fee_discount_from_pl? shipping_fee_sst? shipping_seller_protection_fee_amount? shopee_discount? shopee_shipping_rebate? sip_subsidy? sip_subsidy_pri? tax_registration_code? th_import_duty? trade_in_bonus_seller? vat_on_imported_goods? voucher_from_external_party? voucher_from_seller? voucher_from_shopee? withholding_cit_tax? withholding_pit_tax? withholding_tax? withholding_vat_tax?

    Properties

    actual_shipping_fee?: number

    The final shipping cost of order and it is positive. For Non-integrated logistics channel is 0. (Only display for non cb sip affiliate shop. )

    ads_escrow_top_up_fee_or_technical_support_fee?: number

    Includes both ads escrow top up fee (auto escrow top up to your ads balance) and technical support fee (charged by Shopee)The actual fee type included in this field varies depending on the seller type and selling region, and may represent one of the following in Shopee Seller Center:Ads Escrow Top-Up FeeFor local MY TH SG VN PH ID sellers and CNCB / JPCB / KRCB sellers selling in PH and IDFor JPCB sellers selling in SG, MY, TH, and VNTechnical Support FeeFor CNCB sellers selling in SG, MY, TH, and VNTraffic Growth FeeFor KRCB sellers selling in SG, MY, TH, and VN

    aff_currency?: string

    The currency of the country or region where shop opened in. (Only display for cb sip affiliate shop. )

    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 value might be updated after RR/cancellation.

    buyer_paid_packaging_fee?: number

    The fee charged to the buyer for packaging materials.

    buyer_payment_method?: number

    The payment method buyer used when do the order checkout.

    buyer_total_amount_pri?: number

    The total amount that paid by buyer in the primary currency. (Only display for cb sip affiliate order. )

    campaign_fee?: number

    The campaign fee charged by Shopee platform. Only available for some local Indonesian shops.

    coins?: number

    This value indicates the total amount offset when the buyer consumed Shopee Coins upon checkout. (Only display for non cb sip affiliate shop. )

    commission_fee?: number

    The commission fee charged by Shopee platform if applicable.For CB SIP affiliate shop: commission_fee=commission_fee_pri * exchange_rate

    commission_fee_pri?: number

    The commission fee charged by Shopee platform if applicable in the primary currency. (Only display for cb sip affiliate shop. )

    cost_of_goods_sold?: number

    Final amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. )

    credit_card_promotion?: number

    This value indicate the offset via credit card promotion.

    credit_card_transaction_fee?: number

    This value indicate the total transaction fee.credit_card_transaction_fee=buyer_transaction_fee+seller_transaction_fee

    cross_border_tax?: number

    Amount incurred by Buyer for purchasing items outside of home country. Amount may change after Return Refund. (Only display for non cb sip affiliate shop. )

    delivery_seller_protection_fee_premium_amount?: number

    [Currently apply to ID & local orders only] An insurance premium charged to seller at the time parcel is picked up by 3PL for insurance in case of parcel lost/damaged by 3PL.

    drc_adjustable_refund?: number

    The adjustable refund amount from Shopee Dispute Resolution Center.

    drc_adjustable_refund_pri?: number

    The adjustable refund amount from Shopee Dispute Resolution Center in the primary currency after proration. (Only applicable for cb sip affiliate shop.)

    escrow_amount?: number

    The total amount that the seller is expected to receive for the order and will change before order is completed. For non cb sip affiliate shop (new formula): escrow_amount= original_cost_of_goods_sold-original_shopee_discount+seller_return_refund+ shopee_discounts- voucher_from_seller- seller_coin_cash_back+ buyer_paid_shipping_fee- actual_shipping_fee+ shopee_shipping_rebate+ shipping_fee_discount_from_3pl- reverse_shipping_fee+ rsf_seller_protection_fee_claim_amount+ fsf_seller_protection_fee_claim_amount- final_return_to_seller_shipping_fee- seller_transaction_fee- service_fee- commission_fee- campaign_fee- shipping_seller_protection_fee_premium_amount- delivery_seller_protection_fee_premium_amount-final_escrow_product_gst- order_ams_commission fee- escrow_tax-sales_tax_on_lvg-reverse_shipping_fee_sst-shipping_fee_sst-withholding_tax-overseas_return_service_fee-vat_on_imported_goods - withholding_vat_tax - withholding_pit_tax - withholding_cit_tax - seller_order_processing_fee + buyer_paid_packaging_fee - trade_in_bonus_seller - fbs_fee - ads_escrow_top_up_fee_or_technical_support_fee - th_import_dutyFor cb sip affiliate shop: escrow_amount=escrow_amount_pri * exchange_ratenote: Return refund amount = if adjustable RR, will equal to drc_adjustable_refund

    escrow_amount_pri?: number

    The total amount in the prim currency that the seller is expected to receive for the order and will change before order completed . escrow_amount_pri=original_price_pri-seller_return_refund_pri-commission_fee_pri-service_fee_pri-drc_adjustable_refund_pri.(Only display for cb sip affiliate order. )

    escrow_tax?: number

    Cross-border tax imposed by the Indonesian government on sellers. (Only display for non cb sip affiliate shop. )

    estimated_shipping_fee?: number

    The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard. (Only display for non cb sip affiliate shop. )

    exchange_rate?: number

    Exchange rate from primary shop currency to affiliate shop currency.

    fbs_fee?: number

    Fulfilled by Shopee (FBS) Fee applied to this order, covering costs such as handling and storage and packaging. Only for PH Local Orders.

    final_escrow_product_gst?: number

    Goods and Service Tax for product price is required for imported goods (overseas orders) based on Singapore GST regulations. (Only applicable for non cb sip affiliate shop selling in Singapore)

    final_escrow_shipping_gst?: number

    Goods and Service Tax for shipping fee is required for imported goods (overseas orders) based on Singapore GST regulations. (Only applicable for non cb sip affiliate shop selling in Singapore.)

    final_product_protection?: number

    The total amount of product protection purchased during placing an order.

    final_product_vat_tax?: number

    Value-added Tax is required for online purchases based on EU Value-added Tax regulations . (Only display for non cb sip affiliate shop. )

    final_return_to_seller_shipping_fee?: number

    The amount of fee charged to seller (if any) for the failed delivery order

    final_shipping_fee?: number

    Final adjusted amount that seller has to bear as part of escrow. This amount could be negative or positive. (Only display for non cb sip affiliate shop. )

    final_shipping_vat_tax?: number

    Value-added Tax for product price is required for online purchases based on EU Value-added Tax regulations. (Only applicable for non cb sip affiliate shop. )

    fsf_seller_protection_fee_claim_amount?: number

    The claim amount given to seller if seller opt in to shipping fee service program. this covers Forward Shipping Fee cost in the case of cancelled due to Failed delivery. only apply to PH Local as per Jun 2024.

    instalment_plan?: number

    The instalment plan buyer chosen when do the order checkout. Only applicable when payment method support instalment.

    This object contains the detailed breakdown for all the items in this order, including regular items(non-activity) and activity items.

    net_commission_fee?: number

    The respective fee amounts after the proportional rebate deduction.The total net commission fee applied to the order, calculated as the sum of all net commission fee items.-only for BR local sellers.

    net_commission_fee_info_list?: GetEscrowDetailBatchNetCommissionFeeInfo[]

    Returns a breakdown of the net commission fees.-only for BR local sellers.

    net_service_fee?: number

    The respective fee amounts after the proportional rebate deduction.The total net service fee applied to the order, calculated as the sum of all net service fee items.-only for BR local sellers.

    net_service_fee_info_list?: GetEscrowDetailBatchNetServiceFeeInfo[]

    Returns a breakdown of the net service fees.-only for BR local sellers.

    order_ams_commission_fee?: number

    The amount of affiliate commission fee for this order. Applicable for orders sold via the Affiliate Program.

    order_discounted_price?: number

    The total discounted price for this order. It returns the subtotal of that specific item if quantity exceeds 1. (Only display for non cb sip affiliate shop. )

    order_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.

    order_seller_discount?: number

    The total discount seller provided for this order. It returns the subtotal of that specific item if quantity exceeds 1. (Only display for non cb sip affiliate shop. )

    order_selling_price?: number

    This field value = sum of item unit price.selling price comes from the sum up of each item's unit price. For non-bundle deal case, this value will be same like order_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. )

    original_cost_of_goods_sold?: number

    Amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. )

    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 original price of the item before ANY promotion/discount in the primary currency. It returns the subtotal of that specific item if quantity exceeds 1.(Only display for cb sip affiliate order. )

    original_shopee_discount?: number

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

    overseas_return_service_fee?: number

    This is overseas return service fee charged to sellers who register ORS program.(Only applicable for non cb sip affiliate shop)

    payment_promotion?: number

    The amount offset via payment promotion. (Only display for non cb sip affiliate shop. )

    pix_discount?: number

    [BR only]Final sum of pix discount of a specific order. (Only display for non cb sip affiliate shop.)

    pri_currency?: string

    The currency of the country or region where the shop that real seller operates. (Only display for cb sip affiliate shop. )

    prorated_coins_value_offset_return_items?: number

    This is the prorated value from cash equivalent of coin offset due to adjustable RR.This field will only be updated when there is an adjustable RR. If it's a full RR or normal order will response 0.

    prorated_payment_channel_promo_bank_offset_return_items?: number

    This is the prorated value from bank payment channel promo due to adjustable RR.This field will only be updated when there is an adjustable RR.If it's a full RR or normal order will response 0.

    prorated_payment_channel_promo_shopee_offset_return_items?: number

    This is the prorated value from shopee payment channel promo due to adjustable RR.This field will only be updated when there is an adjustable RR.If it's a full RR or normal order will response 0.

    prorated_pix_discount_offset_return_items?: number

    [BR only]This is the prorated value from pix discount due to adjustable RR. This field will only be updated when there is an adjustable RR. If it's a full RR or normal order, will response 0.

    prorated_seller_voucher_offset_return_items?: number

    This is the prorated refund value from seller voucher discount due to adjustable RR.This field will only be updated when there is an adjustable RR. If it's a full RR or normal order will response 0.

    prorated_shopee_voucher_offset_return_items?: number

    This is the prorated refund value from shopee voucher discount due to adjustable RR.This field will only be updated when there is an adjustable RR. If it's a full RR or normal order will response 0.

    refund_amount_to_buyer?: number

    Amount returned to Seller in the event of Partial Return.

    remaining_voucher?: number

    [Only for BR local shop]Represents the portion of Shopee voucher that is not consumed after fee offset.

    reverse_shipping_fee?: number

    Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.

    reverse_shipping_fee_sst?: number

    The Service Tax charged on Reverse Shipping Fee for reverse shipping, based on Malaysia SST regulations for shipping fees on all orders. (Only applicable for non cb sip affiliate shop)

    rsf_seller_protection_fee_claim_amount?: number

    The insurance claim amount if seller opt in to insurance program. this covers Reverse shipping Fee in the case of RR. As per Jun 2024:- For ID & MY Local: After Extension on coverage to FSF due to RR. this claim amount will consist of FSF + RSF claim.- For PH local: This will only cover RSF claimwill be updated if there's any RR/cancellation

    rsf_seller_protection_fee_premium_amount?: number

    Amount charged by Shopee to seller for additional services. Only apply for PH local orders.

    sales_tax_on_lvg?: number

    Sales Tax on Low Value Goods (LVG) is required for imported goods (overseas orders) based on Malaysia SST regulations for selective orders (e.g. CB LVG orders in MY)

    seller_coin_cash_back?: number

    Value of coins provided by Seller for purchasing with his or her store for the order. (Only display for non cb sip affiliate shop. )

    seller_discount?: number

    Final sum of each item seller discount of a specific order. (Only display for non cb sip affiliate shop. )

    seller_lost_compensation?: number

    Compensation to seller in case of lost parcel. (Only display for non cb sip affiliate shop. )

    seller_order_processing_fee?: number

    Order Processing Fee is the amount charged to sellers for every order created.

    The shopee rebate borne by seller.-only for BR local sellers.

    seller_return_refund_pri?: number

    Amount returned to Seller in the event of Partial Return in the primary currency. (Only display for cb sip affiliate shop. )

    seller_shipping_discount?: number

    The shipping discount defined by seller. (Only display for non cb sip affiliate shop. )

    seller_transaction_fee?: number

    Tansaction fee paid by seller for the order. (Only display for non cb sip affiliate shop. )

    seller_voucher_code?: number

    The list of voucher code provided by seller. (Only display for non cb sip affiliate shop. )

    service_fee?: number

    Amount charged by Shopee to seller for additional services.For CB SIP affiliate shop: service_fee=service_fee_pri * exchange_rate

    service_fee_pri?: number

    Amount charged by Shopee to seller for additional services in the primary currency. (Only display for cb sip affiliate shop. )

    shipping_fee_discount_from_pl?: number

    The discount of shipping fee from 3PL. Currently only applicable to ID. (Only display for non cb sip affiliate shop. )

    shipping_fee_sst?: number

    The Service Tax charged on Seller Paid Shipping Fee for forward shipping, based on Malaysia SST regulations for shipping fees on all orders. Definition of Seller Paid Shipping Fee is Actual Shipping Fee subtracted by sum of Shipping Fee Paid by Buyer and Shipping Rebate From Shopee. (Only applicable for non cb sip affiliate shop)

    shipping_seller_protection_fee_amount?: number

    Service fee charged to seller in MY,ID,PH,BR Local (as per Jun 2024) due to additional program purchased

    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. )

    shopee_shipping_rebate?: number

    The platform shipping subsidy to the seller. (Only display for non cb sip affiliate shop. )

    sip_subsidy?: number

    The SIP subsidy amount is the difference between the item settlement price set by seller and item price actually paid by buyer. (Only available for CB SIP A Shops)

    sip_subsidy_pri?: number

    The SIP subsidy amount is the difference between the item settlement price set by seller and item price actually paid by buyer. This value is in the primary currency. (Only available for CB SIP A Shops)

    tax_registration_code?: string

    For VN Withholding Tax. This is the Tax Registration Number (TRN) from Seller Info (Business information) of the seller at the point of order creation

    th_import_duty?: number

    [TH only] Import Duty collected for imported goods entering Thailand

    trade_in_bonus_seller?: number

    The discount provided by Seller/Retailers for buyers who opt for trade-in.

    vat_on_imported_goods?: number

    7% VAT is charged for imported goods entering Thailand

    voucher_from_external_party?: number

    Final value of voucher provided by External Party for the order. (Only display for non cb sip affiliate shop.)

    voucher_from_seller?: number

    Final value of voucher provided by Seller for the order. (Only display for non cb sip affiliate shop. )

    voucher_from_shopee?: number

    Final value of voucher provided by Shopee for the order. (Only display for non cb sip affiliate shop. )

    withholding_cit_tax?: number

    By VN law, E-commerce platforms need to Withhold Personal Income Tax applicable to corporate sellers selling in VN region

    withholding_pit_tax?: number

    By VN law, E-commerce platforms need to Withhold Personal Income Tax applicable to all VN business household and VN individual sellers

    withholding_tax?: number

    Only for PH and ID local shops.PH: According to regulations issued by Bureau of Internal Revenue in PH, the Withholding Tax is applied to the gross remittances sent by Shopee to online suppliers of goods and services.ID: According to regulations issued by Directorate General of Taxation in ID, the Withholding Tax is applied to the income stated in the invoice generated via Shopee related to Seller and/or Merchants' sales in Shopee's platform.

    withholding_vat_tax?: number

    By VN law, E-commerce platforms need to Withhold VAT tax applicable to all VN business household and VN individual sellers