Upload Creative Image
Upload images for building a Creative for a specific advertiser
URL: POST/api/v1/assets/photo
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| file | The binary data for the suitable image file demonstrating your creative | file | Y | The file should be:
|
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 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 |
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
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
Click here for more information about Status Codes and Errors | string |
| details | Possible values of details:
| string |
| assetId | Identifier for the image uploaded. Use assetId to use this image while building creatives | string |
Sample Response
[ { "code": "success", "details": ["success"], "assetId": "123d567-g7ty" } ]
Updated 6 months ago