Retrieve Status of Skyline v3 Background Color Recommendations
URL: POST /api/v1/creatives/colors/background/recommendations/status
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
advertiserId | The ID of the specific advertiser. | integer | Y | A valid advertiser ID |
recommendationId | ID of recommendation for which details are to be retrieved. | string (UUID) | Y | A valid recommendation ID |
Sample Request
curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/colors/background/recommendations/status' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v00-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.INTIMESTAMP: 1565309779' \ --data '{ "advertiserId": 12345678, "recommendationId": "abdefg-12345" }'
Response
| Element | Description | Type |
|---|---|---|
status | Current status of the recommendation process. Possible values: PENDING, IN_PROGRESS, FAILED, DONE. | string (enum) |
colors | List of recommended background colors in hexadecimal format. If there are no recommendations to return, colors will be empty. | array (string) |
recommendationId | ID of recommendation for which details are to be retrieved. | string (UUID) |
Sample Response
[ { "recommendationId": "12345", "status": "DONE", "colors": ["#CEB6D2", "#D6EED2"] }
]
Updated 7 days ago