Get detailed information of a specified distributor, including basic user information, distribution status, and user group information.
Precautions
- This interface uses the GET method
- Need to provide the retailer ID parameter
- User login verification is required
- Return the complete user information and group details of the retailer
- Contains the cumulative earnings, invitation code, and other information of the retailer
Request address
{ๅๅๅฐๅ}/api/retailer/info
Description:{ๅๅๅฐๅ}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/retailer/info
Request syntax
GET {ๅๅๅฐๅ}/api/retailer/info
Request header
This interface also involves common request headers. For more information, please seeCommon Request Headers (Common Request Headers).
Request Parameters
| Field Name |
Type |
Required |
Description |
| retailer_id |
integer |
Yes |
Distributor ID |
Response Headers
This interface only involves public response headers. More information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field Name |
Type |
Description |
| code |
integer |
Error code |
| message |
string |
Error Description |
| data |
object |
Distributor detail object |
Data result parameters
| Field Name |
Type |
Description |
| id |
integer |
User ID |
| parent_id |
integer |
Parent user ID |
| user_name |
string |
Username |
| Real Name |
string |
True Name |
| avatar_url |
string |
User avatar address |
| email |
string |
Email Address |
| phone |
string |
Phone number |
| group_id |
integer |
User Group ID |
| is_retailer |
integer |
Is the distributor (1 for yes, 0 for no) |
| balance |
integer |
User Balance (Unit: Cents) |
| Total Reward |
integer |
Distributor cumulative earnings (Unit: fen) |
| Invite Code |
string |
User invitation code |
| Last login |
integer |
Timestamp of the last login |
| Expire time |
integer |
Expiration timestamp |
| created_time |
integer |
registration timestamp |
| updated_time |
integer |
update timestamp |
| status |
integer |
User display status |
| group |
object |
User group information |
group User group information parameters
| Field Name |
Type |
Description |
| id |
integer |
Group ID |
| Title |
string |
Group name |
| Description |
string |
Group introduction |
| level |
integer |
Group Level |
| Price |
integer |
Group Price (Unit: Cents) |
| Setting |
object |
Group Configuration Information |
| status |
integer |
Group Display Status |
| Favorable Price |
integer |
Discount Price |
setting Group Configuration Information Parameters
| Field Name |
Type |
Description |
| Share reward |
integer |
Share Reward Percentage |
| Parent reward |
integer |
Parent Reward Percentage |
| Discount |
integer |
Discount Percentage |
| Expire Day |
integer |
Validity Period (0 means unlimited) |
Example Usage
Request Example
GET /api/retailer/info?retailer_id=1000 HTTP/1.1
Host: www.anqicms.com
Response Example
{
"code": 0,
"msg": "",
"data": {
"id": 1000,
"created_time": 1669012062,
"updated_time": 1679536756,
"parent_id": 0,
"user_name": "retailer1",
"real_name": "ๅ้ๅ1",
"avatar_url": "uploads/202211/21/14f56760596b5328.webp",
"email": "[email protected]",
"phone": "13800138000",
"group_id": 2,
"status": 1,
"is_retailer": 1,
"balance": 150000,
"total_reward": 500000,
"invite_code": "retailer123",
"last_login": 1702912236,
"expire_time": 1997404800,
"group": {
"id": 2,
"created_time": 0,
"updated_time": 1696919880,
"title": "้ซ็บงๅ้ๅ",
"description": "้ซ็บงๅ้ๅ็นๆ...",
"level": 2,
"status": 1,
"price": 9900,
"setting": {
"share_reward": 25,
"parent_reward": 5,
"discount": 90,
"expire_day": 0
},
"favorable_price": 8900
},
"full_avatar_url": "https://en.anqicms.com/uploads/202211/21/14f56760596b5328.webp",
"link": ""
}
}
Error Code
| Error code |
Description |
| 0 |
OK |
| -1 |
Error, the reason is indicated in msg |
| 1001 |
Not logged in |
| 1002 |
Unauthorized |
| 200 |
API request OK |
