Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

Shopee supports buyers to rate the quality of sellers’ responses. To help sellers understand customer satisfaction with customer service, we add the "Customer Satisfaction" metric (metric_id: 95) in v2.account_health.get_shop_performance.

Notes: For developers who are still using the old v2.account_health.shop_performance, please switch to using the new v2.account_health.get_shop_performance as soon as possible. Since the old v2.account_health.shop_performance will be sunset on 2024-09-30, and the new metrics added during this period will not be applied to the old v2.account_health.shop_performance.

Related APIs:

v2.account_health.get_shop_performance

Effective Date on Live:

2024.07.26

2.To further improve the user experience, we have introduced a new field "buyer_payment_info" to the v2.payment.get_escrow_detail and v2.payment.get_escrow_detail_batch APIs to represent the buyer's payment information at the time of order checkout. (snapshot value).

This new field "buyer_payment_info" is currently in the grayscale phase only selected shop can get the new structure while calling v2.payment.get_escrow_detail or v2.payment.get_escrow_detail_batch interfaces and is expected to be open to all within one month.

*Note:The Open API documentation will be updated after the completion of grayscale

Sample of Response body:

*New fields in red, field descriptions in blue

v2.payment.get_escrow_detail

{

"error": "",

"message": "",

"request_id": "53b120c9cd1d9b3ae3bbdcf6adda7021",

"response": {

"buyer_payment_info": {

"buyer_payment_method": "Credit Card/Debit Card",

"buyer_service_fee": 0, *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": 0, *The tax amount paid by the buyer.

"buyer_total_amount": 90, *The total amount paid by buyer at checkout moment.

"credit_card_promotion": 0,

"icms_tax_amount": 0, *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": 0, *The import tax paid by buyer. It is an initial value (will not be updated after RR/cancellation)

"initial_buyer_txn_fee": 0, *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": 0, *The insurance premium paid by buyer. Currently only applicable to some regions like ID & BR (some other regions upcoming to have). It is an initial value (will not be updated after RR/cancellation)

"iof_tax_amount": 0, *The iof tax paid by buyer. this is only applicable for BR region.it is an initial value (will not be updated after RR/cancellation)

"is_paid_by_credit_card": true, *Whether this order is paid by credit card. it's related to payment channel used at checkout

"merchant_subtotal": 45, *The total item price paid by buyer at checkout.It is an initial value and will not be updated after RR/cancellation

"seller_voucher": 0, *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": 45, *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": 0, *The shipping fee sst paid by buyer. currently this should apply to MY region only.It is an initial value (will not be updated after RR/cancellation)

"shopee_coins_redeemed": 0, *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)

"shopee_voucher": 0 *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)

"buyer_user_name": "testbuyer",

"order_income": Object{...},

"order_sn": "240726MT4CAZYX",

"return_order_sn_list": Array[1]

}

Related APIs:

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

Effective Date on Live:

2024.07.26

尊敬的开发者，

请留意以下变动：

1.Shopee支持买家对卖家的回复质量进行评分。为了帮助卖家了解客户满意度，v2.account_health.get_shop_performance接口新增了"Customer Satisfaction"指标 (metric_id: 95)。

注意：对于仍在使用旧版v2.account_health.shop_performance的开发者，请尽快切换到新版v2.account_health.get_shop_performance。因为旧版v2.account_health.shop_performance将于2024-09-30正式下线，并且在此期间新增的指标将不会再支持旧版v2.account_health.shop_performance。

影响接口:

v2.account_health.get_shop_performance

上线时间:

2024.07.26

2.为进一步改善用户体验，我们在 v2.payment.get_escrow_detail 和 v2.payment.get_escrow_detail_batch 接口中引入了一个新字段 "buyer_payment_info"，用于表示买家在订单结账时的付款信息。(快照值）。

新字段 "buyer_payment_info"目前处于灰度阶段，只有选定的商店才能在调用 v2.payment.get_escrow_detail 或 v2.payment.get_escrow_detail_batch 接口时获得新结构，预计将在一个月内向所有商店开放。

*Note：开放 API 文档将在灰度完成后更新

响应主体示例：

*红色字体为新增字段，蓝色字体为字段描述