Note:

PUT API requests will overwrite all current values and are not intended to be used as incremental updates like PATCH operations
Halo itemsets that have been auto generated, cannot be updated
Updating Featured (measurement) itemsets - You can only update item based Featured (measurement) itemsets. Older Featured (measurement) itemset that might be brand based cannot be updated unless it's converted to a brand based itemset

📘
URL: PUT/api/v1/itemset

Request Parameters

Parameter	Notes	Type	Required	Possible Values
advertiserId	ID of the advertiser	integer	Y	Unique numeric identifier
itemsetId	ID of itemset	integer	Y	Unique numeric identifier
name	Name of itemset	string	N	Name of itemset
description	Description of itemset	string	N	String value
class	specifies whether the itemset is used for measurement or targeting Note: The 'class' field cannot be modified during an update; any value provided for it in the request will be ignored.	string	N	MEASUREMENT, TARGETING. (Default value: MEASUREMENT)
type	Specifies whether the itemset being created is based on a list of items, brands, categories, or a combination of these elements Note: Featured itemsets can be only item based	string	Y	Values: item brand category hybrid
editable	Indicates whether the itemset is configured to be edited post creation Note: It supports only true for now	string	N	Value: true
brands Note: Relevant only when creating a brand-based itemset (where type = brand)	List of brands to be added to the itemset. This is an array for brand names. Note: Specify the brand names.	array of strings	Conditional. Required if type=brand and no brand based expression added	Brand names
items Note: Relevant only when creating an item-based itemset (where type = item)_	List of items to be added to the itemset. The items objects are detailed here .	array of objects	Conditional. Required if type=item and no item based expression added	Values: id itemType
expression	Logical expression defining the itemset criteria. “expression” object specifies logical OR operation between Item, Brand and Category The expression objects are detailed here Special rules: For items with catalog = UNIVERSAL in POST /api/v1/items/list, only GTIN should be used If catalog is not UNIVERSAL, other itemType values (STORES, ONLINE, UPC) are allowed. Values for attributes.type and attributes.values applicable for a category can be retrieved from POST/api/v1/taxonomies/list	json	Conditional.Required if neither items nor brands are passed	Refer details of expression object below

Note: At least one of items, brands, or expression is required.

items Objects

Parameters	Notes	Type	Required	Possible Values
id	Unique identifier for the item Note: For items with catalog = UNIVERSAL in POST /api/v1/items/list, use GTIN IDs	string	Y	Unique ID value
itemType	Type of the item ID	string	Y	gtin, upc, stores, onli

expression Objects

Each block in the or array represents a targeting clause. At least one clause must be provided.

Parameters	Notes	Type	Required	Possible Values
type	Type of expression.	Y	string	item, brand,category
value	Object specifying the matching criteria. Structure depends on the type	Y	json

value object (based on type) `When type is item`:

Parameters	Notes	Type	Required	Possible Values
itemId	Unique identifier for the item Note: For items with catalog = UNIVERSAL in POST /api/v1/items/list, use GTIN IDs	Y	string
itemType	Type of the item ID.	Y	string	gtin, upc, stores, online

value object (based on type) `When type is brand`:

Parameters	Notes	Type	Required	Possible Values
name	Brand name	Y	string

value object (based on type) `When type is category`:

use POST /api/v1/taxonomies/list to get details of category and available attributes

Parameters	Notes	Type	Required	Possible Values
name	Name of the category. (This field case sensitive)	Y	string
level	level of the category hierarchy	Y	integer	Allowed values: 1,2,3
attributes	Additional filters for category-based selection. Each object inside the “attributes” array contains:	N	array

attributes Objects

Parameters	Notes	Type	Required	Possible Values
type	Type of attribute	Y	string	Allowed values: age_group, diet_type, allergens_not_contained, skin_type, item_gender, clothing_size_group, ib_ingredient_preference, ingredient_properties
values	List of values for the attribute.	Y	array

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: Update Itemsets using Brands

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "targeting", "type": "brand", "editable": "true", "brands": [ "abc", "xyz" ] } ]'

Sample Request: Update Itemsets with Items List

ccurl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "measurement", "type": "item", "editable": "true", "items": [ { "id": 123456789, "itemType": "gtin" }, "id": 123456790, "itemType": "gtin" } ] } ]'

Sample Request: Update Itemsets using Brands Expression

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "targeting", "type": "brand", "editable": "true", "expression": { "or": [ { "type": "brand", "value": { "name": "pepsi" } }, { "type": "brand", "value": { "name": "red bull" } } ] } } ]'

Sample Request: Update itemsets using category Expression

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "targeting", "type": "category", "editable": "true", "expression": { "or": [ { "type": "category", "value": { "name": "baby food", "level": 1 } }, { "type": "category", "value": { "name": "Quilting Basting Guns", "level": 1 } } ] } } ]'

Sample Request: Update itemsets using hybrid Expression

Note:

Please use 'gtin' as the "itemType" in the call, if the type of catalog is returned "universal " in the response of the call POST/api/v1/items/list
type should be "hybrid" if we are adding a different type to the original itemset type

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "targeting", "type": "hybrid", "editable": "true", "expression": { "or": [ { "type": "item", "value": { "itemId": "123456789", "itemType": "gtin" } }, { "type": "item", "value": { "itemId": "123456789", "itemType": "gtin" } }, { "type": "brand", "value": { "name": "pepsi" } }, { "type": "category", "value": { "name": "baby food", "level": 1 } } ] } } ]'

Sample Request: Update Itemsets using category expression with attributes

curl -X PUT \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemset' \ --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, "itemsetId": 123, "name": "string", "description": "itemset description", "class": "targeting", "type": "category", "editable": "true", "expression": { "or": [ { "type": "category", "value": { "name": "baby food", "level": 1, } "attributes": [ { "type": "age_group", "values": [ "Infant", "toddler" ] }, { "type": "skin_type", "values": [ "all", "sensitive" ] } ] } }, { "type": "category", "value": { "name": "Quilting Basting Guns", "level": 1 } } ] } } ]'

Response

Element	Description	Type
code	The response code can have following values: success failure Click here for more information about Status Codes and Errors	string
details	Details of the error if value of response code is failing	string
itemsetId	ID of the item set	integer

Update Itemset Success Response

[ {   "code": "success",      "details": "string",      "itemsetId": 123 } ]

Update Itemset Failure Response

{ "code": "failure", "details": ["error code"]
}

📘URL: ​ PUT/api/v1/itemset

Request Parameters

items Objects

expression Objects

value object (based on type) When type is item:

value object (based on type) When type is brand:

value object (based on type) When type is category:

attributes Objects

Headers

Sample Request: Update Itemsets using Brands

Sample Request: Update Itemsets with Items List

Sample Request: Update Itemsets using Brands Expression

Sample Request: Update itemsets using category Expression

Sample Request: Update itemsets using hybrid Expression

Sample Request: Update Itemsets using category expression with attributes

Response

Update Itemset Success Response

Update Itemset Failure Response

📘
URL: PUT/api/v1/itemset

value object (based on type) `When type is item`:

value object (based on type) `When type is brand`:

value object (based on type) `When type is category`: