Skip to main content

Brand details object definition and links to validations

Properties

ParentNameTypeInput
$.brandDetailsobject
REQUIRED
brandDetailscategories[]array
REQUIRED
brandDetailscountryCodes[]array
REQUIRED
brandDetailsdisplayNames[]array
REQUIRED
brandDetailsurls[]array
REQUIRED
brandDetailspartnersBrandIdstring
OPTIONAL
brandDetailspartnersBrandVersionstring
OPTIONAL
brandDetailsownershipTypestring
OPTIONAL

JSON Data Samples

Brand Satisfying Minimal Data Requirements
{
"brandDetails": {
"countryCodes": [ "US" ],
"displayNames": [
{
"name": "Walmart Supercenter",
"locale": "en",
"primary": true
}
],
"categories": [ "shopping.store.discount_store", "shopping.store.home_goods_store", "shopping.store.department_store", "shopping.store.electronics_store", "shopping.food_mart.grocery_store" ],
"urls": [
{
"url": "https://www.walmart.com",
"type": "HOMEPAGE"
}
]
}
}
Brand - Full Example
{
"brandDetails": {
"partnersBrandId": "456456",
"partnersBrandVersion": "PBV01",
"countryCodes": [ "US" ],
"displayNames": [
{
"name": "Walmart Supercenter",
"locale": "en",
"primary": true
},
{
"name": "Walmart",
"locale": "en",
"primary": false
}
],
"categories": [ "shopping.store.discount_store", "shopping.store.home_goods_store", "shopping.store.department_store", "shopping.store.electronics_store", "shopping.food_mart.grocery_store" ],
"urls": [
{
"url": "https://www.walmart.com",
"type": "HOMEPAGE"
},
{
"url": "https://www.facebook.com/walmart",
"type": "FACEBOOK"
},
{
"url": "https://twitter.com/Walmart",
"type": "TWITTER"
}
],
"ownershipType": "BRAND_OWNER"
}
}
NameReference
APILink