canonical: https://jentic.com/apis/shopee.com/shopee

# Shopee Open Platform API

Shopee Open Platform API v2.0 for e-commerce operations across Southeast Asia and other Shopee markets. Enables sellers and partners to manage products, orders, logistics, discounts, shops, and media programmatically on the Shopee marketplace. The API exposes 27 endpoints secured with apiKey authentication.

## For AI agents

Programmatically refresh access token, get access token. Covers 27 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Refresh Access Token
- Get Access Token
- add_discount
- Query and filter Shopee Open Platform API records by parameters
- Monitor Shopee Open Platform API operational status and events

## Use cases

### E-Commerce Operations

Use the Shopee Open Platform API to perform e commerce operations programmatically. The API provides 27 endpoints covering core functionality including refresh access token, get access token, add_discount.

Example prompt: Call POST `/api/v2/auth/access_token/get` to refresh access token

### Automated Auth Management

Automate auth operations by combining multiple Shopee Open Platform API endpoints. Agents can get access token and then add_discount in a single workflow.

Example prompt: Call POST `/api/v2/auth/token/get` to get access token, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Shopee Open Platform API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'refresh access token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v2/auth/access_token/get` | Refresh Access Token |
| POST | `/api/v2/auth/token/get` | Get Access Token |
| POST | `/api/v2/discount/add_discount` | add_discount |
| GET | `/api/v2/logistics/get_channel_list` | get_channel_list |
| POST | `/api/v2/logistics/get_shipping_document_data_info` | get_shipping_document_info |
| GET | `/api/v2/logistics/get_shipping_parameter` | get_shipping_parameter |
| GET | `/api/v2/logistics/get_tracking_info` | get_tracking_info |
| POST | `/api/v2/media_space/upload_image` | upload_image |

## Key resources

- **Auth** — Authentication and authorization endpoints for the OAuth 2.0 flow.
- **Discount** — Discount and promotion management
- **Logistics** — Shipping and logistics management
- **MediaSpace** — Image and media upload
- **Order** — Order management and tracking

## Why Jentic

- **Setup:** Wiring the Shopee Open Platform API by hand means computing the signed 'sign' parameter on every request against partner.shopeemobile.com, managing access and refresh tokens, and parsing logistics and discount responses yourself. Through Jentic you install once, import the Shopee Open Platform API from the API Directory, store the partner key once, and your agent calls it.
- **Permission scoping:** Shopee carries its targets in request parameters and bodies rather than as owned path resources, so you limit the agent to the operations it needs, such as fetching the channel list or tracking info, and destructive ones like adding a discount stay out unless you add them.
- **Credential handling:** Your Shopee partner key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'refresh the access token' or 'get shipment tracking info', and Jentic returns the matching Shopee operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Shopee Open Platform API use?

The Shopee Open Platform API uses an API key passed in the `sign` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I refresh access token with the Shopee Open Platform API?

Yes. Use the POST `/api/v2/auth/access_token/get` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Shopee Open Platform API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I refresh access token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'refresh access token'. Jentic returns the matching Shopee Open Platform API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Shopee Open Platform API have?

The Shopee Open Platform API exposes 27 endpoints covering auth, discount, logistics operations.

### Can I limit what my agent is allowed to do with the Shopee Open Platform API?

Yes. Because you run Jentic One yourself, your own rules decide which Shopee operations and credentials the agent may use. Since Shopee carries its targets in request parameters and bodies rather than as owned path resources, you scope the agent to only the operations it needs, such as fetching the channel list with get_channel_list or checking shipment tracking with get_tracking_info. Destructive calls like adding a discount stay unavailable unless you explicitly grant them, and your partner key is injected at execution time rather than exposed to the agent.