HomeGuidesAPI Reference
Guides

List Brands

Retrieve the list of advertiser's brands

📘

POST/api/v1/brands/list

Request Parameters

ParametersNotesTypeRequiredPossible Values
advertiserIdID of advertiser integerYUnique numeric identifier
isRestrictedspecifies whether to retrieve from list of advertiser's brands or all brands

Note:
  • Default value of isRestricted is true
  • filter[brandName] is mandatory if isRestricted = false
BooleanNValues:
  • true
  • false
filter[brandName]Specify the name of the brand to search for

Note:
  • Required if isRestricted = false
  • Supports 'exact' match
stringNValid brand name for items to be retrieved
startIndexUse this parameter to fetch specific number of brands from a list, in combination with count.

This indicates the starting position of the list

Note: Value of startIndex must be greater than and equal to 0. The default value is 0_		integerNInteger value

Example: To return the first ten catalog item brands, set startIndex=0 and count=10
countDefines the total number of items to be returned.
You can use this parameter in combination with startIndex, to fetch specific number of item brands from a list.

Note: Value of count must be greater than 0. The default value is 100		integerNInteger value

Example: To return the first ten catalog item brands, set startIndex=0 and count=1

Note:
"The error message TOO_MANY_FILTERS_PROVIDED_IN_REQUEST is returned when too many filters are used and the request is not processed"


Sample Request

curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/brands/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, "isRestricted": true, "filter[brandName]": ["Brand Name"], "startIndex": 0, "count": 5 } '

Response

ElementDescriptionType
codeThe response code can have following values:
• success
• failure		string
detailsDetails will populate an error message in case of code=failurestring
totalResultsTotal number of rows returned in the responseinteger
datadata will populate details of brands retrieved through request, if code is success
  • brandName: Brand name
  • itemCount: Count of items in the brand
array

Sample Response

{ "code": "success", "totalResults": 1, "data": [ { "brandName": " Brand Name", "itemCount": 891 } ]
}

Updated about 1 month ago