Every item in your product catalogue should be expressed as a product entity in Zaius. Products can be associated with categories which can either be a flat category (Laptops) or hierarchical category using " > " as delimiters (Electronics > Computers > Laptops). You must use " > " as a delimiter, including a space before and after the symbol.

zaius.entity("product", 
            {product_id: "A13847388",
						 category: "Apparel > T-Shirts",
             name: "ZAIUS T-shirt (Medium Mens)",
             brand: "ZAIUS"});
POST /v2/entities
Host: api.zaius.com
Content-Type: application/json
Zaius-Tracker-Id: <YOUR TRACKER ID>

{"type": "product",
"data": {"product_id": "A13847388",
         "category": "Apparel > T-Shirts",
         "name": "ZAIUS T-shirt (Medium Mens)",
         "brand": "ZAIUS"}
}
curl -H 'Content-Type: application/json' -H 'Zaius-Tracker-Id: <YOUR TRACKER ID>' -d '{
"type": "product",
"data": {"product_id": "A13847388",
         "category": "Apparel > T-Shirts",
         "name": "ZAIUS T-shirt (Medium Mens)",
         "brand": "ZAIUS"}
}' https://api.zaius.com/v2/entities

All entity calls are additive, meaning you can provide just updated details for a product without specifying all the fields. If you wish to unset a field then provide the empty string as the value ("") or your programming language's null symbol (javascript null, ruby nil).

Product Fields

Zaius has a number of pre-defined fields for products. You can add new fields to product entities via Custom Fields.

Field
Description

product_id
string, required

Unique identifier for the product. This identifier is used to link events with products.

category
string

The category for the product. This can either be a flat category (Laptops) or hierarchical category using " > " as delimiters (Electronics > Computers > Laptops). You must use " > " as a delimiter, including a space before and after the symbol.

name
string

Name of the product.

brand
string

Brand of the product.

sku
string

Product SKU.

upc
string

Product UPC.

image_url
string

URL of the image of the product.

price
number

Cost of the item.

parent_product_id
string

This is a reference to another product_id in the database that is the more generic product record for this item. This field is not actively used by Zaius and may be left empty unless you need it to construct a campaign.

Products


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.