Introduction to Shopee Open Platform API

Shopee Open Platform API is a public API provided by Shopee, an e-commerce platform based in Southeast Asia and Taiwan. The API allows developers to access Shopee’s platform resources to build ecommerce applications. This guide will provide an overview of the platform API and provide example codes in JavaScript.

How to Get Shopee Open Platform API Credentials

Shopee doesn't use a simple API key — you register an app to get a Partner ID and Partner Key, then sign every request.

1. Register at the Shopee Open Platform (start with a test/sandbox account, or a live account for production).
2. Create an app under App Management → App List. Your Partner ID and Partner Key are shown there.
3. To act on a seller's shop, complete the OAuth flow to obtain a shop-level access_token and shop_id.

Every v2 API call must include an HMAC-SHA256 signature built from your Partner Key, the API path, partner_id, and a timestamp:

GET /api/v2/shop/get_shop_info?partner_id={id}&timestamp={ts}&sign={hmac_sha256}&access_token={token}&shop_id={shop_id}

Validate integrations against the sandbox host before switching to the production endpoint.

Examples of Shopee Open Platform API Codes in JavaScript

Get Shop Categories

const axios = require("axios");

const getShopCategories = async () => {
    const config = {
        headers: {
            Authorization: "Bearer {access_token}",
            "Content-Type": "application/json",
        },
        data: {
            partner_id: {partner_id},
            shopid: {shop_id},
            timestamp: Math.floor(Date.now() / 1000),
        },
    };

    await axios
        .post("https://partner.test-stable.shopeemobile.com/api/v2/shop/get_categories", config)
        .then((response) => {
            console.log(response.data);
        })
        .catch((error) => {
            console.log(error);
        });
};

This code retrieves all of the shop categories of a Shopee seller’s shop.

Get Shop Orders

const axios = require("axios");

const getShopOrders = async () => {
    const config = {
        headers: {
            Authorization: "Bearer {access_token}",
            "Content-Type": "application/json",
        },
        data: {
            partner_id: {partner_id},
            shopid: {shop_id},
            timestamp: Math.floor(Date.now() / 1000),
            pagination_offset: 0,
            pagination_entries_per_page: 50,
        },
    };

    await axios
        .post("https://partner.test-stable.shopeemobile.com/api/v2/orders/get", config)
        .then((response) => {
            console.log(response.data);
        })
        .catch((error) => {
            console.log(error);
        });
};

This code retrieves all of the orders of a Shopee seller’s shop.

Conclusion

Shopee Open Platform API is a powerful tool for developers to create ecommerce applications. In this guide, we’ve provided some example codes to help you get started. Feel free to explore the official documentation to better understand the capabilities of the API. Happy coding!