HomeGuidesAPI Reference
Guides

List Taxonomies

Retrieve list of taxonomies

📘

POST/api/v1/taxonomies/list

Request Parameters

ParametersNotesTypeRequiredPossible Values
advertiserIdID of advertiser integerYUnique numeric identifier
filter[level]Specifies the depth of the taxonomy hierarchy to return.

level= 1: returns only department
level= 2: returns department & category
level= 3 returns department, category & subcategory

Note: default value is 3		integerNValues: 1,2,3
filter[brandName]Taxonomy applicable to the specified brand is returned

Note: Supports 'exact' match		stringNValid brand name for taxonomy list to be retrieved
filter[department]Retrieve taxonomy hierarchy for the given department

Note:
  • This parameter is case insensitive
  • Supports 'exact' match
stringNValid department
filter[category]Retrieve taxonomy hierarchy for the given category

Note:
  • This parameter is case insensitive
  • Supports 'exact' match
stringNValid category
filter[subCategory]Retrieve taxonomy hierarchy for the given subcategory

Note:
  • This parameter is case insensitive
  • Supports 'exact' match
stringNValid subcategory
filter[brandName]Specify to fetch list of items in the designated brand

Note:
  • Supports 'exact' match
stringNValid brand name
startIndexUse this parameter to fetch specific number of items 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 items, 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 items 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 items, 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/taxonomies/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[level]": 3, "filter[brandName]": ["MM6"], "filter[department]": ["Clothing"], "filter[category]": ["Accessories"], "filter[subCategory]": ["Handbags"], "startIndex": 0, "count": 5, }'

Get List of taxonomies-Without any filters Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16534, }'

List of taxonomies-With only Level 1 Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354,
"filter[level]": 1
}'

Get List of Taxonomies-With only Brand Filter

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354,
"filter[brandName]": ["MM6 by Mason"]
}'

Get List of Taxonomies-With only department Filter

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354254,
"filter[department]": ["Office"]
}'

Get List of Taxonomies-With combination of department and category

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354, "filter[department]": ["Office"], "filter[category]": ["Tape & Adhesives" ] }'

Get List of Taxonomies-Combination of department and level=2 Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354,
"filter[level]": 2,
"filter[department]": ["Office"]
}'

Get List of Taxonomies-Combination of category and level=1 Request

curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/taxonomies/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": 16354,
"filter[level]": 1,
"filter[category]": ["Tape & Adhesives"] }'

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 items, retrieved through request if code is success
  • level:
    • level 1= department
    • level 2 = category
    • level 3 = subcategory
      Note: default value is 3
  • name:  taxonomy name
  • ItemCount: Count of items for specific node at specific level
  • attributes: attributes specific to a taxonomy list at a specific level
    • type
    • values: Value of attribute
      • count: Count of attributes
      • value: Value of attribute
  • taxonomies: Elements of taxonomy
    • level: Specifies the depth of the taxonomy hierarchy to return
    • name
    • itemCount: Count of items for specific node at specific level
    • attributes: attributes specific to a taxonomy list at a specific level
      • value: Value of attribute
      • count: Count of attributes

Sample Response - Get List of taxonomies

 "code": "success", "totalResults": 8, "data": [ { "level": 1, "name": "x", "attributes": { "type": "age_group", "values": [ { "value": "Child", "count": 25 }, { "value": "Adult", "count": 589 } ] }, "taxonomies": { "level": 2, "name": "y", "attributes": { "type": "age_group", "values": [ { "value": "Child", "count": 25 }, { "value": "Adult", "count": 589 } ] } }, "taxonomies": { "level": 3, "name": "z", "itemCount": 8661, "attributes": { "type": "age_group", "values": [ { "value": "Child", "count": 25 }, { "value": "Adult", "count": 589 }, { "value": "Toddler", "count": 8 } ] } } } ]
}

Sample Response - Get List of taxonomies Without any filter

{ "code": "success", "totalResults": 1, "data": [ { "level": 1, "name": "x", "taxonomies": { "level": 2, "name": "y", "taxonomies": { "level": 3, "name": "z", "itemCount": 11638 } } } ]
}

Sample Response - Get List of taxonomies-With only Level 1


{ "code": "success", "totalResults": 1, "data": [ { "level": 1, "name": "Health & Beauty", "itemCount": 2, "attributes": { "type": "age_group", "values": [ { "value": "Child", "count": 25 }, { "value": "Adult", "count": 589 } ] } } ]
}

Sample Response - Get List of taxonomies-With only Brand Filter

{ "code": "success", "totalResults": 1, "data": [ { "level": 1, "name": "Health & Beauty", "taxonomies": { "level": 2, "name": "y", "taxonomies": { "level": 3, "name": "z", "itemCount": 247628 } } } ]
}

Sample Response - Get List of taxonomies-With only Department Filter

{ "code": "success", "totalResults": 1546, "data": [ { "level": 1, "name": "x", "taxonomies": { "level": 2, "name": "y", "taxonomies": { "level": 3, "name": "z", "itemCount": 247628 } } } ]
}

Updated about 1 month ago