Shopee Open Platform

https://open.shopee.com/developer-guide
Admin
Shopee Open Platform provides a comprehensive suite of Open APIs and services for developers to...
Tokens:4,208
Snippets:34
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /api/v2/product/get_category

Source: https://open.shopee.com/developer-guide/16

Example of a GET-type API request. Common parameters (partner_id, timestamp, shop_id, access_token, sign) and request parameters (language) are placed in the URL.

```APIDOC
## [GET] /api/v2/product/get_category

### Description
Example of a GET-type API request. Common parameters and request parameters are placed in the URL.

### Method
GET

### Endpoint
https://partner.shopeemobile.com/api/v2/product/get_category

### Parameters
#### Query Parameters
- **partner_id** (string) - Required - Common parameter: Partner ID.
- **timestamp** (integer) - Required - Common parameter: Timestamp of the request.
- **shop_id** (integer) - Required - Common parameter: Shop ID.
- **access_token** (string) - Required - Common parameter: Access token.
- **sign** (string) - Required - Common parameter: Signature.
- **language** (string) - Optional - Request parameter: Language code.

### Request Example
https://partner.shopeemobile.com/api/v2/product/get_category?partner_id=851249&timestamp=1654673582&shop_id=1001094&access_token=367a0a8eb9d1837cbf7c43b587a0faa4&sign=a40fc50a08c382eeee08e2eb00deb8464c6fdcbe4f1c271e033cdbca3ded4d5b&language=zh-hans

### Response
#### Success Response (200)
- **request_id** (string) - Yes - Unique request ID.
- **error** (string) - Yes - Error code; empty on success.
- **message** (string) - No - Error message; empty on success.
- **warning** (string) - No - Warning information.
- **response** (object) - No - Response data on success.

#### Response Example
{
  "request_id": "...",
  "error": "",
  "message": "",
  "warning": "",
  "response": {}
}
```

--------------------------------

### Python sample for signature calculation and API calls

Source: https://open.shopee.com/developer-guide/16

This Python script demonstrates how to calculate the HMAC-SHA256 signature for Shopee Open API calls and make requests for Shop, Merchant, and Public APIs. It uses the partner key and base string composed of parameters in the specified order. Note that the code contains syntax errors and placeholder values; it is provided as a reference example.

```python
#!/usr/bin/envpython

# encoding:utf-8



import hmac 

import time

import requests

import hashlib

timest=int(time.time())

host="https://partner.shopeemobile.com 

access_token = "random string"



partner id =80001

partner key = "test....."



#### call shop level api 

shop id =209920

base string ="%s%s%s%s%s"%(partner id, path timest access token, shop id) 

sign = hmac.new( partner key,base string,hashlib.sha256)hexdigest() 

path ="/api/v2/example/shop level/get"



url = host + path + "?partner_id=%s&shop_id=%s&timestamp=%s&access_token=%s&sign=%s"%(partner_id, shop_id, timest, access_token, sign) 

headers={"Content-Type":"application/ison"? 

resp=requests.post(urlheaders=headers)



#### call merchant level api 

merchant id =1234567

base string ="%s%s%s%s%s"%(partner id, path timest, access token, merchant id) 

sign =hmac.new( partner key,base string,hashlib.sha256).hexdigest() 

path ="/api/v2/example/merchant_level/get"



url = host+ path +"?partner id=%s&merchant id=%s&timestamp=%s&access token=%s&sign=%s"%(partnerid, merchant id, timest, access token, sign) 

headers ={"Content-Type":"application/ison"? resp =requests.eet(urlheaders=headers)



#### call public api

base string ="%s%s%5%s"%(partner idpathtimestaccess token)

sign= hmac.new( partner keybase stringhashlib.sha256)hexdigest() 

path ="/api/v2/auth merchant/access token/get"



url = host+path+"?partner id=%s&timestamp=%s&sign=%s%(partner idtimest, sign)

body ={"partner id":partner id, "merchant id": merchant id,"refresh token":"testingtoken") 

headers =["Content-Type":"application/ison"? 

resp =requests.post(url,json=bodyheaders=headers)
```

--------------------------------

### POST /api/v2/shop/update_profile

Source: https://open.shopee.com/developer-guide/16

Example of a POST-type API request. Common parameters are placed in the URL, and request parameters are placed in the request body.

```APIDOC
## [POST] /api/v2/shop/update_profile

### Description
Example of a POST-type API request. Common parameters are inserted in the request URL, and request parameters are in the request body.

### Method
POST

### Endpoint
https://partner.shopeemobile.com/api/v2/shop/update_profile

### Parameters
#### Query Parameters
- **partner_id** (string) - Required - Common parameter: Partner ID.
- **timestamp** (integer) - Required - Common parameter: Timestamp of the request.
- **shop_id** (integer) - Required - Common parameter: Shop ID.
- **access_token** (string) - Required - Common parameter: Access token.
- **sign** (string) - Required - Common parameter: Signature.

#### Request Body
- **shop_logo** (string) - Optional - URL of the shop logo.
- **description** (string) - Optional - Shop description.
- **shop_name** (string) - Optional - Shop name.

### Request Example
{
  "shop_logo": "https://cf.shopee.sg/file/8424390be4677b0b3c37ce6499ce261a",
  "description": "TTest",
  "shop_name": "123"
}

### Response
#### Success Response (200)
- **request_id** (string) - Yes - Unique request ID.
- **error** (string) - Yes - Error code; empty on success.
- **message** (string) - No - Error message; empty on success.
- **warning** (string) - No - Warning information.
- **response** (object) - No - Response data on success.

#### Response Example
{
  "request_id": "...",
  "error": "",
  "message": "",
  "warning": "",
  "response": {}
}
```
Tokens:
Raw