Open Lazada Apps API

https://open.lazada.com/apps/doc/api
Admin
Documentation for the Lazada Open Platform APIs, providing developers with tools and guides to...
Tokens:2,502
Snippets:17
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Access Token Response Example

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Fcreate

A sample JSON response body returned by the /auth/token/create endpoint.

```json
{
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "country": "sg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "code": "0",
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "country_user_info": [
    {
      "country": "SG",
      "user_id": "1001",
      "seller_id": "1001",
      "short_code": "SG1001"
    }
  ],
  "expires_in": "10",
  "request_id": "0ba2887315178178017221014",
  "account": "xxx@126.com"
}
```

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

### Refresh Token API Response

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Frefresh

Example JSON response returned by the /auth/token/refresh endpoint.

```json
{
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "country": "sg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "code": "0",
  "country_user_info_list": [
    {
      "country": "sg",
      "user_id": "10101",
      "seller_id": "1001",
      "short_code": "SG001"
    }
  ],
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "expires_in": "10",
  "request_id": "0ba2887315178178017221014",
  "account": "xxx@126.com"
}
```

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

### GET/POST startExportByDataset

Source: https://open.lazada.com/apps/doc/api

Initiates a data export process for a specific dataset.

```APIDOC
## GET/POST startExportByDataset

### Description
Starts the export process for a specified dataset.

### Method
GET/POST
```

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

### GET/POST /auth/token/create

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Fcreate

Generates an access_token for calling Lazada APIs.

```APIDOC
## GET/POST /auth/token/create

### Description
Generates an access_token for calling Lazada APIs.

### Method
GET/POST

### Endpoint
https://auth.lazada.com/rest/auth/token/create

### Parameters
#### Query Parameters
- **app_key** (String) - Required - Unique app ID issued by LAZADA Open Platform console when you apply for an app category
- **timestamp** (String) - Required - The time stamp of the request e.g. 1517820392000 with less than 7200s difference from UTC time
- **access_token** (String) - Optional - API interface call credentials
- **sign_method** (String) - Required - The HMAC hash algorithm you are using to calculate your signature
- **sign** (String) - Required - Part of the authentication process that is used for identifying and verifying who is sending a request
```

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

### Create Access Token Request in Java

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Fcreate

Uses the LazopClient to send an authorization code and retrieve an access token.

```java
LazopClient client = new LazopClient(url, appkey, appSecret);
LazopRequest request = new LazopRequest();
request.setApiName("/auth/token/create");
request.addApiParameter("code", "0_100132_2DL4DV3jcU1UOT7WGI1A4rY91");
request.addApiParameter("uuid", "This field is currently invalid,  do not use this field please");
LazopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);
```

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

### POST /auth/token/create

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Fcreate

Exchanges an authorization code for an access token.

```APIDOC
## POST /auth/token/create

### Description
Exchanges an authorization code for an access token and refresh token.

### Method
POST

### Endpoint
/auth/token/create

### Parameters
#### Request Body
- **code** (String) - Required - oauth code, get from app callback URL
- **uuid** (String) - Optional - This field is currently invalid, do not use this field please

### Response
#### Success Response (200)
- **access_token** (String) - Access token
- **refresh_token** (String) - Refresh token, used to refresh the token when “refresh_expires_in”>0.
- **expires_in** (Number) - The expiring time of the access token, in seconds
- **refresh_expires_in** (String) - The expiring time of the refresh token
- **account_id** (String) - Account ID, Allow null.
- **country** (String) - The country ID
- **country_user_info** (Object[]) - Country user details
- **account_platform** (String) - Account platform
- **account** (String) - User account(login user)

#### Response Example
{
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "country": "sg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "code": "0",
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "country_user_info": [
    {
      "country": "SG",
      "user_id": "1001",
      "seller_id": "1001",
      "short_code": "SG1001"
    }
  ],
  "expires_in": "10",
  "request_id": "0ba2887315178178017221014",
  "account": "xxx@126.com"
}
```

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

### Refresh Access Token in Java

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Frefresh

Uses the LazopClient to send a refresh_token request and retrieve a new access token.

```java
LazopClient client = new LazopClient(url, appkey, appSecret);
LazopRequest request = new LazopRequest();
request.setApiName("/auth/token/refresh");
request.addApiParameter("refresh_token", "50001600212wcwiOabwyjtEH11acc19aBOvQr9ZYkYDlr987D8BB88LIB8bj");
LazopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);
```

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

### GET/POST /auth/token/refresh

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Frefresh

Refreshes the access_token for the Lazada Open Platform.

```APIDOC
## GET/POST /auth/token/refresh

### Description
Refreshes the access_token. The base endpoint is https://auth.lazada.com/rest.

### Method
GET/POST

### Endpoint
/auth/token/refresh

### Parameters
#### Query Parameters
- **app_key** (String) - Required - Unique app ID issued by LAZADA Open Platform console when you apply for an app category
- **timestamp** (String) - Required - The time stamp of the request e.g. 1517820392000 with less than 7200s difference from UTC time
- **access_token** (String) - Optional - API interface call credentials
- **sign_method** (String) - Required - The HMAC hash algorithm you are using to calculate your signature
- **sign** (String) - Required - Part of the authentication process that is used for identifying and verifying who is sending a request
```

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

### GET/POST GenerateAccessTokenWithOpenId

Source: https://open.lazada.com/apps/doc/api

Generates an access token using an OpenID.

```APIDOC
## GET/POST GenerateAccessTokenWithOpenId

### Description
Generates an access token using the provided OpenID for authentication.

### Method
GET/POST
```

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

### GET/POST GenerateAccessToken

Source: https://open.lazada.com/apps/doc/api

Generates an access token for API authentication.

```APIDOC
## GET/POST GenerateAccessToken

### Description
Generates an access token required for authenticating API requests.

### Method
GET/POST
```

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

### GET/POST /auth/token/refresh

Source: https://open.lazada.com/apps/doc/api?path=%2Fauth%2Ftoken%2Frefresh

Refreshes an access token using the provided refresh token.

```APIDOC
## GET/POST /auth/token/refresh

### Description
Refreshes an access token using a valid refresh token.

### Endpoint
/auth/token/refresh

### Parameters
#### Request Body
- **refresh_token** (String) - Required - The refresh token used to obtain a new access token.

### Response
#### Success Response (200)
- **access_token** (String) - The new access token.
- **expires_in** (Number) - The expiring time of the access token, in seconds.
- **refresh_token** (String) - The new refresh token.
- **refresh_expires_in** (Number) - The expiring time of the refresh token.
- **account_id** (String) - Account ID.
- **country** (String) - The country ID.
- **country_user_info_list** (Object[]) - Country user details.
- **account_platform** (String) - Account platform.
- **account** (String) - User account.

### Response Example
{
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "country": "sg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "code": "0",
  "country_user_info_list": [
    {
      "country": "sg",
      "user_id": "10101",
      "seller_id": "1001",
      "short_code": "SG001"
    }
  ],
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "expires_in": "10",
  "request_id": "0ba2887315178178017221014",
  "account": "xxx@126.com"
}
```

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

### GET/POST RefreshAccessToken

Source: https://open.lazada.com/apps/doc/api

Refreshes an existing access token.

```APIDOC
## GET/POST RefreshAccessToken

### Description
Refreshes an expired or expiring access token to maintain session continuity.

### Method
GET/POST
```
Tokens:
Raw