Retrieve Review for Brand Asset
URL: GET /api/v1/brand_assets/reviews
Note: When querying with only an advertiser ID, the response excludes any brand assets that have not yet been submitted for review. If you query with a specific brand asset ID, and that asset has either never been submitted or requires re-submission, the API will return an error.
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique advertiser ID |
| brandAssetId | The ID of the brand asset for which to upload the logo image | integer | N | Unique asset ID |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
Sample Request
curl -X GET 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/brand_assets/reviews?advertiserId=400000&brandAssetId=6000000' \ --header 'accept: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: ***********' \ --header 'WM_SEC.KEY_VERSION: 1' \  --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' \
Response
| Element | Description | Type |
|---|---|---|
| reviewId | ID of the review for the given brand asset | integer |
| brandAssetId | ID of the campaign for whose ad group, the reviews are fetched | integer |
| reviewStatus | Status of the brand asset review. Possible values of status are: pending, inProgress, complete, cancelled | string |
| status | Status of the brand asset | string |
| reviewReason | If value of reviewStatus is rejected, you will receive the reason for why it was rejected | string |
| customImageStatus | Specified status of the custom image | string |
| customImageReviewReason | If the custom image is rejected, you will receive the reason for why it was rejected. | string |
Sample Response
[ { "reviewId": 100001, "brandAssetId": 600004, "reviewStatus": "pending", "status": "pending", "reviewReason": null, "customImageStatus": "pending", "customImageReviewReason": null }, { "reviewId": 100002, "brandAssetId": 600005, "reviewStatus": "pending", "status": "pending", "reviewReason": null, "customImageStatus": "pending", "customImageReviewReason": null }
]
Updated about 1 month ago