v2.ams.get_open_campaign_batch_task_result
GET /api/v2/ams/get_open_campaign_batch_task_result
Get open campaign batch task result
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_open_campaign_batch_task_result
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. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_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 |
|---|---|---|---|---|
| task_id | string | True | abcd-abcd-abcd | Task id, used to query task progress |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_business | Indicate error type if hit error. Empty if no error happened. |
| message | string | Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API. | Indicate error details if hit error. Empty if no error happened. |
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | The identifier for an API request for error tracking. |
| response | object | ||
| status | string | Doing | Task status. Applicable values: Doing Done Fail Note: Please note that task Done here refers to the completion of scanning all products in the shop, but not the successful execution of all products. Some products may fail, but due to the unpredictable huge volume of data, detailed information will not returned in the fail_reason. After the task is Done, you need to retrieve the list again by GET API and compare it with the before list to confirm the execution details |
| progress_rate | int32 | 80 | Progress rate, 80 means 80% |
| fail_reason | string | Error message, if it is not empty, it means there is an error Will not return the detail error for each products, you can check the products detail by using GET API, or using the batch operate API |