List Brand Landing Page
Use this endpoint to retrieve a paginated list of live brand or shelf pages available to the advertiser, for use as landing page in onsite display campaigns. Note that while add a featured itemset to a campaign, a brand shelf page is automatically created
URL: POST/api/v1/brand-landing-pages/list
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| Filter[itemsetIds] | Filter by Itemset using which the page was created (MaxSize = 25) | array | N | Valid itemsetIds separated by comma |
| Filter[pageType] | Filter by type of page | string | N |
|
| Filter[pageTitle] | Filter by Page Title | string | N | |
| Filter[brandName] | Filter by Brand Name | string | N | |
| startIndex | Index to start returning results.This indicates the starting position of the list | integer | N | A range of 0 to length of the list minus one Example: To return the first ten itemsets entries, set startIndex=0 and count=10 |
| count | Number of pages to return | integer | N | Number of itemsets that you want to fetch in response to this call Note: defaultCount=100, maxCount = 100, minCount = 1 Example: To return the first ten itemset entries, set startIndex=0 and count=10 |
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- Fetch list of all brand pages without filters
curl -X POST \
'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/brand-landing-pages/list' \ --header 'Content-Type: 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 '{ "advertiserId": 19000
}'
Sample Request- Fetch list of all brand pages with filters
curl -X POST \
'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/brand-landing-pages/list' \ --header 'Content-Type: 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 '{ "advertiserId": 1, "Filter[pageType]": "shelf", "Filter[pageTitle]": "pageTitle1", "Filter[brandName]": "brandName1", "Filter[itemsetIds]": [ "itemsetId1", "itemsetId2" ], "startIndex": 0, "count": 100
}'
Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code: • success • failure | string |
| totalResults | Total number of results matching the search filter | integer |
| pages | List of response pages | array |
| details | List of messages incase of failure | array |
Each object in the pages array will be a list of Brand landing page with metadata
| Element | Description | Type |
|---|---|---|
| pageId | Unique Id of the page | string |
| pageUrl | URL of the brand shop or shelf page | string |
| advertisingUrl | The URL recommended to be used as landing page when someone clicks on ad | string |
| pageTitle | Page title | string |
| pageType | Page type | string |
| brandName | Brand name | string |
| itemsetId | ID of the measurement itemset that triggered this page’s creation. Not applicable for pages created manually through the Brand Shop account in WAC. | string |
Guidelines:
- If you want to set your creative’s landing page to a Brand Shop or Shelf page, use the advertisingUrl
Sample Response Success - Fetch list of all brand pages without filters
"code": "success", "totalResults": 2, "pages": [ { "pageId": "1", "pageUrl": "http://walmart.com/test/111", "advertisingUrl": "http://walmart.com/test/111/abc", "pageTitle": "Test Page 1", "pageType": "brand", "brandName": "Brand1", "itemsetId": "itemsetId1" }, { "pageId": "2", "pageUrl": "http://walmart.com/test/222", "advertisingUrl": "http://walmart.com/test/222/def", "pageTitle": "Test Page 2", "pageType": "shelf", "brandName": "Brand2", "itemsetId": "itemsetId2" } ]
}
Sample Response Failure - Fetch list of all brand pages without filters
{ "code": "failure", "details": ["string"]
}
]
Sample Response Success - Fetch list of all brand pages with filters
{ "code": "success", "totalResults": 2, "pages": [ { "pageId": "3", "pageUrl": "http://walmart.com/test/333", "advertisingUrl": "http://walmart.com/test/333/def", "pageTitle": "Test Page 3", "pageType": "shelf", "brandName": "Brand3", "itemsetId": "itemsetId1" }, { "pageId": "4", "pageUrl": "http://walmart.com/test/444", "advertisingUrl": "http://walmart.com/test/444/def", "pageTitle": "Test Page 4", "pageType": "shelf", "brandName": "Brand3", "itemsetId": "itemsetId2" } ]
}
Sample Response Failure - Fetch list of all brand pages with filters
{ "code": "failure", "details": ["string"]
}
]
Updated 3 days ago