Shopee Open Platform API
Seller and partner APIs for Singapore's biggest marketplace: product listing, orders, logistics, returns and shop management. Required integration for any SG e-commerce ERP or multichannel tool.
How to authenticate
5 stops to a working call
- 1Register as a developer at open.shopee.com and create an app (approval required for live category).
- 2Get your partner_id and partner_key.
- 3Have the seller authorize your app via the auth URL; you receive a code to exchange for shop-level access_token and refresh_token.
- 4Sign every call: HMAC-SHA256 over partner_id, path, timestamp, access_token, shop_id with your partner_key, passed as the sign query param.
- 5Refresh tokens every 4 hours via /auth/access_token/get.
Example request
curl 'https://partner.shopeemobile.com/api/v2/product/get_item_list?partner_id=ID×tamp=TS&access_token=TOKEN&shop_id=SHOP&sign=SIGN&offset=0&page_size=10&item_status=NORMAL'Example response
{"error":"","response":{"item":[{"item_id":178938,"item_status":"NORMAL","update_time":1704067200}],"total_count":100}}What you need
Create an App in the Shopee Open Platform Console. It gives you a partner_id and partner_key. Test IDs work only in the sandbox (test-stable). Live IDs work only in production.
Sign every request
Build a base string, then HMAC-SHA256 it with partner_key. The lowercase hex result is sign.
- Public APIs:
partner_id + api_path + timestamp - Shop APIs:
partner_id + api_path + timestamp + access_token + shop_id - Merchant APIs:
partner_id + api_path + timestamp + access_token + merchant_id
import hmac, hashlib, time
partner_id = 1000016
path = "/api/v2/shop/get_shop_info"
ts = int(time.time())
base = f"{partner_id}{path}{ts}{access_token}{shop_id}"
sign = hmac.new(partner_key.encode(), base.encode(), hashlib.sha256).hexdigest()Send partner_id, timestamp and sign in the query. The timestamp is valid for 5 minutes.
Shop authorization and tokens
- Send the seller to the authorization link with your partner_id and redirect URL.
- After approval, the redirect carries
codeandshop_id. The code is single use and expires in 10 minutes. - POST to
https://partner.shopeemobile.com/api/v2/auth/token/getwith code, partner_id and shop_id. Sandbox host:https://openplatform.sandbox.test-stable.shopee.sg. access_tokenlasts 4 hours.refresh_tokenlasts 30 days. Refresh before expiry.
Pricing
The official developer guide pages we read list no API fees. We could not confirm a published Shopee API price list, so check the Console or raise a ticket with Shopee.
Shopee Open Platform API: common questions
Is the Shopee Open Platform API free?
Yes. Shopee (Sea Group) offers the Shopee Open Platform API free of charge.
Does the Shopee Open Platform API need an API key?
Yes. It uses OAuth 2.0. Register as a developer at open.shopee.com and create an app (approval required for live category). Get your partner_id and partner_key. Have the seller authorize your app via the auth URL; you receive a code to exchange for shop-level access_token and refresh_token. Sign every call: HMAC-SHA256 over partner_id, path, timestamp, access_token, shop_id with your partner_key, passed as the sign query param. Refresh tokens every 4 hours via /auth/access_token/get.
What is the Shopee Open Platform API endpoint?
The base URL is https://partner.shopeemobile.com/api/v2. A working example: curl 'https://partner.shopeemobile.com/api/v2/product/get_item_list?partner_id=ID×tamp=TS&access_token=TOKEN&shop_id=SHOP&sign=SIGN&offset=0&page_size=10&item_status=NORMAL'
Where is the Shopee Open Platform API documentation?
At open.shopee.com under Developer Guide, with the API reference in the same portal.
What are partner_id and partner_key?
Your app's credentials from the Open Platform Console. partner_id goes in every query; partner_key is the secret used to compute sign.
How is the Shopee sign generated?
HMAC-SHA256 of partner_id + api path + timestamp (+ access_token + shop_id for shop APIs) using partner_key, as lowercase hex.
How long do Shopee tokens last?
access_token lasts 4 hours and refresh_token lasts 30 days.
How much does the Shopee API cost?
We found no published fee in the official docs we reviewed. Confirm with Shopee.
Verified 2026-09-25 against open.shopee.com, open.shopee.com
Notes for AI agents
The per-call HMAC signature and 4-hour token expiry are the main integration pain. Use the test environment (partner.test-stable.shopeemobile.com) first.
Machine-readable version: /api/apis/shopee-open-platform