Changelog
API version release notes
Release notes list all of the changes that are introduced by an API version. Use them to check whether your app is compatible with an API version, and what changes you might need to make before you migrate your app.
API
Feb 17, 2025
Version: v2022.01
| Release Date: 2025-02-17
Network Update: Outbound IP Address Change
What's New
- Updated Outbound IP Addresses: The outbound IPs for the US region have been updated.
- New IP:
35.161.161.242
- Original IP (Retained for Transition):
35.163.60.82
- Complete Outbound IP List:
34.210.253.121
52.11.173.113
35.163.60.82
35.161.161.242
- Recommended Action: If you have configured an IP whitelist, please update it to include all the above IPs. Do not remove the original IP immediately to ensure a smooth transition.
Feb 13, 2025
Version: v2020.01
| Release Date: 2025-02-13
API: Order Refund
What's New
- New Field:
refund_additional_total
- New Feature: Support for partial refunds for each item in
refund_additional_prices
. - Logic Optimization:
refund_payments
now supports automatic calculation ofrefund_total
, eliminating manual calculations.
Jan 2025 Update
Version: v2022.01
| Release Date: 2025-01
New Feature: SPU Data Analysis API
Endpoint: /data-analysis/spu
Description: Added a Standard Product Unit (SPU)-based sales data analysis endpoint.
- Multi-mode Analysis: Aggregate sales data by SPU, SKU, or collection.
- Advanced Filtering: JSON-based filtering with keyword matching.
- Pagination & Sorting: Default 60 records per page, max 500.
Example Request:
GET /data-analysis/spu?type=product&begin_time=1666512080&end_time=1682323199
Jan 2025 Logistics Provider List Update
Version: v2022.01
| Release Date: 2025-01
Document Update: Logistics Provider List Documentation
Announcement Date: January 20, 2025
Our OpenAPI updated the logistics provider list documentation yesterday (January 20, 2025). Merchants using the logistics provider list documentation are advised to complete configuration updates promptly to avoid issues such as selecting the wrong logistics provider, which may lead to tracking failures.
Update Details:
- Last document update: September 25, 2024, with 1,061 entries.
- This update adds over 700 new entries, bringing the total to 1,737 entries.
- For the latest information, please refer to: Logistics Provider List Documentation.
Important Notes:
This document may not always reflect the most up-to-date logistics provider information. We strongly recommend using the OpenAPI interface to retrieve the latest data, including the complete list of logistics providers and their codes.
Required Actions:
Retrieve the updated logistics provider list and the latest tracking codes through the following API interface:
Rate Limits & Pagination
Version: v2022.01
| Release Date: Jan 31, 2022
Rate Limits:
The REST Admin API allows a maximum of 40 requests per app per store per minute
, replenishing at 2 requests per second
.
Pagination:
Cursor-based pagination has been implemented for Get Product List
endpoints. Future updates will expand this feature to more endpoints.
Idempotent Requests
Version: v2022.01
| Release Date: Jan 31, 2022
If an API request is disrupted, you may not receive a response. Using an idempotency key ensures that the request is processed only once, preventing duplicate operations.
Access Scopes
Version: v2022.01
| Release Date: Jan 31, 2022
The new Get Access Scopes
endpoint allows retrieval of the access scopes linked to an API key.
Payment App Open API Support
Version: v2022.01
| Release Date: Jan 31, 2022
Payment apps integrate with Shoplazza to process payments. Only approved partners can develop payment apps on the platform.
Supported Payment Methods:
- Wallets
- Buy Now Pay Later (Installments, Buyer Financing)
- Credit & Debit Cards
- Bank Transfers & Online Banking
- Cryptocurrency
- Cash & ATM payments
Order Risk API
Version: v2022.01
| Release Date: Jan 31, 2022
The Order Risk
API provides risk assessment data for orders, helping merchants detect and manage fraud risks.
January 2, 2020
Version: v2020.01
| Release Date: 2020-01-02
Backward Compatibility:
This release ensures backward compatibility with older API versions (before 2020). For example, the following calls now return the same results:
/openapi/products.json
/openapi/api/open/products.json
/openapi/2020-01/products.json
(Recommended)
For forward compatibility, if no version is specified in a request, the system defaults to the stable version 2020-01
. We strongly recommend migrating to versioned API calls to ensure stability.