API Reference

List Brand Landing Page

post
https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/brand-landing-pages/list

In this List Api we get brand landing pages to extract brand Landing page URLs.

Body Params
int64
required

The ID of the specific advertiser.

int32
≥ 0
Defaults to 0

Index to start returning results. This indicates the starting position of the list. The default value is 0.

startIndex must be a multiple of count (0, count, 2 × count, ...). Requests where
startIndex % count != 0 are rejected with INVALID_START_INDEX_VALUE.

Note: To return the first ten pages, set startIndex to 0 and count to 10.

int32
1 to 100
Defaults to 100

Number of pages to return. The maximum value is 100 and the minimum value is 1. The default value is 100.

Note: To return the first ten pages, set startIndex to 0 and count to 10.

Filter[itemsetIds]
array of strings
length ≤ 25

Filter by Itemset using which the page was created. Multiple itemsetIds can be specified, separated by comma.
The maximum number of itemsetIds that can be specified is 25.

Filter[itemsetIds]
string
enum

Filter by type of page.

Allowed:
string

Filter by Brand Name.

string

Filter by Page Title.

Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API.
It is same for all advertisers you access through the API. The allowed value is 1.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

This is bearer token.
The token will provide you the access to the API. It is same for all advertisers you access through the API.

Responses

Updated 10 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?