Retrieve Creative Submission Status

Retrieve status of creative approval submission request.

Note: Creative can be submitted for approval only after all review comments have been marked resolved and the creative has been compiled/previewed

📘

URL: POST/api/v1/creatives/submit/status

Request Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID for the specific advertiserintegerYA valid advertiser ID
creativeIdThe ID of the creativestringYA valid creative ID
creativeStateIdCreative state ID is a UUID returned from POST/creatives/preview. It links the state of the creative which was previewed.stringYValid creativeStateId

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease 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_SIGNATUREAuth signature as an API key.YUse the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.Y1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.YUse the signature generator code from Getting Started Guide to generate this value

Sample Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/submit/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-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779'
--data "{ "advertiserId": 123, "creativeId": "e02a09b2-1e3c-2g22-bf47-8a123c35002a", "creativeStateId": "b02a09b2-1e3c-2g22-bf47-8a123c35002a" }"

Response

ElementDescriptionType
response
  • data type string
  • Values: in_progress, completed, failed
    Note:
    • completed: The creative has been successfully submitted for review
    • in_progress: The submission is still being processed.
    • failed: Request to submit creative for approval failed
string
totalResultsNumber of responses returned by the API that match the request criteriainteger

Sample Response

{ "totalResults": 1, "response": [ { "status": "completed" } ]
}