v2.merchant.get_warehouse_eligible_shop_list
POST /api/v2/merchant/get_warehouse_eligible_shop_list
Get eligible shop list by warehouse id
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/merchant/get_warehouse_eligible_shop_list
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| merchant_id | int | 1 | Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs). |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, merchant_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| warehouse_id | int | True | Warehouse address identifier. | |
| warehouse_type | int | True | 1 means pickup warehouse 2 means return warehouse | |
| cursor | object | True | // how to use DoubleSidedCursor // Get data for the first page: Please pass next_id = 0 or nil, page_size = {your page size}. // Get data for the next page: Please pass the Cursor from the previous response, and set prev_id=nil; // Get data for the prev page: Please pass the Cursor from the previous response, and set next_id=nil; // Stop fetching next data: The Cursor.next_id in the previous response is nil. // Stop fetching prev data: The Cursor.prev_id in the previous response is nil. | |
| next_id | int | False | ||
| prev_id | int | False | ||
| page_size | int | True | The size of one page. Limit is [1,30]. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | The identifier of the API request for error tracking. | |
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| response | object | ||
| shop_list | object[] | Eligible shop list of the warehouse | |
| shop_id | int | Shopee's unique identifier for a shop. | |
| shop_name | string | Name of the shop. | |
| cursor | object | ||
| next_id | int | ||
| prev_id | int | ||
| page_size | int |