Skip to content

Significant OpenAPI Updates of Product, Order, Payment [Shopee-ID:1438] #17

Description

@nVuln

New Shopee's Openapi Announcement (ID: 1438)

Dear Developers
Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.

1.Product APIs Add Bulk Update Related APIs

  1. Add v2.product.batch_add_item, which creates an asynchronous task to batch add items.
  2. Add v2.product.batch_update_outlet_price, which creates an asynchronous task to batch update outlet item prices.
  3. Add v2.product.batch_update_outlet_stock, which creates an asynchronous task to batch update outlet item stock.
  4. Add v2.product.batch_publish_item_to_outlet_shop, which creates an asynchronous task to batch publish outlet items.
  5. Add v2.product.get_batch_task_result, which is used to query the processing result of batch asynchronous tasks.

2.API Offline Notice

**Affected APIs:**v2.product.get_ssp_list, v2.product.get_ssp_info, v2.product.add_ssp_item, v2.product.link_ssp, v2.product.unlink_ssp
These API were built based on BR's old SSP system, but their functions were never enabled after launch with zero production data and traffic. Listing has launched a new SSP system to replace the legacy one.
We will fully take these APIs offline today. There is no impact on all developers as no business logic relies on them.
Effective Date2026.06.18

3.Payment APIs Add Ads Smart Voucher Field

BackgroundTo support the Ads Smart Voucher business, Shopee will introduce advertiser-funded vouchers as buyer incentives to help improve item conversion.To help developers identify and calculate this voucher amount, a new field ads_voucher_discount will be added to indicate the discount amount covered by Ads Smart Voucher in an order.
Applicable ScopeSG, ID, TH, TW, MY, PH, VN, BR
Update Detailsv2.payment.get_escrow_detail / v2.payment.get_escrow_detail_batch will add the response field ads_voucher_discount, which is used to display the discount amount corresponding to Ads Smart Voucher.

Field Path Description
buyer_payment_info.ads_voucher_discount Discount amount corresponding to Ads Smart Voucher

Related APIsv2.payment.get_escrow_detailv2.payment.get_escrow_detail_batch
Effective DateLived

4.Order APIs Add Prescription Item Identification Fields

  1. v2.order.get_order_detail will add the response field error_in_fetching_is_prescription_item, which indicates whether an error occurred when verifying if the item is a prescription item.
Name Type Description
item_list > error_in_fetching_is_prescription_item boolean To indicate if there was an error when validating whether this item is a prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for TH, PH, ID local shop.
  1. v2.order.get_package_detail will add the response fields is_prescription_item and error_in_fetching_is_prescription_item. In addition, prescription_check_status and prescription_reject_reason will be added for PH and ID sites.
Name Type Description
package_list > item_list > is_prescription_item boolean To indicate if this item is a prescription item. Default false. Only for PH, TH, ID whitelist shops.
package_list > item_list > error_in_fetching_is_prescription_item boolean To indicate if there was an error when validating whether this item is prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for PH, TH, ID whitelist shops.
package_list > prescription_check_status int Prescription check status. For ID, PH whitelisted sellers, the applicable values: 0: NONE 1: PASSED 2: FAILED For TH whitelisted sellers, the applicable values: 0: NONE 1: PASSED
package_list > prescription_reject_reason string Return the reason why a prescription is rejected. If no rejection reason, return empty. Only for ID and PH whitelist sellers.

Related APIsv2.order.get_order_detailv2.order.get_package_detail
Effective DateLived


@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions