Products

Overview

The Products object is a "stateful" object, meaning it stores the current state of your product inventory.

Events & Orders refer to this object to get additional metadata about a product (e.g. price) by utilizing the product_id

Fields

Required Fields

Display Name

Field Name

Data Type

Description

Product ID

product_id

String

The unique identifier for the product. Referenced from Events.

Display Name

Field Name

Data Type

Description

Parent Product ID

parent_product_id

Text

A reference to another product in the table that groups the products together

Name

name

Text

The name of the product displayed to your customers

Brand

brand

Text

The brand of the product

SKU

sku

Text

The unique SKU of the product

UPC

upc

Text

The unique UPC of the product

Image URL

image_url

Text

The URL path to the product's image (including the protocol)

Price

price

Number

The price of the product

Quantity

custom field

Number

The available inventory in stock for the product. This is created as a custom field in your Zaius account

Product URL

custom field

Text

The URL path (including the protocol) to the product's detail page, or a handle or key that can be consistently formed into the URL for all products

Create additional custom fields for key attributes that you may want to make available for reporting, filtering in emails, or displaying in content.

A Note on Parent Products

The product-to-parent product relationship is a self-referential hierarchy. The parent product ID refers to the product id of another record on the product table. Within the Zaius app, there is reporting on parent product names, id, images, etc, as well as the ability to bring these parent products dynamically into emails based on qualifying products. These parent product values are set by querying for the product id that is referred to in the parent product id field of a target product. A parent product name, for example, is the name field in the product record with the same id referenced as the parent product id on the child record. The highest level parent in the hierarchy should reference its own product id as the parent product id. As a best practice, parent product ids should reference actual products that are included on the product object.

Product Events

type

action

product_id

product

detail

123

product

add_to_cart

123

product

remove_from_cart

123

product

add_to_wishlist

123

product

remove_from_wishlist

123

Importing & Updating Products

The Products object contains the current state of your product inventory, it does not store historical information about the product. Common reasons to update the Products object:

  • Updating Inventory

  • Updated Product Images

  • Release of New Products

There are a number of methods to update the Products object:

Updates to the Products object should adhere to the schema defined above.