Shopee's Open Platform API helps developers who use the Shopee sellers platform meet various e-commerce needs. The Shopee Open Platform provides Open APIs and services that give developers access to many tools. These tools can improve how sellers operate, enhance customer experiences, and simplify business tasks. By using these APIs, businesses and developers can automate tasks, handle data more efficiently, and discover new opportunities within Shopee's marketplace.
\nShopee is one of the largest e-commerce platforms in Southeast Asia. Since its launch in 2015, it has grown into a giant with hundreds of thousands of daily users—a remarkable achievement for any company.
\nAs Shopee competes with other industry giants, it’s essential for its Open Platform API documentation to meet the high standards set by its competitors. Clear, concise, and developer-friendly documentation is key for developers and users to navigate through its API resources.
\nHigh-quality API documentation is a necessity for fostering innovation and driving adoption.
\nThe existing documentation has areas that could be improved to enhance readability, usability, and developer experience.
\nThis project aims to bridge the gaps in Shopee’s API documentation and make it more developer-friendly. While it’s not a conclusive solution, it is a meaningful contribution to improving the experience for developers navigating the Shopee API.
\nClarity: Ensure the documentation is easy to understand.
\nUsability: Make it simple for developers to find and use the information they need.
\nPracticality: Provide actionable and relevant examples to reduce friction.
\nI took it upon myself (pats self on the back) to create an improved version of the documentation. While this effort isn’t a definitive solution, it serves as a meaningful step forward—at least for me, and hopefully for other developers who interact with Shopee’s APIs.
\nReduced friction for developers.
\nEnhanced developer experience, enabling them to create innovative solutions on Shopee’s platform.
\nBy prioritizing clarity, usability, and practicality, this project aims to make Shopee’s API documentation a more effective tool for developers.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Brief Introduction on Shopee's Open Platform","slug":"brief-introduction-on-shopees-open-platform"},{"content":"Shopee API Documentation Improvement Project","slug":"shopee-api-documentation-improvement-project"}],"owner":"41291950","collectionId":"da1ed0ba-ebbe-4558-aa54-b1b157a82f5f","publishedId":"2sAYX3qNoy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-03T03:49:25.000Z"},"item":[{"name":"Create Bundle Deal API Improvements","item":[],"id":"a2532523-3280-4a79-9150-9fccc989d3ba","description":"The Shopee v2.bundle_deal.add_bundle_deal documentation contains grammatical errors, such as \"create bundle deal,\" which should be \"Create a bundle deal.\" Typos like \"invaild\" (should be \"invalid\") and repeated words (\"when when\") need correction. Ambiguous descriptions, such as the rule_type values, require clarification. Inconsistent formatting in tables and examples reduces readability. These issues must be fixed to improve the documentation's quality.
\"create bundle deal\" should be \"Create a bundle deal.\"
\n\"using to identify your permission to the api\" should be \"used to identify your permission to access the API.\"
\n\"The time when bundle deal activity start\" should be \"The time when the bundle deal activity starts.\"
\n\"The time when bundle deal activity end\" should be \"The time when the bundle deal activity ends.\"
\n\"Title of the bundle deal\" is incomplete and should be \"The title of the bundle deal.\"
\n\"when when\" (repeated) in the description of discount_value.
\"invaild\" should be \"invalid\" in the error code bundle.bundle_deal_invaild_discount_percentage.
\"doesn't has\" should be \"doesn't have\" in the error description for add_on.add_on_no_logistic.
The description for additional_tiers is unclear. It should specify that the fix_price, discount_percentage, and discount_value must match the values in tier 1.
The description for min_amount in additional_tiers is redundant and confusing.
The description for additional_tiers repeats the same information about fix_price, discount_percentage, and discount_value multiple times.
The description for min_amount in additional_tiers is redundant and confusing.
The description for rule_type does not clearly explain the valid values (1, 2, 3) and their meanings (FIX_PRICE, DISCOUNT_PERCENTAGE, DISCOUNT_VALUE).
The description for additional_tiers does not clearly state the maximum number of tiers allowed (3).
Some error codes, like bundle.bundle_deal_rule_type_mix_use, lack detailed descriptions.
The error code bundle.bundle_deal_tier_invalid uses double percent signs (%%), which is incorrect.
The request example includes all parameters (discount_value, fix_price, discount_percentage) even though only one is required based on the rule_type.
The response example does not include all possible fields, such as error and message.
/api/v2/shop/get_profileThe v2.bundle_deal.add_bundle_deal API enables sellers to create promotional bundle deals on Shopee, offering fixed prices, discount percentages, or discount values for bundle purchases. This API helps sellers boost sales, attract customers, and streamline promotional campaigns on the platform. For more details on restrictions and guidelines, refer to the Bundle Deal FAQ.
{ \n\"rule_type\": 1, \n\"discount_value\": 11, \n\"fix_price\": 11, \n\"discount_percentage\": 33, \n\"min_amount\": 1, \n\"start_time\": 1600000000, \n\"end_time\": 1610000000, \n\"name\": \"bundle name\", \n\"purchase_limit\": 3, \n\"additional_tiers\": \\[ \n{ \n\"min_amount\": 100, \n\"fix_price\": 100, \n\"discount_value\": 20, \n\"discount_percentage\": 20 \n} \n\\] \n}\n\n{\n \"error\": \"\",\n \"message\": \"\",\n \"request_id\": \"b41cb9d4eff03a708347d69abcd4c63d\",\n \"response\": {\n \"bundle_deal_id\": 11111\n }\n}\n\n{\n \"error\": \"bundle.bundle_deal_start_time_error\",\n \"message\": \"The start time should be later than current time\",\n \"request_id\": \"485066ac3b30e1bcad15447ef16179b5\",\n \"response\": {}\n}\n\nThis API can be called by the following app types:
\nERP System
\nSeller In-House System
\nMarketing
\nThe Shopee v2.shop.get_profile API documentation contains several errors, typos, and inconsistencies may confuse end users. Below are some of the improvements made inside the final product.
\nSeperated the End Points with the Common Parameters for better clarity.
\nOriginal: All checp prices while good quality
Corrected: All cheap prices while good quality
Original: Required param for most APIs.
Corrected: Required parameter for most APIs.
Original: The invoice issuer information for the shop. It could be \"Shopee\" or \"Other\" as the invoice issuer. This is for BR CNPJ seller only.Corrected: The invoice issuer information for the shop. Values: \"Shopee\" or \"Other\" (for BR CNPJ sellers only).
Original: Mixed formatting (e.g., common.error_not_found vs. error_auth).
Corrected: Consistently formatted error codes (e.g., common.error_not_found, error_auth).
Original: The explanation for sign was repeated in multiple places.
Corrected: Streamlined to avoid redundancy.
/api/v2/shop/get_profileThis API retrieves detailed information about a Shopee shop (including its logo), name, description, and invoice issuer (for BR CNPJ sellers). It is a GET request and requires authentication via access_token, partner_id, and other common parameters.
These parameters are required for all API requests.
\nNo additional parameters are required beyond the common parameters listed above.
\nUnirest.setTimeouts(0, 0);\nHttpResponse<String> response = Unirest.get(\"https://partner.shopeemobile.com/api/v2/shop/get_profile?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp\")\n.asString();\n\n{
\"message\": \"\",
\"request_id\": \"142b43ff8d9b7799a4fbcca440104167\",
\"response\": {
\"shop_logo\": \"https://cf.shopee.sg/file/4d4f2e34c6d27cd3838a49a575f251bf\",
\"description\": \"Welcome to our shop. All cheap prices while good quality.\",
\"shop_name\": \"OpenAPI Shop\",
\"invoice_issuer\": \"Other\"
},
\"error\": \"\"
}
{
\"request_id\": \"9f0f9c5a9004a54e92a132ef6e96cd82\",
\"error\": \"error_auth\",
\"message\": \"Invalid partner_id or shopid.\"
}
This API can be called by the following app types:
\nERP System
\nSeller In-House System
\nProduct Management
\nCustomized APP
\nAds Service
\n