Product

Example

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

{
  "id":"product::86353",
  "type":"product",
  "client":"example-client",
  "creationTime":"2017-01-05T09:12:06.000Z",
  "lastModificationTime":"2017-06-15T04:35:26.806Z",
  "externalId":"86353",
  "brandReference":{
    "client":"example-client",
    "id":"876o876o876ho875v765fi765",
    "type":"brand"
  },
  "attributesByLocale":{
    "default":{
      "BV_FE_EXPAND":[
        "BV_FE_FAMILY:86353"
      ],
      "BV_FE_FAMILY":[
        "86353"
      ],
      "DESCRIPTION":[
        "N/A"
      ],
      "IMAGE_URL":[
        "https://www.example.com"
      ],
      "MANUFACTURER_PART_NUMBER":[
        "86353"
      ],
      "MODEL_NUMBER":[
        "86353"
      ],
      "NAME":[
        "Outdoor Rangehoods"
      ],
      "PRODUCT_PAGE_URL":[
        "https://www.example.com.au/"
      ]
    }
  },
  "categoryReference":{
    "client":"example-client",
    "id":"8765",
    "type":"category"
  },
  "active": true
}

Relationships

Category

📘

This relationship is defined in the product catalogue feed Bazaarvoice receives from our client.

Products are children of categories. A product will only relate to a single category. This relationship is maintained on the product using the Category reference field.

Brand

📘

This relationship is defined in the product catalogue feed Bazaarvoice receives from our client.

A product may be associated with a single brand. This relationship is maintained on the product using the Brand reference field.

The following diagram depicts the relationship between a product and a brand:

Review

Reviews are children of products. A review can be associated with more than one product. Refer to the Review Parent Keys reference to learn how to join reviews and products.

Question

Questions are children of products. A question can be associated with more than one product. Refer to the Question Parent Keys reference to learn how to join questions and products.

Fields

Active

📘

This attribute is defined in the product catalogue feed Bazaarvoice receives from our client.

active: true

An active product, designated by "active": true, is one that is available for purchase and review. An inactive product, designated by "active": false, is one that is considered out-of-date, removed from production, and no longer available for purchase.

Attributes by locale

📘

This attribute is defined in the product catalogue feed Bazaarvoice receives from our client.

"attributesByLocale":{
  "default":{
    "BV_FE_EXPAND":[
      "BV_FE_FAMILY:86353"
    ],
    "BV_FE_FAMILY":[
      "86353"
    ],
    "DESCRIPTION":[
      "N/A"
    ],
    "IMAGE_URL":[
      "https://www.example.com"
    ],
    "MANUFACTURER_PART_NUMBER":[
      "86353"
    ],
    "MODEL_NUMBER":[
      "86353"
    ],
    "NAME":[
      "Outdoor Rangehoods"
    ],
    "PRODUCT_PAGE_URL":[
      "https://www.example.com"
    ]
  }
}

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

Brand reference

📘

This attribute is defined in the product catalogue feed Bazaarvoice receives from our client.

"brandReference":{  
  "client":"example-client",  
  "id":"876o876o876ho875v765fi765",  
  "type":"brand"  
}

The name of the brand to which the product belongs. This value may be different than your client name. For example, retailers sell products manufactured by many different brands.

Category reference

📘

This attribute is defined in the product catalogue feed Bazaarvoice receives from our client.

"categoryReference":{  
  "client":"example-client",  
  "id":"8765",  
  "type":"category"  
}

The parent category for this product. Refer to the Relationships section in this document to learn how to join a category reference with an product.

Client

"client":"example-client"

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

📘

If this value is not your client name, then this content has been syndicated to you from the client identified.

Creation time

"creationTime":"2017-01-05T09:12:06.000Z"

When the content was created in the Bazaarvoice system.

External ID

📘

This attribute is defined in the product catalogue feed Bazaarvoice receives from our client.

"externalId":"86353"

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

ID

"id":"product::86353"

This ID is generated by Bazaarvoice based on the External ID.

Last modification time

"lastModificationTime":"2017-01-21T16:28:58.736Z"

When this content was most recently modified.

Type

"type":"product"

The content type.