v2.payment.get_escrow_detail
GET /api/v2/payment/get_escrow_detail
Use this API to fetch the accounting detail of order.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/get_escrow_detail
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | 220914R9U7D3C6 | Shopee's unique identifier for an order. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| response | object | ||
| order_sn | string | 220725D58XURJS | Shopee's unique identifier for an order. |
| buyer_user_name | string | xixxixi | The username of buyer. |
| return_order_sn_list | string[] | [] | The list of the serial number of return. |
| order_income | object | ||
| escrow_amount | float | 100.0 | 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_discount- 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- final_return_to_seller_shipping_fee- seller_transaction_fee- service_fee- commission_fee- campaign_fee- shipping_seller_protection_fee_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 - seller_order_processing_fee + buyer_paid_packaging_fee - trade_in_bonus_by_seller - fbs_fee - ads_escrow_top_up_fee_or_technical_support_fee - th_import_duty For cb sip affiliate shop: escrow_amount=escrow_amount_pri * exchange_rate note: Return refund amount = if adjustable RR, will equal to drc_adjustable_refund |
| buyer_total_amount | float | 99.0 | The snapshot value of total amount that paid by buyer at checkout moment. |
| order_original_price | float | 110.0 | 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 | float | 139.0 | 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_discounted_price | float | 100.0 | 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_selling_price | float | 100.0 | 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. ) |
| order_seller_discount | float | 10.0 | 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. ) |
| bcrs_deposit | float | 0.10 | 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. |
| seller_discount | float | 10.0 | Final sum of each item seller discount of a specific order. (Only display for non cb sip affiliate shop. ) |
| shopee_discount | float | 10.0 | Final sum of each item Shopee discount of a specific order. This amount will Return remaining rebate value to seller. (Only display for non cb sip affiliate order. ) |
| voucher_from_seller | float | 10.0 | Final value of voucher provided by Seller for the order. (Only display for non cb sip affiliate shop. ) |
| voucher_from_shopee | float | 10.0 | Final value of voucher provided by Shopee for the order. (Only display for non cb sip affiliate shop. ) |
| coins | float | 0.0 | This value indicates the total amount offset when the buyer consumed Shopee Coins upon checkout. (Only display for non cb sip affiliate shop. ) |
| buyer_paid_shipping_fee | float | 0.0 | The shipping fee paid by buyer. (Only display for non cb sip affiliate shop. ) |
| buyer_transaction_fee | float | 0.0 | Tansaction fee paid by buyer for the order. (Only display for non cb sip affiliate shop. ) |
| cross_border_tax | float | 0.0 | Amount incurred by Buyer for purchasing items outside of home country or region. Amount may change after Return Refund. (Only display for non cb sip affiliate shop. ) |
| payment_promotion | float | 0.0 | The amount offset via payment promotion. (Only display for non cb sip affiliate shop. ) |
| commission_fee | float | 0.0 | The commission fee charged by Shopee platform if applicable. For cb sip affiliate shop: commission_fee=commission_fee_pri * exchange_rate |
| service_fee | float | 0.0 | Amount charged by Shopee to seller for additional services. For cb sip affiliate shop: service_fee=service_fee_pri * exchange_rate For tw shop, there will be pre-order service fee included |
| seller_transaction_fee | float | 0.0 | Tansaction fee paid by seller for the order. (Only display for non cb sip affiliate shop. ) |
| seller_lost_compensation | float | 0.0 | Compensation to seller in case of lost parcel. (Only display for non cb sip affiliate shop. ) |
| seller_coin_cash_back | float | 0.0 | Value of coins provided by Seller for purchasing with his or her store for the order. (Only display for non cb sip affiliate shop. ) |
| escrow_tax | float | 0.0 | Cross-border tax imposed by the Indonesian government on sellers. (Only display for non cb sip affiliate shop. ) |
| estimated_shipping_fee | float | 10.0 | 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. ) |
| final_shipping_fee | float | -10.0 | 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. ) |
| actual_shipping_fee | float | 10.0 | 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. ) |
| shipping_fee_sst | float | 0.1 | 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) |
| order_chargeable_weight | int32 | 500 | For CB shop, display weight used to calculate actual_shipping_fee for this order. |
| shopee_shipping_rebate | float | 0.0 | The platform shipping subsidy to the seller. (Only display for non cb sip affiliate shop. ) |
| shipping_fee_discount_from_3pl | float | 0.0 | The discount of shipping fee from 3PL. Currently only applicable to ID. (Only display for non cb sip affiliate shop. ) |
| seller_shipping_discount | float | 0.0 | The shipping discount defined by seller. (Only display for non cb sip affiliate shop. ) |
| seller_voucher_code | string[] | [] | The list of voucher code provided by seller. (Only display for non cb sip affiliate shop. ) |
| drc_adjustable_refund | float | 0.0 | The adjustable refund amount from Shopee Dispute Resolution Center. |
| cost_of_goods_sold | float | 1.0 | Final amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. ) |
| original_cost_of_goods_sold | float | 0.0 | Amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. ) |
| original_shopee_discount | float | 0.0 | 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. ) |
| seller_return_refund | float | 0.0 | Amount returned to Seller in the event of Partial Return. |
| items | object[] | This object contains the detailed breakdown for all the items in this order, including regular items(non-activity) and activity items. | |
| item_id | int64 | 800062998 | ID of item |
| item_name | string | Product | 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. | |
| model_id | int64 | 0 | 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 | float | 139.0 | 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 | float | 110.0 | The agreed settlement price of items used as settlement basis, amount is in the primary currency. (Only display for CB SIP affiliate shop.) |
| selling_price | float | 100.0 | 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.) |
| discounted_price | float | 99.0 | 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. |
| bcrs_deposit | float | 0.10 | 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. |
| seller_discount | float | 10.0 | The discount provided by seller for this item |
| shopee_discount | float | 10.0 | 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. ) |
| discount_from_coin | float | 0.0 | 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_shopee | float | 10.0 | The offset of this item when the buyer use Shopee voucher. |
| discount_from_voucher_seller | float | 10.0 | The offset of this item when the buyer use seller-specific voucher. |
| activity_type | string | bundle_deal | 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" |
| activity_id | int64 | 0 | If bundle_deal the is id of bundle deal, if add_on_deal this is id of add on deal. |
| is_main_item | boolean | false | Meaning a main or sub item for add_on_deal. |
| quantity_purchased | int32 | 1 | This value indicates the number of identical items purchased at the same time by the same buyer from one listing/item. |
| is_b2c_shop_item | boolean | false | Indicates whether this is a B2C owned item. |
| ams_commission_fee | float | 0.0 | The amount of affiliate commission fee. Applicable for items sold via the Affiliate Program. |
| is_kit | boolean | Indicates if this item is a kit. (only for BR local seller) | |
| kit_items | object | only applicable for BR local seller | |
| mt_item_id | float | The merchant item identifier of the product within the kit (only for BR local seller) | |
| mt_model_id | float | The merchant product model of the item within the kit. (only for BR local seller) | |
| total_qty | float | The quantity of this specific component within the kit. (only for BR local seller) | |
| parent_item_price | float | The price of the item when it is listed as a standalone item. (only for BR local seller) | |
| item_price_prorated | float | The price of the item when it is listed within the kit (i.e. proportionally distributed) (only for BR local seller) | |
| promotion_list | object[] | ||
| promotion_type | string | seller_discount | Indicates the type of item- or package-level promotion applied to a product. Each item can be associated with at most one item promotion and one package promotion at a time. Item Promotions: low_price_promotion deep_discount platform_sale seller_discount flash_sale wholesale welcome_package_free_gift brand_flash_sale in_shop_flash_sale synced_promo platform_streaming_price seller_streaming_price exclusive_streamer_price price_bidding_with_rebate price_bidding_without_rebate seller_advisor_price selling_price settlement_price campaign_settlement_price local_sip_settlement_price platform_exclusive_price seller_exclusive_price seller_member_exclusive_sku item_price order_sync_price Package Promotions: bundle_deal add_on_deal_main add_on_deal_sub |
| promotion_id | int64 | 848474823 | Represents the unique identifier of a specific promotion applied to an item. Each promotion_id corresponds to a distinct promotion rule or campaign, defined under a particular promotion_type. The value is expressed in a numeric string format. |
| escrow_amount_pri | float | 0.0 | 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. ) |
| buyer_total_amount_pri | float | 0.0 | The total amount that paid by buyer in the primary currency. (Only display for cb sip affiliate order. ) |
| original_price_pri | float | 0.0 | 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. ) |
| seller_return_refund_pri | float | 0.0 | Amount returned to Seller in the event of Partial Return in the primary currency. (Only display for cb sip affiliate shop. ) |
| commission_fee_pri | float | 0.0 | The commission fee charged by Shopee platform if applicable in the primary currency. (Only display for cb sip affiliate shop. ) |
| service_fee_pri | float | 0.0 | Amount charged by Shopee to seller for additional services in the primary currency. (Only display for cb sip affiliate shop. ) |
| drc_adjustable_refund_pri | float | 0.0 | The adjustable refund amount from Shopee Dispute Resolution Center in the primary currency after proration. (Only applicable for cb sip affiliate shop.) |
| pri_currency | string | 0.0 | The currency of the country or region where the shop that real seller operates. (Only display for cb sip affiliate shop. ) |
| aff_currency | string | 0.0 | The currency of the country or region where shop opened in. (Only display for cb sip affiliate shop. ) |
| exchange_rate | float | 0.0 | Exchange rate from primary shop currency to affiliate shop currency. |
| reverse_shipping_fee | float | 0.0 | Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative. |
| reverse_shipping_fee_sst | float | 0.1 | 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) |
| final_product_protection | float | 0.0 | The total amount of product protection purchased during placing an order. |
| credit_card_promotion | float | 0.0 | This value indicate the offset via credit card promotion. |
| credit_card_transaction_fee | float | 0.0 | This value indicate the total transaction fee. credit_card_transaction_fee=buyer_transaction_fee+seller_transaction_fee |
| final_product_vat_tax | float | 0.0 | Value-added Tax is required for online purchases based on EU Value-added Tax regulations . (Only display for non cb sip affiliate shop. ) |
| final_shipping_vat_tax | float | 0.0 | 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. ) |
| campaign_fee | float | 0.0 | The campaign fee charged by Shopee platform. Only available for some local Indonesian shops. |
| sip_subsidy | float | 0.57 | 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 | float | 2.8 | 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) |
| rsf_seller_protection_fee_claim_amount | float | 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 claim will be updated if there's any RR/cancellation | |
| shipping_seller_protection_fee_amount | float | Service fee charged to seller in MY,ID,PH Local (as per Jun 2024) due to additional program purchased. | |
| final_escrow_product_gst | float | 4.35 | 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 | float | 0.07 | 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.) |
| delivery_seller_protection_fee_premium_amount | float | 0.0 | [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. |
| order_adjustment | object[] | Order level adjustment transaction information. If the order without adjustment, no returned of the field. | |
| amount | float | 10.1 | adjustment transaction amount. |
| date | timestamp | 1688107565 | adjustment transaction complete date. |
| currency | string | TWD | order level adjustment transaction's currency type. |
| adjustment_reason | string | Reason for adjustment. Possible cases could be: - Return Refund deduction or compensation - logistic issue deduction or compensation - marketing fee deduction - payment related fee | |
| total_adjustment_amount | float | 10.1 | Total adjustment made to the order. |
| escrow_amount_after_adjustment | float | 110.1 | Final income seller can get from this order after deduct the order-level adjustment. |
| order_ams_commission_fee | float | 0.0 | The amount of affiliate commission fee for this order. Applicable for orders sold via the Affiliate Program. |
| buyer_payment_method | string | Credit Card/Debit Card | The payment method buyer used when do the order checkout. |
| instalment_plan | string | N/A | The instalment plan buyer chosen when do the order checkout. Only applicable when payment method support instalment. |
| sales_tax_on_lvg | float | 0.99 | 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) |
| final_return_to_seller_shipping_fee | float | 0.0 | The amount of fee charged to seller (if any) for the failed delivery order. |
| withholding_tax | float | 0.0 | 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. |
| overseas_return_service_fee | float | 0.0 | This is overseas return service fee charged to sellers who register ORS program.(Only applicable for non cb sip affiliate shop) |
| prorated_coins_value_offset_return_items | float | 0.0 | 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_shopee_voucher_offset_return_items | float | 0.0 | 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. |
| prorated_seller_voucher_offset_return_items | float | 0.0 | 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_payment_channel_promo_bank_offset_return_items | float | 0.0 | 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 | float | 0.0 | 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. |
| fsf_seller_protection_fee_claim_amount | float | 0.0 | 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. |
| vat_on_imported_goods | float | 0.0 | 7% VAT is charged for imported goods entering Thailand. 8% VAT is charged for imported goods entering Vietnam |
| tenure_info_list | object | ||
| payment_channel_name | string | Name of the payment channel that buyer used in checkout. | |
| instalment_plan | string | Tenure information. This will have value if payment channel used has tenure information, such as credit card. | |
| withholding_vat_tax | float | 1.0 | By VN law, E-commerce platforms need to Withhold VAT tax applicable to all VN business household and VN individual sellers |
| withholding_pit_tax | float | 2.0 | By VN law, E-commerce platforms need to Withhold Personal Income Tax applicable to all VN business household and VN individual sellers |
| tax_registration_code | string | 8881234567-888 | 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 |
| seller_order_processing_fee | float | 3.0 | Order Processing Fee is the amount charged to sellers for every order created. |
| buyer_paid_packaging_fee | float | The fee charged to the buyer for packaging materials | |
| trade_in_bonus_by_seller | float | The discount provided by Seller/ Retailers for buyers who opt for trade-in. | |
| fbs_fee | float | Fulfilled by Shopee (FBS) Fee applied to this order, covering costs such as handling and storage and packaging. Only for PH Local Orders. | |
| net_commission_fee | float | 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_service_fee | float | 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_commission_fee_info_list | object | Returns a breakdown of the net commission fees. -only for BR local sellers. | |
| rule_id | float | The unique identifier of the commission rule applied to calculate the net commission fee. | |
| fee_amount | float | The net commission fee amount calculated based on the corresponding commission rule. | |
| rule_display_name | string | The display name of the commission rule for reference and readability. | |
| net_service_fee_info_list | object | Returns a breakdown of the net service fees. -only for BR local sellers. | |
| rule_id | float | The unique identifier of the service fee rule applied to calculate the net service fee. | |
| fee_amount | float | The net service fee amount calculated based on the corresponding service fee rule. | |
| rule_display_name | string | The display name of the service fee rule for reference and readability. | |
| category | string | The category of the service fee, indicating the type of service the fee is charged for. | |
| seller_product_rebate | object | The shopee rebate borne by seller. -only for BR local sellers. | |
| amount | float | This is the portion of Shopee rebate borne by seller. | |
| commission_fee_offset | float | This is the offset to gross commission fee, reducing it to the net value. | |
| service_fee_offset | float | This is the offset to gross service fee, reducing it to the net value. | |
| pix_discount | float | [BR only]Final sum of pix discount of a specific order. (Only display for non cb sip affiliate shop.) | |
| prorated_pix_discount_offset_return_items | float | [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. | |
| ads_escrow_top_up_fee_or_technical_support_fee | float | 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 Fee For local MY TH SG VN PH ID sellers and CNCB / JPCB / KRCB sellers selling in PH and ID For JPCB sellers selling in SG, MY, TH, and VN Technical Support Fee For CNCB sellers selling in SG, MY, TH, and VN Traffic Growth Fee For KRCB sellers selling in SG, MY, TH, and VN | |
| th_import_duty | float | [TH only] Import Duty collected for imported goods entering Thailand. | |
| buyer_payment_info | object | The buyer payment info at order checkout moment. (snapshot value) | |
| buyer_payment_method | string | The payment method used by buyer. | |
| buyer_service_fee | float | An additional service fee charged by shopee to Buyer at checkout. currently only applicable to ID region. it is an initial value (will not be updated after RR/cancellation) | |
| buyer_tax_amount | float | The tax amount paid by buyer. currently this is a custom tax charged to CB orders in TW,CL,MX | |
| buyer_total_amount | float | The total amount paid by buyer at checkout moment. | |
| credit_card_promotion | float | The promotion provided by credit card. it is an initial value (will not be updated after RR/cancellation) | |
| icms_tax_amount | float | The icms tax paid by buyer. this is only applicable to BR region it is an initial value (will not be updated after RR/cancellation) | |
| import_tax_amount | float | The import tax paid by buyer. it is an initial value (will not be updated after RR/cancellation) | |
| initial_buyer_txn_fee | float | Transaction fee paid by buyer for the order. (Only display for non cb sip affiliate shop. ). Most regions would have this fee charged to buyer at checkout depending on the fee rules applied in each region. it is an initial value (will not be updated after RR/cancellation) | |
| insurance_premium | float | The insurance premium paid by buyer. Currently only applicable to some regions like PH, MY, ID, VN, SG and TH it is an initial value (will not be updated after RR/cancellation) | |
| iof_tax_amount | float | The iof tax paid by buyer. it is an initial value (will not be updated after RR/cancellation) | |
| is_paid_by_credit_card | boolean | false | Whether this order is paid by credit card. it's related to payment channel used at checkout. Value: false,true |
| merchant_subtotal | float | The total item price paid by buyer at checkout. it is an initial value and will not be updated after RR/cancellation | |
| seller_voucher | float | The voucher provided by seller to offset some value needs to be paid by buyer. it is an initial value (will not be updated after RR/cancellation) | |
| shipping_fee | float | The shipping fee paid by buyer. (Only display for non cb sip affiliate shop. it is an initial value (will not be updated after RR/cancellation) | |
| shipping_fee_sst_amount | float | The shipping fee sst paid by buyer. Currently apply to MY region only it is an initial value (will not be updated after RR/cancellation) | |
| shopee_voucher | float | The voucher provided by Shopee to offset the amount need to be paid by buyer. it is an initial value (will not be updated after RR/cancellation) | |
| shopee_coins_redeemed | float | This is an amount of coin used by buyer at checkout to offset some amount to be paid. it is an initial value (will not be updated after RR/cancellation) | |
| buyer_paid_packaging_fee | float | The fee charged to the buyer for packaging materials | |
| trade_in_bonus | float | The total amount of all trade-in bonuses applied to a transaction. This value is the summation of the bonuses contributed by all four parties: Shopee, Seller, Bank and Trade-in Partner. | |
| bulky_handling_fee | float | A fee charged to the buyer for the special handling and transportation required for items that exceed a specified weight or dimension threshold. Only for ID local seller | |
| discount_pix | float | The discount provided by PIX (Only applicable for BR region) | |
| bcrs_deposit | float | 0.10 | 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. |
| request_id | string | 10fff653c945a390f8e1323c6bdffff4 | The identifier for an API request for error tracking. |
| error | string | Error code | |
| message | string | Error message |