v2.payment.get_escrow_detail

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:14:01

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.payment.get_escrow_detail

Use this API to fetch the accounting detail of order.

§2 Overview

Overview

Field	Value
Module	Payment
API type	Shop
HTTP method	GET
Path	/api/v2/payment/get_escrow_detail
Production URL	https://partner.shopeemobile.com/api/v2/payment/get_escrow_detail
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/payment/get_escrow_detail
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Accounting And Finance; Customer Service; Brand Membership; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
order_sn	string	Yes	220914R9U7D3C6	Shopee's unique identifier for an order.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
response	object
response.order_sn	string	220725D58XURJS	Shopee's unique identifier for an order.
response.buyer_user_name	string	xixxixi	The username of buyer.
response.return_order_sn_list	string[]	[]	The list of the serial number of return.
response.order_income	object
response.order_income.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 - withholding_cit_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
response.order_income.buyer_total_amount	float	99.0	The snapshot value of total amount that paid by buyer at checkout moment.
response.order_income.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.
response.order_income.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.
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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.
response.order_income.seller_discount	float	10.0	Final sum of each item seller discount of a specific order. (Only display for non cb sip affiliate shop. )
response.order_income.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. )
response.order_income.voucher_from_seller	float	10.0	Final value of voucher provided by Seller for the order. (Only display for non cb sip affiliate shop. )
response.order_income.voucher_from_shopee	float	10.0	Final value of voucher provided by Shopee for the order. (Only display for non cb sip affiliate shop. )
response.order_income.voucher_from_external_party	float		Final value of voucher provided by External Party for the order. (Only display for non cb sip affiliate shop.)
response.order_income.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. )
response.order_income.buyer_paid_shipping_fee	float	0.0	The shipping fee paid by buyer. (Only display for non cb sip affiliate shop. )
response.order_income.buyer_transaction_fee	float	0.0	Tansaction fee paid by buyer for the order. (Only display for non cb sip affiliate shop. )
response.order_income.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. )
response.order_income.payment_promotion	float	0.0	The amount offset via payment promotion. (Only display for non cb sip affiliate shop. )
response.order_income.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
response.order_income.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
response.order_income.seller_transaction_fee	float	0.0	Tansaction fee paid by seller for the order. (Only display for non cb sip affiliate shop. )
response.order_income.seller_lost_compensation	float	0.0	Compensation to seller in case of lost parcel. (Only display for non cb sip affiliate shop. )
response.order_income.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. )
response.order_income.escrow_tax	float	0.0	Cross-border tax imposed by the Indonesian government on sellers. (Only display for non cb sip affiliate shop. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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)
response.order_income.order_chargeable_weight	int32	500	For CB shop, display weight used to calculate actual_shipping_fee for this order.
response.order_income.shopee_shipping_rebate	float	0.0	The platform shipping subsidy to the seller. (Only display for non cb sip affiliate shop. )
response.order_income.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. )
response.order_income.seller_shipping_discount	float	0.0	The shipping discount defined by seller. (Only display for non cb sip affiliate shop. )
response.order_income.seller_voucher_code	string[]	[]	The list of voucher code provided by seller. (Only display for non cb sip affiliate shop. )
response.order_income.drc_adjustable_refund	float	0.0	The adjustable refund amount from Shopee Dispute Resolution Center.
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.seller_return_refund	float	0.0	Amount returned to Seller in the event of Partial Return.
response.order_income.items	object[]		This object contains the detailed breakdown for all the items in this order, including regular items(non-activity) and activity items.
response.order_income.items.item_id	int64	800062998	ID of item
response.order_income.items.item_name	string	Product	Name of item
response.order_income.items.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.
response.order_income.items.model_id	int64	0	ID of the model that belongs to the same item.
response.order_income.items.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.
response.order_income.items.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.
response.order_income.items.line_item_id	int64	2600144043	The identity of order item. In case the order item is a bundle deal, this value will be unique to distinguish the order item.
response.order_income.items.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.
response.order_income.items.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.)
response.order_income.items.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.)
response.order_income.items.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.
response.order_income.items.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.
response.order_income.items.seller_discount	float	10.0	The discount provided by seller for this item
response.order_income.items.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. )
response.order_income.items.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.
response.order_income.items.discount_from_voucher_shopee	float	10.0	The offset of this item when the buyer use Shopee voucher.
response.order_income.items.discount_from_voucher_seller	float	10.0	The offset of this item when the buyer use seller-specific voucher.
response.order_income.items.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"
response.order_income.items.activity_id	uint64	0	If bundle_deal the is id of bundle deal, if add_on_deal this is id of add on deal.
response.order_income.items.is_main_item	boolean	false	Meaning a main or sub item for add_on_deal.
response.order_income.items.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.
response.order_income.items.is_b2c_shop_item	boolean	false	Indicates whether this is a B2C owned item.
response.order_income.items.ams_commission_fee	float	0.0	The amount of affiliate commission fee. Applicable for items sold via the Affiliate Program.
response.order_income.items.is_kit	boolean		Indicates if this item is a kit. (only for BR local seller)
response.order_income.items.kit_items	object		only applicable for BR local seller
response.order_income.items.kit_items.original_product_id	float		The merchant item identifier of the product within the kit (only for BR local seller)
response.order_income.items.kit_items.original_model_id	float		The merchant product model of the item within the kit. (only for BR local seller)
response.order_income.items.kit_items.total_qty	float		The quantity of this specific component within the kit. (only for BR local seller)
response.order_income.items.kit_items.original_price	float		The price of the item when it is listed as a standalone item. (only for BR local seller)
response.order_income.items.kit_items.proportional_price	float		The price of the item when it is listed within the kit (i.e. proportionally distributed) (only for BR local seller)
response.order_income.items.promotion_list	object[]
response.order_income.items.promotion_list.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
response.order_income.items.promotion_list.promotion_id	uint64	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.
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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. )
response.order_income.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.)
response.order_income.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. )
response.order_income.aff_currency	string	0.0	The currency of the country or region where shop opened in. (Only display for cb sip affiliate shop. )
response.order_income.exchange_rate	float	0.0	Exchange rate from primary shop currency to affiliate shop currency.
response.order_income.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.
response.order_income.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)
response.order_income.final_product_protection	float	0.0	The total amount of product protection purchased during placing an order.
response.order_income.credit_card_promotion	float	0.0	This value indicate the offset via credit card promotion.
response.order_income.credit_card_transaction_fee	float	0.0	This value indicate the total transaction fee.; credit_card_transaction_fee=buyer_transaction_fee+seller_transaction_fee
response.order_income.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. )
response.order_income.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. )
response.order_income.campaign_fee	float	0.0	The campaign fee charged by Shopee platform. Only available for some local Indonesian shops.
response.order_income.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)
response.order_income.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)
response.order_income.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
response.order_income.shipping_seller_protection_fee_amount	float		Service fee charged to seller in MY,ID,PH,BR Local (as per Jun 2024) due to additional program purchased.
response.order_income.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)
response.order_income.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.)
response.order_income.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.
response.order_income.order_adjustment	object[]		Order level adjustment transaction information.; If the order without adjustment, no returned of the field.
response.order_income.order_adjustment.amount	float	10.1	adjustment transaction amount.
response.order_income.order_adjustment.date	timestamp	1688107565	adjustment transaction complete date.
response.order_income.order_adjustment.currency	string	TWD	order level adjustment transaction's currency type.
response.order_income.order_adjustment.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
response.order_income.total_adjustment_amount	float	10.1	Total adjustment made to the order.
response.order_income.escrow_amount_after_adjustment	float	110.1	Final income seller can get from this order after deduct the order-level adjustment.
response.order_income.order_ams_commission_fee	float	0.0	The amount of affiliate commission fee for this order. Applicable for orders sold via the Affiliate Program.
response.order_income.buyer_payment_method	string	Credit Card/Debit Card	The payment method buyer used when do the order checkout.
response.order_income.instalment_plan	string	N/A	The instalment plan buyer chosen when do the order checkout. Only applicable when payment method support instalment.
response.order_income.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)
response.order_income.final_return_to_seller_shipping_fee	float	0.0	The amount of fee charged to seller (if any) for the failed delivery order.
response.order_income.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.
response.order_income.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)
response.order_income.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.
response.order_income.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.
response.order_income.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.
response.order_income.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.
response.order_income.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.
response.order_income.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.
response.order_income.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
response.order_income.tenure_info_list	object
response.order_income.tenure_info_list.payment_channel_name	string		Name of the payment channel that buyer used in checkout.
response.order_income.tenure_info_list.instalment_plan	string		Tenure information. This will have value if payment channel used has tenure information, such as credit card.
response.order_income.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
response.order_income.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
response.order_income.withholding_cit_tax	float	3.0	By VN law, E-commerce platforms need to Withhold Personal Income Tax applicable to corporate sellers selling in VN region
response.order_income.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
response.order_income.seller_order_processing_fee	float	3.0	Order Processing Fee is the amount charged to sellers for every order created.
response.order_income.buyer_paid_packaging_fee	float		The fee charged to the buyer for packaging materials
response.order_income.trade_in_bonus_by_seller	float		The discount provided by Seller/ Retailers for buyers who opt for trade-in.
response.order_income.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.
response.order_income.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.
response.order_income.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.
response.order_income.net_commission_fee_info_list	object		Returns a breakdown of the net commission fees.; -only for BR local sellers.
response.order_income.net_commission_fee_info_list.rule_id	float		The unique identifier of the commission rule applied to calculate the net commission fee.
response.order_income.net_commission_fee_info_list.fee_amount	float		The net commission fee amount calculated based on the corresponding commission rule.
response.order_income.net_commission_fee_info_list.rule_display_name	string		The display name of the commission rule for reference and readability.
response.order_income.net_service_fee_info_list	object		Returns a breakdown of the net service fees.; -only for BR local sellers.
response.order_income.net_service_fee_info_list.rule_id	float		The unique identifier of the service fee rule applied to calculate the net service fee.
response.order_income.net_service_fee_info_list.fee_amount	float		The net service fee amount calculated based on the corresponding service fee rule.
response.order_income.net_service_fee_info_list.rule_display_name	string		The display name of the service fee rule for reference and readability.
response.order_income.net_service_fee_info_list.category	string		The category of the service fee, indicating the type of service the fee is charged for.
response.order_income.seller_product_rebate	object		The shopee rebate borne by seller.; -only for BR local sellers.
response.order_income.seller_product_rebate.amount	float		This is the portion of Shopee rebate borne by seller.
response.order_income.seller_product_rebate.commission_fee_offset	float		This is the offset to gross commission fee, reducing it to the net value.
response.order_income.seller_product_rebate.service_fee_offset	float		This is the offset to gross service fee, reducing it to the net value.
response.order_income.pix_discount	float		[BR only]Final sum of pix discount of a specific order. (Only display for non cb sip affiliate shop.)
response.order_income.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.
response.order_income.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
response.order_income.th_import_duty	float		[TH only] Import Duty collected for imported goods entering Thailand.
response.order_income.remaining_voucher	float	10.0	[Only for BR local shop]Represents the portion of Shopee voucher that is not consumed after fee offset.
response.buyer_payment_info	object		The buyer payment info at order checkout moment. (snapshot value)
response.buyer_payment_info.buyer_payment_method	string		The payment method used by buyer.
response.buyer_payment_info.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)
response.buyer_payment_info.buyer_tax_amount	float		The tax amount paid by buyer.; currently this is a custom tax charged to CB orders in TW,CL,MX
response.buyer_payment_info.buyer_total_amount	float		The total amount paid by buyer at checkout moment.
response.buyer_payment_info.shopeevip_subtotal	float	0.10	The subscription fee paid by buyer for ShopeeVIP.
response.buyer_payment_info.credit_card_promotion	float		The promotion provided by credit card. it is an initial value (will not be updated after RR/cancellation)
response.buyer_payment_info.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)
response.buyer_payment_info.import_tax_amount	float		The import tax paid by buyer. it is an initial value (will not be updated after RR/cancellation)
response.buyer_payment_info.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)
response.buyer_payment_info.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)
response.buyer_payment_info.iof_tax_amount	float		The iof tax paid by buyer.; it is an initial value (will not be updated after RR/cancellation)
response.buyer_payment_info.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
response.buyer_payment_info.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
response.buyer_payment_info.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)
response.buyer_payment_info.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)
response.buyer_payment_info.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)
response.buyer_payment_info.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)
response.buyer_payment_info.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)
response.buyer_payment_info.buyer_paid_packaging_fee	float		The fee charged to the buyer for packaging materials
response.buyer_payment_info.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.
response.buyer_payment_info.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
response.buyer_payment_info.discount_pix	float		The discount provided by PIX (Only applicable for BR region)
response.buyer_payment_info.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.
response.buyer_payment_info.ads_voucher_discount	float		The voucher provided by Ads team to offset the amount need to be paid by buyer.
response.buyer_payment_info.buyer_instant_fee	float		The subscription fee paid by buyer for instant; (Only for BR Local Shops)
request_id	string	10fff653c945a390f8e1323c6bdffff4	The identifier for an API request for error tracking.
error	string		Error code
message	string		Error message

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

