v2.merchant.get_merchant_prepaid_account_list
GET /api/v2/merchant/get_merchant_prepaid_account_list
Use this api to get seller’s courier prepaid account.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/merchant/get_merchant_prepaid_account_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 |
|---|---|---|---|---|
| page_no | int32 | True | 1 | Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. |
| page_size | int32 | True | 10 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data. Min: 1 Max:10 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| 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. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | Detail informations you are querying. | |
| total | int32 | 8 | |
| list | object[] | ||
| prepaid_account_id | int64 | Record ID | |
| prepaid_account_courier_key | string | Courier Company Key (快递公司编码). | |
| prepaid_account_courier_name | string | Courier Company Name (快递公司名称). | |
| prepaid_account_partner_id | string | Prepaid Account Number (电子面单账户号码). | |
| prepaid_account_partner_key | string | Prepaid Account Password (电子面单账户密码). | |
| prepaid_account_partner_secret | string | Partner Secret (电子面单密钥). | |
| prepaid_account_partner_name | string | Partner Name (电子面单客户账户名称). | |
| prepaid_account_partner_net | string | Branch Name (网点名称). | |
| prepaid_account_partner_code | string | Partner Code (电子面单承载编号). | |
| prepaid_account_check_man | string | Delivery Agent Name (电子面单承载快递员名). | |
| prepaid_account_is_default | boolean | This is to indicate whether the prepaid account is Default Prepaid Account. | |
| more | boolean | false | This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of datas. |