📘
URL: POST /api/v1/brand_assets/custom_image_upload
| Parameter | Description | Type | Required | Possible Values |
|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique advertiser ID |
| BrandAssetUploadRequest | BrandAssetUploadRequest is a JSON object specifying brandAssetId | string | Y | 'BrandAssetUploadRequest="{"brandAssetId": "<BRANDASSET_ID>"} |
| Parameter | Description | Type | Required | Possible Values |
|---|
| file | Local file path to the desired image to be uploaded | string | Y | - File format : JPG or PNG
- Recommended size 200KB, max 1MB
- Ratio : 16:9
- Dimensions: Minimum: 1200x675px or higher
- Image content: No text, graphics or logos
|
| 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 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/brand_assets/custom_image_upload?advertiserId=400000' \ --header 'accept: 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' \ --form 'BrandAssetUploadRequest="{"brandAssetId": "10159"}"' \ --form 'file=@"placeholder-address:///1eec50a0-7267-4610-b8f1-64b35fb12345"'
| Parameter | Description | Type |
|---|
| brandAssetId | The ID of the brand asset to be updated | integer |
| code | The response code can have following values:  success, failure
Click here for more information on API Status Codes and Errors | string |
| details | Details of the error if value of response code is failure. | string |
{ "brandAssetId": 10159, "code": "success", "details": ""
}
