Upload Creative Image

Upload images for building a Creative for a specific advertiser

📘

URL: ​POST/api/v1/assets/photo

Request Parameters

ParameterDescriptionTypeRequiredPossible Values
fileThe binary data for the suitable image file demonstrating your creativefileYThe file should be:
  • Any image file of the format: jpeg/png
  • Max file size 10 mb
  • Max dimensions 5000px*5000px

Sample Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/assets/photo' \
--header 'X-Advertiser-ID: <advertiser_id>' \
--header 'Content-Type: multipart/form-data'\
--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'\
--form 'file=@"/test-image.jpeg" '

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

Note: advertiser_id is serving as header parameter in this request. This header is X-Advertiser-ID. If You pass a request with headers like advertiserId=123, the request will fail.

Response

ElementDescriptionType
codePossible values of response code:
  • success
  • failure
string
detailsPossible values of details:
  • Details of the error if value of response code is failure
  • It returns a string value "success" if value of response code is success
string
assetIdIdentifier for the image uploaded. Use assetId to use this image while building creativesstring

Sample Response

[ { "code": "success", "details": ["success"], "assetId": "123d567-g7ty" } ]