蝦皮API串接 取得蝦皮訂單 income 錢包入帳金額

v2.payment.get_escrow_detail

GET

/api/v2/payment/get_escrow_detail

Use this API to fetch the accounting detail of order.

Common Parameters

Surroundings	HTTP Address
URL	https://partner.shopeemobile.com/api/v2/payment/get_escrow_detail
URL（Chinese Mainland）	https://openplatform.shopee.cn/api/v2/payment/get_escrow_detail
Test URL	https://partner.test-stable.shopeemobile.com/api/v2/payment/get_escrow_detail
Test URL（Chinese Mainland）	https://openplatform.test-stable.shopee.cn/api/v2/payment/get_escrow_detail

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: escrow_amount=buyer_total_amount+shopee_discount+voucher_from_shopee+coins+payment_promotion-buyer_transaction_fee-cross_border_tax-commission_fee-service_fee-seller_transaction_fee-seller_coin_cash_back-escrow_tax-final_product_vat_tax-final_shipping_vat_tax-drc_adjustable_refund-Reverse_shipping_fee+rsf_seller_protection_fee_claim_amount-rsf_seller_protection_fee_premium_amount+final_shipping_fee(could be postitive/negtive)-final_delivery_insurance_premium_amount.  For cb sip affiliate shop: escrow_amount=escrow_amount_pri * exchange_rate
buyer_total_amount	float	99.0	The total amount that paid by buyer.If a return refund is generated, the field is the actual amount paid by the buyer. eg. full return/refund will show 0.
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.
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 rebate 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
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. )
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. )
order_chargeable_weight	int	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. )
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. )
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. (Only display for non cb sip affiliate shop. )
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	int	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	int	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.
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.
seller_discount	float	10.0	The discount provided by seller for this item
shopee_discount	float	10.0	The discount provided by Shopee for this item
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. In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0.
discount_from_voucher_seller	float	10.0	The offset of this item when the buyer use seller-specific voucher. 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.
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	int	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	int	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.
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.
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 amount that shopee will payout to seller when buyer returns a parcel and incurs a return shipping fee (RSF). Only apply for PH local orders.
rsf_seller_protection_fee_premium_amount	float		Amount charged by Shopee to seller for additional services. Only apply for PH local orders.
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.)
request_id	string	10fff653c945a390f8e1323c6bdffff4	The identifier for an API request for error tracking.
error	string		Error code
message	string		Error message

Request Example-Java

{
    "order_sn": "220914R9U7D3C6"
}

Response Example

{
    "error": "",
    "message": "",
    "request_id": "d94e0796f1562cc43e6c5d1292f26300",
    "response": {
        "buyer_user_name": "moontewyekni",
        "order_income": {
            "actual_shipping_fee": 0,
            "buyer_paid_shipping_fee": 1,
            "buyer_total_amount": 59.69,
            "buyer_transaction_fee": 0,
            "campaign_fee": 0,
            "coins": 0,
            "commission_fee": 4,
            "cost_of_goods_sold": 65.75,
            "credit_card_promotion": 0,
            "credit_card_transaction_fee": 1.19,
            "cross_border_tax": 0,
            "delivery_seller_protection_fee_premium_amount": 0,
            "drc_adjustable_refund": 0,
            "escrow_amount": 49.47,
            "escrow_tax": 0,
            "estimated_shipping_fee": 1,
            "final_escrow_product_gst": 4.35,
            "final_escrow_shipping_gst": 0.07,
            "final_product_protection": 0,
            "final_product_vat_tax": 0,
            "final_return_to_seller_shipping_fee": 0,
            "final_shipping_fee": 0,
            "final_shipping_vat_tax": 0,
            "items": [
                {
                    "activity_id": 0,
                    "activity_type": "",
                    "discount_from_coin": 0,
                    "discount_from_voucher_seller": 1.29,
                    "discount_from_voucher_shopee": 0,
                    "discounted_price": 20.22,
                    "is_b2c_shop_item": false,
                    "is_main_item": false,
                    "item_id": 11109159298,
                    "item_name": "MOES Smart Switch Tuya ZigBee No Neutral Wire No Capacitor Needed Smart Life 2/3 Way Works with Alexa and other voice-controlled devices 2mqtt",
                    "item_sku": "ZS-B-EU1-WH-MS-FZ2",
                    "model_id": 92533053388,
                    "model_name": "1 gang white,China",
                    "model_sku": "ZS-B-EU1-WH-MS-FZ3",
                    "original_price": 42.55,
                    "quantity_purchased": 1,
                    "seller_discount": 21.35,
                    "shopee_discount": 0.98
                },
                {
                    "activity_id": 202397450,
                    "activity_type": "bundle_deal",
                    "discount_from_coin": 0,
                    "discount_from_voucher_seller": 0,
                    "discount_from_voucher_shopee": 0,
                    "discounted_price": 42.47,
                    "is_b2c_shop_item": false,
                    "is_main_item": false,
                    "item_id": 11109159298,
                    "item_name": "MOES Smart Switch Tuya ZigBee No Neutral Wire No Capacitor Needed Smart Life 2/3 Way Works with Alexa and other voice-controlled devices 2mqtt",
                    "item_sku": "ZS-B-EU1-WH-MS-FZ2",
                    "model_id": 92533053391,
                    "model_name": "2 gang white,China",
                    "model_sku": "ZS-B-EU2-WH-MS-FZ3",
                    "original_price": 90.28,
                    "quantity_purchased": 2,
                    "seller_discount": 45.73,
                    "shopee_discount": 2.08
                }
            ],
            "order_chargeable_weight": 0,
            "original_cost_of_goods_sold": 65.75,
            "original_price": 85.45,
            "original_shopee_discount": 3.06,
            "payment_promotion": 0,
            "refund_amount_to_buyer": 0, --經詢問官方(Shopee Open Platform)，此欄位已經不再回傳
            "reverse_shipping_fee": 0,
            "rsf_seller_protection_fee_claim_amount": 0,
            "rsf_seller_protection_fee_premium_amount": 0,
            "seller_coin_cash_back": 0,
            "seller_discount": 19.7,
            "seller_lost_compensation": 0,
            "seller_return_refund": 0,
            "seller_shipping_discount": 0,
            "seller_transaction_fee": 1.19,
            "seller_voucher_code": [
                "MORN50411"
            ],
            "service_fee": 3.67,
            "shipping_fee_discount_from_3pl": 0,
            "shopee_discount": 3.06,
            "shopee_shipping_rebate": 0,
            "voucher_from_seller": 4,
            "voucher_from_shopee": 0
        },
        "order_sn": "230102A5KA3BVH",
        "return_order_sn_list": []
    }
}

Error Example

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

Error Codes

Error	Error Description
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_param	Invalid partner_id.
error_param	There is no partner_id in query.
error_auth	No permission to current api.
error_param	There is no sign in query.
error_sign	Wrong sign.
error_param	no timestamp
error_param	Invalid timestamp
error_network	Inner http call failed

如果有什麼問題，也可以在下方留言處與我們分享，感謝您!!

手刀試用=>蝦皮對帳王

手刀試用=>康捷雲端ERP

相關文章

👉 進出貨一覽表 簡單王 操作步驟詳解

👉 簡單王-進出貨匯入上傳工具 操作步驟詳解

👉 蝦皮對帳王-蝦皮對帳結果一覽表-為什麼要對帳?無對應???

👉 蝦皮對帳王-對帳原理分析-有訂單，有撥款だいじょうぶ(大丈夫)；有訂單，沒撥款 歐NO~~~~~!!!

[蝦皮服務] 訂單完成後什麼時候能夠收到款項呢？