Basic Information
-
SERVICE_NAME: linkbest.open-service.stores.plans.get
-
Request Method: POST
Request Header
| Header Parameter | Required | Example | Description |
|---|---|---|---|
| Content-Type | Yes | application/json |
Common Parameters
| Parameter Name | Required | Example | Description |
|---|---|---|---|
| AppKey | Yes | 2312521 | App Key |
| Timestamp | Yes | 1596592757 | Second-level timestamp |
| Service | Yes | linkbest.open-Service.stores.plans.get | Interface service name |
| Sign | Yes | 5D17CCCD5B29F98171D6D0D43136B366 | Signature |
Interface Parameters
| Parameter Name | Required | Example | Description |
|---|---|---|---|
| Query | No | Search keyword | |
| StoreId | No | Store ID, from the ID of the store list interface | |
| IsApply | No | 1 Query applied programs, 0 Query current available programs（default） | |
| Page | Yes | Page number, default 1 | |
| PageSize | Yes | Page size, default 20, maximum 200 |
Request Example
{
"Query": "string",
"StoreId": "string",
"IsApply": "string",
"Page": "string",
"PageSize": "string"
}Response Parameters
| Name | Type | Required | Default | Description | Other Information |
|---|---|---|---|---|---|
| Status | integer | Optional | Status Code | ||
| Message | string | Optional | Error message | ||
| Data | object [] | Optional | item Type: object | ||
| ├─ ProgramId | string | Optional | Program ID | ||
| ├─ ProgramName | string | Optional | Program name | ||
| ├─ StoreName | string | Optional | Store name | ||
| ├─ Channel | string | Optional | Activity type: 0 web, 1 wap, 3 ROI, 4 mini program | ||
| ├─ Rddays | string | Optional | RD validity period | ||
| ├─ Commission | string | Optional | General commission description. For specific commission details and policies, please visit the program details | ||
| ├─ Category | string | Optional | Merchant type: 0 domestic merchant, 1 overseas merchant, 2 cross-border e-commerce | ||
| ├─ CategoryArea | string | Optional | When Category=1 (overseas merchant), this field indicates the eligible tracking areas for the program | ||
| ├─ SupportSubId | string | Optional | Whether SubId is supported: 0 not supported, 1 supported | ||
| ├─ ApplyMode | string | Optional | Review mode: 1 manual review, 2 automatic approval | ||
| ├─ Stime | string | Optional | Program start time, format: yyyy-MM-dd HH:mm:ss | ||
| ├─ Etime | string | Optional | Program end time, format: yyyy-MM-dd HH:mm:ss | ||
| ├─ Url | string | Optional | Default URL | ||
| ├─ ProgramLogo | string | Optional | Program logo | ||
| ├─ Status | string | Optional | Program status: 0 scheduled, 3 active, 7 ended, 8 paused | ||
| ├─ ProgramApplyStatus | string | Optional | Application status: 3 paused, 2 rejected, 1 approved, 0 not approved, -1 not applied | ||
| ├─ ApprovedWebsiteInfo | object [] | Optional | Approved website information (return only when IsApply=1) | item type: object | |
| ├─ Id | string | Optional | Website id | ||
| ├─ Name | string | Optional | Website name |
Response Example
{
"Status": 0,
"Message": "string",
"Data": [
{
"ProgramId": "string",
"ProgramName": "string",
"StoreName": "string",
"Channel": "string",
"Rddays": "string",
"Commission": "string",
"Category": "string",
"CategoryArea": "string",
"SupportSubId": "string",
"ApplyMode": "string",
"Stime": "string",
"Etime": "string",
"Url": "string",
"ProgramLogo": "string",
"Status": "string",
"ProgramApplyStatus": "string",
"ApprovedWebsiteInfo": [
{
"Id": "string",
"Name": "string",
}
]
}
]
}