Shopee API

Shopping / API Key Intermediate HTTPS
Varies by plan (check documentation)

Overview

The Shopee Open Platform API allows sellers and developers to integrate with Shopee, one of Southeast Asia's largest e-commerce platforms. You can manage product listings, retrieve order data, handle logistics, and more. An API key is required, and you need to register as a Shopee partner to get access.

💡

Beginner Tip

Shopee uses HMAC-SHA256 request signing in addition to your API key — every request must include a correctly computed signature or it will be rejected. Follow the authentication guide closely before writing any code.

Available Data

Shopee data via REST API
JSON-formatted response data
Requires API key authentication

Example Response

JSON Response
{
  "status": "success",
  "data": {
    "result": "Data from Shopee",
    "description": "Shopee's official API for integration of various services from Shopee",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

shop_id Unique identifier for the Shopee shop.
shop_name Display name of the shop as shown on the Shopee platform.
status Current operational status of the shop, e.g., NORMAL or BANNED.
region Country/region code where the shop is registered, such as SG, MY, or TH.
response_type Indicates the authorization level granted to your app for this shop.

Implementation Example

const url = "https://open.shopee.com/documents";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

error_auth: Invalid sign The HMAC-SHA256 signature was computed incorrectly or the timestamp is too far from the server time.
Double-check your signature generation logic and ensure your system clock is synchronized. The timestamp must be within 5 minutes of Shopee server time.
error_param: Invalid access_token The access token has expired or was not obtained for the correct shop.
Refresh your access token using the refresh_token endpoint and confirm the shop_id matches the token.
error_permission: No permission to access Your partner account has not been granted the necessary API permissions.
Log in to the Shopee Partner Center and verify that the required permission scopes are enabled for your app.

Matrix Score Breakdown

🌐 Reachability 30/30
⚡ Speed 10/20
🔒 Security 15/15
🛠 Developer XP 12/20
✓ Reliability 10/15

Partially tested on Apr 5, 2026

Technical Specifications

Auth API Key
HTTPS REQUIRED
CORS UNKNOWN
Category Shopping
Difficulty Intermediate
Verified: 2026-04-04

Similar APIs

View All →