{
    "order_sn": "251021P1YSSN5U"
}

§8 Response sample

Response sample

§9 JSON

JSON

{
	"response": {
		"order_sn": "220725D58XURJS",
		"buyer_user_name": "xixxixi",
		"return_order_sn_list": [],
		"order_income": {
			"escrow_amount": 100,
			"buyer_total_amount": 99,
			"order_original_price": 110,
			"original_price": 139,
			"order_discounted_price": 100,
			"order_selling_price": 100,
			"order_seller_discount": 10,
			"bcrs_deposit": 0.1,
			"seller_discount": 10,
			"shopee_discount": 10,
			"voucher_from_seller": 10,
			"voucher_from_shopee": 10,
			"voucher_from_external_party": 0.1,
			"coins": 0.1,
			"buyer_paid_shipping_fee": 0.1,
			"buyer_transaction_fee": 0.1,
			"cross_border_tax": 0.1,
			"payment_promotion": 0.1,
			"commission_fee": 0.1,
			"service_fee": 0.1,
			"seller_transaction_fee": 0.1,
			"seller_lost_compensation": 0.1,
			"seller_coin_cash_back": 0.1,
			"escrow_tax": 0.1,
			"estimated_shipping_fee": 10,
			"final_shipping_fee": -10,
			"actual_shipping_fee": 10,
			"shipping_fee_sst": 0.1,
			"order_chargeable_weight": 500,
			"shopee_shipping_rebate": 0.1,
			"shipping_fee_discount_from_3pl": 0.1,
			"seller_shipping_discount": 0.1,
			"seller_voucher_code": [],
			"drc_adjustable_refund": 0.1,
			"cost_of_goods_sold": 1,
			"original_cost_of_goods_sold": 0.1,
			"original_shopee_discount": 0.1,
			"seller_return_refund": 0.1,
			"items": [
				{
					"item_id": 800062998,
					"item_name": "Product",
					"item_sku": " ",
					"model_id": 0,
					"model_name": " ",
					"model_sku": " ",
					"line_item_id": 2600144043,
					"original_price": 139,
					"original_price_pri": 110,
					"selling_price": 100,
					"discounted_price": 99,
					"bcrs_deposit": 0.1,
					"seller_discount": 10,
					"shopee_discount": 10,
					"discount_from_coin": 0.1,
					"discount_from_voucher_shopee": 10,
					"discount_from_voucher_seller": 10,
					"activity_type": " bundle_deal",
					"activity_id": 0,
					"is_main_item": false,
					"quantity_purchased": 1,
					"is_b2c_shop_item": false,
					"ams_commission_fee": 0.1,
					"is_kit": true,
					"kit_items": {
						"original_product_id": 0.1,
						"original_model_id": 0.1,
						"total_qty": 0.1,
						"original_price": 0.1,
						"proportional_price": 0.1
					},
					"promotion_list": [
						{
							"promotion_type": "seller_discount",
							"promotion_id": 848474823
						}
					]
				}
			],
			"escrow_amount_pri": 0.1,
			"buyer_total_amount_pri": 0.1,
			"original_price_pri": 0.1,
			"seller_return_refund_pri": 0.1,
			"commission_fee_pri": 0.1,
			"service_fee_pri": 0.1,
			"drc_adjustable_refund_pri": 0.1,
			"pri_currency": "0.0",
			"aff_currency": "0.0",
			"exchange_rate": 0.1,
			"reverse_shipping_fee": 0.1,
			"reverse_shipping_fee_sst": 0.1,
			"final_product_protection": 0.1,
			"credit_card_promotion": 0.1,
			"credit_card_transaction_fee": 0.1,
			"final_product_vat_tax": 0.1,
			"final_shipping_vat_tax": 0.1,
			"campaign_fee": 0.1,
			"sip_subsidy": 0.57,
			"sip_subsidy_pri": 2.8,
			"rsf_seller_protection_fee_claim_amount": 0.1,
			"shipping_seller_protection_fee_amount": 0.1,
			"final_escrow_product_gst": 4.35,
			"final_escrow_shipping_gst": 0.07,
			"delivery_seller_protection_fee_premium_amount": 0.1,
			"order_adjustment": [
				{
					"amount": 10.1,
					"date": 1688107565,
					"currency": "TWD",
					"adjustment_reason": " "
				}
			],
			"total_adjustment_amount": 10.1,
			"escrow_amount_after_adjustment": 110.1,
			"order_ams_commission_fee": 0.1,
			"buyer_payment_method": "Credit Card/Debit Card",
			"instalment_plan": "N/A",
			"sales_tax_on_lvg": 0.99,
			"final_return_to_seller_shipping_fee": 0.1,
			"withholding_tax": 0.1,
			"overseas_return_service_fee": 0.1,
			"prorated_coins_value_offset_return_items": 0.1,
			"prorated_shopee_voucher_offset_return_items": 0.1,
			"prorated_seller_voucher_offset_return_items": 0.1,
			"prorated_payment_channel_promo_bank_offset_return_items": 0.1,
			"prorated_payment_channel_promo_shopee_offset_return_items": 0.1,
			"fsf_seller_protection_fee_claim_amount": 0.1,
			"vat_on_imported_goods": 0.1,
			"tenure_info_list": {
				"payment_channel_name": "-",
				"instalment_plan": "-"
			},
			"withholding_vat_tax": 1,
			"withholding_pit_tax": 2,
			"withholding_cit_tax": 3,
			"tax_registration_code": "8881234567-888",
			"seller_order_processing_fee": 3,
			"buyer_paid_packaging_fee": 0.1,
			"trade_in_bonus_by_seller": 0.1,
			"fbs_fee": 0.1,
			"net_commission_fee": 0.1,
			"net_service_fee": 0.1,
			"net_commission_fee_info_list": {
				"rule_id": 0.1,
				"fee_amount": 0.1,
				"rule_display_name": "-"
			},
			"net_service_fee_info_list": {
				"rule_id": 0.1,
				"fee_amount": 0.1,
				"rule_display_name": "-",
				"category": "-"
			},
			"seller_product_rebate": {
				"amount": 0.1,
				"commission_fee_offset": 0.1,
				"service_fee_offset": 0.1
			},
			"pix_discount": 0.1,
			"prorated_pix_discount_offset_return_items": 0.1,
			"ads_escrow_top_up_fee_or_technical_support_fee": 0.1,
			"th_import_duty": 0.1,
			"remaining_voucher": 10
		},
		"buyer_payment_info": {
			"buyer_payment_method": "-",
			"buyer_service_fee": 0.1,
			"buyer_tax_amount": 0.1,
			"buyer_total_amount": 0.1,
			"shopeevip_subtotal": 0.1,
			"credit_card_promotion": 0.1,
			"icms_tax_amount": 0.1,
			"import_tax_amount": 0.1,
			"initial_buyer_txn_fee": 0.1,
			"insurance_premium": 0.1,
			"iof_tax_amount": 0.1,
			"is_paid_by_credit_card": false,
			"merchant_subtotal": 0.1,
			"seller_voucher": 0.1,
			"shipping_fee": 0.1,
			"shipping_fee_sst_amount": 0.1,
			"shopee_voucher": 0.1,
			"shopee_coins_redeemed": 0.1,
			"buyer_paid_packaging_fee": 0.1,
			"trade_in_bonus": 0.1,
			"bulky_handling_fee": 0.1,
			"discount_pix": 0.1,
			"bcrs_deposit": 0.1,
			"ads_voucher_discount": 0.1,
			"buyer_instant_fee": 0.1
		}
	},
	"request_id": "10fff653c945a390f8e1323c6bdffff4",
	"error": " ",
	"message": " "
}

§10 Error example

Error example

§11 JSON

JSON

{
    "error": "error_param",
    "message": "order_sn is required",
    "request_id": "d22d8d195ba4864b13e1a729145ad5f5"
}

§12 Errors

Errors

Error	Description	Solution
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	Invalid promotion ID. The promotion may have been recently added and not mapped to the system yet. Please raise a ticket on Open Platform for further verification.
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway
error_param	Missing order_sn. Please include a valid order_sn to get escrow details.
order_not_found	Order SN provided is invalid or does not belong to you. Please enter a valid Order SN.
error_server	Internal server error
error_param	The request body is not a valid json format
error_param	Invalid or missing page_size parameter , please enter a valid value that is with 1-100, indicating the number of records within a page.
common.error_not_found	supplier order item income not found

§13 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§14 Update log

Update log

Date	Change
2026-08-28	add "buyer instant fee" field for BR local shops
2026-07-31	update the type of the "promotion_id" and "activity_id" to uint64
2026-07-23	add "voucher_from_external_party" under "order_income"
2026-07-17	update the field names under "kit_items": "mt_item_id" to "original_product_id", "mt_model_id" to "original_model_id", "parent_item_price" to "original_price", and "item_price_prorated" to "proportional_price"
2026-07-17	add "line_item_id"

这条内容对你有帮助吗？