Category

Example

The following is a generalized example. Actual categories will vary based on configurations. Continue to the Fields section for information on each field.

{
  "id":"category::2343",
  "type":"category",
  "client":"example-client",
  "creationTime":"2014-10-20T07:31:34.000Z",
  "lastModificationTime":"2016-11-16T20:12:03.555Z",
  "externalId":"2343",
  "attributesByLocale":{
    "default":{
      "CATEGORY_PAGE_URL":[
        "https://www.example.com.au/juicers/"
      ],
      "NAME":[
        "Juicers"
      ]
    }
  },
  "categoryHierarchy":[
    {
      "client":"example-client",
      "id":"category::2343",
      "type":"category"
    },
    {
      "client":"example-client",
      "id":"category::454",
      "type":"category"
    },
    {
      "client":"example-client",
      "id":"category::65",
      "type":"category"
    }
  ]
}

Relationships

Category

A category can be the child of a parent category. This relationship is maintained on the category using the Category Hierarchy field.

Product

Products are children of categories. Refer to the Product Reference to learn how to join products and categories.

Fields

Attributes by locale

"attributesByLocale":{
  "default":{
    "CATEGORY_PAGE_URL":[
      "https://www.example.com.au/juicers/"
    ],
    "NAME":[
      "Juicers"
    ]
  }
}

Custom attributes supplied by the client to define additional category-specific information. These attributes are used to report on category-specific information in the Bazaarvoice portal (AKA: Workbench).

Category hierarchy

"categoryHierarchy":[  
    {  
      "client":"example-client",  
      "id":"category::2343",  
      "type":"category"  
    },  
    {  
      "client":"example-client",  
      "id":"category::454",  
      "type":"category"  
    },  
    {  
      "client":"example-client",  
      "id":"category::65",  
      "type":"category"  
    }  
  ]

Lists the relationship between categories, starting with the current category. A category can have a single parent. The first item in the categoryHierarchy array will be the current category. The next item will be the parent of the previous item, until a category with no parents is reached. This is the "root" category. A root category record in the DCE will only have a single item in categoryHierarchy, which will refer to itself. In the example above category::454 is the parent of category::2343. category::65 is the root category and is the parent of category::454. Refer to the Relationships section in this document to learn how to join categories.

Client

"client":"example-client"

The client from where this content originates. The source client.

Creation time

"creationTime":"2014-10-20T07:31:34.000Z

When the content was created in the Bazaarvoice system.

External ID

"externalId":"2343"

The identifier for the content provided by content owner. This ID is provided by the client who submitted the product to Bazaarvoice.

ID

"id":"category::2343"

This ID is generated by Bazaarvoice.

Last modification time

"lastModificationTime":"2016-11-16T20:12:03.555Z"

When this content was most recently modified.

Type

"type":"category"

The content type.