Create Brand Asset
URL: POST /api/v1/brand_assets
Note: If you are a 3P seller trying to create a Brand Asset, you need to have an accepted brand registered in the Walmart brand portal. Including brands that are not approved will result in an error
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | Advertiser Id | string | Y | Unique advertiser ID |
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| brandAssetName | Brand name to be updated | string | Y | The name of the brand asset |
| promotedBrand | Brand that will be shown in the ad as “Sponsored by brand” | string | Y | Valid brand name Note: The character limit is 35 characters |
| associatedBrands | All brands to feature in your Sponsored Brands ad | string | Y | Valid brand name Note: The character limit is 255 characters |
| headlineText | Custom headline text showcasing why customers should buy your products. This is for the promoted brand. | string | Y | Piece of text that explains your brand value with the following constraints:
|
| clickUrl | The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad | string | Y | Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of:
clickUrl requirements:
|
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 |
Sample Request
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/brand_assets?advertiserId=400001' \ --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' \ --data '[ { "brandAssetName": "Brand Name to be updated", "promotedBrand": "main brand", "associatedBrands": ["brand1", "brand2"], "headlineText":"Example Headline Text", "clickUrl":"https://www.walmart.com/2" }
]' Response
| Parameter | Description | Type |
|---|---|---|
| brandAssetID | ID of the newly created brand asset | integer |
| code | Status of the brand asset request, either success or failure | string |
| details | Additional details if code is failure | string |
Sample Response
[ { "brandAssetId": 6000000, "code": "success", "details": "" }
]
Updated about 1 month ago