Parameter | Description | Type | Required | Possible Values |
---|
advertiserId | The ID for the specific advertiser | integer | Y | A valid advertiser ID |
creativeId | The ID of the creative | string | Y | A valid creative ID |
creativeStateId | Creative state ID is a UUID returned from POST/creatives/preview. It links the state of the creative which was previewed | string | Y | Valid creativeState ID |
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 |
curl -X POST \
--location 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/preview/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer aaaa0000-aa00-aa00-aa00-aaaaaa000000' \
--header 'WM_CONSUMER.ID: aaaa1111-aa11-aa11-aa11-aaaaaa111111' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.INTIMESTAMP: 0000000000000' \
--header 'WM_SEC.AUTH_SIGNATURE:
'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000==' \
--data '{ "advertiserId": 00000000, "creativeId": "aaaa3333-aa33-aa33-aa33-aaaaaa333333", "creativeStateId": "aaaa4444-aa44-aa44-aa44-aaaaaa444444" }'
Element | Description | Type |
---|
totalResults | Total number of response outcomes | integer |
response | A nested array element with following elements: | array |
{ "totalResults": 1, "response": [ { "status": "completed" } ] }