HomeGuidesAPI ReferenceRelease NotesAPI Changelog
Guides

Retrieve Brand Asset

📘

URL: GET /api/v1/brand_assets

Query Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdID of the advertiserintegerYUnique advertiser ID
brandAssetIdID of the brand asset to be retrievedintegerYUnique brand asset ID

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 GET \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/brand_assets?advertiserId=400000&brandAssetId=600000' \ --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' \

Response

ParameterDescriptionType
brandAssetIDID of the retrieved brand assetinteger
brandAssetNameName of the brand assetstring
promotedBrandBrand that will be shown in the ad as “Sponsored by brand”string
associatedBrandsAll brands to feature in your Sponsored Brands adstring
headlineTextCustom headline text showcasing why customers should buy your productsstring
logoUrlThe URL of the logo imagestring
clickUrlThe website address that a visitor lands on when he/she clicks on the ad. Clickable URL must be a https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of the following:
  1. Search Page
  2. Browse Page
  3. Brand Shop
  4. Brand Shelf
string
customImageUrlThe URL of the custom image.string
statusThe status of the brand assetstring
createdAtThe date/time when the brand asset was created, in ISO 8601 timezone formatdate
adGroupsThe ad groups for which the brand asset is applicable to. Possible values:
  1. id: The ad group ID of the ad group that the brand asset has been added to
  2. status: Status of the ad group that the brand asset has been added to
  3. campaignId: the id of the campaign that the adGroup belongs to
JSON object

Sample Response

 { "brandAssetId": 600000, "brandAssetName": "brand asset lifestyle", "promotedBrand": "main brand", "associatedBrands": ["brand1", "brand2"], "headlineText": "example headline text", "logoUrl": "logo URL", "clickUrl": "https://www.walmart.com", "customImageUrl": null, "status": "draft", "createdAt": "2025-05-11T21:02:32.516-08:00", "adGroups": [ { "id": 100001, "status": "enabled", "campaignId": 600003 }, { "id": 100002, "status": "enabled", "campaignId": 600003 }, { "id": 100005, "status": "enabled", "campaignId": 600003 }, { "id": 100003, "status": "enabled", "campaignId": 600004 }, { "id": 100004, "status": "enabled", "campaignId": 600004 }, { "id": 100010, "status": "enabled", "campaignId": 600004 } ] }

Updated about 2 months ago