Segmentation Events & Properties Reference

Events and properties for building customer segments via the Omnisend API, organized by platform. Properties are ranked by real-world usage across Omnisend merchants.

Property Naming Across Platforms

The same conceptual data has different property paths per platform:

Concept	Shopify	WooCommerce	BigCommerce	API
Product category	`raw.product.collections.[].title`	`raw.product.categories.[].name`	`raw.product.categories.[].name`	`product.productCategories.[].title`
Product title	`raw.title`	`raw.product.name`	`raw.name`	`product.productTitle`
Product ID	`raw.product.id`	`raw.product.id`	`raw.product.id`	`product.productID`
Product SKU	`raw.sku`	`raw.sku`	`raw.sku`	`lineItems.[].productSKU`
Product tags	`raw.product.tags`	`raw.product.tags`	—	—
Order total	`raw._total_price`	`raw._total`	`raw._total_inc_tax`	`totalPrice`
Billing country	`raw.billing_address.country`	`raw.billing.country`	`raw.shipping_address.[].country`	`billingAddress.country`

Shopify

Origin: shopify

Segment by What Customers Bought — ordered product

Target customers based on purchase history — the most common segmentation use case across all platforms.

#	Property Path	Type	Description
1	`raw.product.collections.[].title`	`string`	Title
2	`raw.title`	`string`	Title
3	`raw.name`	`string`	Name
4	`raw.sku`	`string`	Sku
5	`raw.product.id`	`string`	Id
6	`raw.product.tags`	`array`	Tags
7	`raw.product_id`	`number`	Product Id

Segment by Order Placement — placed order

Target customers based on placed orders and line item details.

#	Property Path	Type	Description
1	`raw.line_items.[].product.collections.[].title`	`string`	Title
2	`raw.line_items.[].title`	`string`	Title
3	`raw.line_items.[].product.product_url`	`string`	Product Url
4	`raw.line_items.[].product_id`	`number`	Product Id
5	`raw._total_price`	`number`	Total Price
6	`raw.line_items.[].product.tags`	`array`	Tags
7	`raw.fulfillments.[].line_items.[].product_id`	`number`	Product Id

Segment by Fulfillment — order fulfilled

Target customers whose orders have been shipped or delivered.

#	Property Path	Type	Description
1	`fulfillment.shipment_status`	`string`	Shipment Status
2	`fulfillment.line_items.[].title`	`string`	Title
3	`fulfillment.line_items.[].product_id`	`number`	Product Id
4	`fulfillment.line_items.[].discount_allocations.[].amount`	`string`	Amount
5	`fulfillment.line_items.[].fulfillment_status`	`string`	Fulfillment Status
6	`fulfillment.line_items.[].duties.[].tax_lines.[].title`	`string`	Title

Segment by Cart Activity — added product to cart

Target customers who added items to cart — useful for abandoned cart flows and product interest signals.

#	Property Path	Type	Description
1	`added_item.product.collections.[].title`	`string`	Title
2	`raw.line_items.[].product.collections.[].title`	`string`	Title
3	`added_item.product_title`	`string`	Product Title
4	`added_item.options_with_values.[].name`	`string`	Name
5	`added_item.product.product_url`	`string`	Product Url
6	`raw.line_items.[].product_title`	`string`	Product Title
7	`added_item.product.tags`	`array`	Tags

Segment by Browsing Behavior — viewed product

Target customers based on product pages they viewed.

#	Property Path	Type	Description
1	`product.categories.[].title`	`string`	Title
2	`product.title`	`string`	Title
3	`page.title`	`string`	Title
4	`product.categories.[].id`	`string`	Id
5	`product.id`	`string`	Id
6	`page.url`	`string`	Url
7	`product._price`	`number`	Price

Segment by Checkout Activity — started checkout

Target customers who initiated checkout.

#	Property Path	Type	Description
1	`raw.name`	`string`	Name
2	`raw.line_items.[].product.collections.[].title`	`string`	Title
3	`raw._subtotal_price`	`number`	Subtotal Price
4	`raw._total_line_items_price`	`number`	Total Line Items Price
5	`raw.line_items.[].title`	`string`	Title
6	`raw.shipping_address.country`	`string`	country

Segment by Payment — paid for order

Target customers based on payment completion.

#	Property Path	Type	Description
1	`raw.line_items.[].product_id`	`number`	Product Id
2	`raw._total_price`	`number`	Total Price
3	`raw.line_items.[].title`	`string`	Title
4	`raw.line_items.[].product.collections.[].title`	`string`	Title
5	`raw._subtotal_price`	`number`	Subtotal Price
6	`raw.fulfillments.[].line_items.[].sku`	`string`	Sku
7	`raw.line_items.[].name`	`string`	Name

Segment by Cancellations — order canceled

Target customers whose orders were canceled.

#	Property Path	Type	Description
1	`raw.fulfillments.[].line_items.[].product_id`	`number`	Product Id
2	`raw.tags`	`string`	Tags
3	`raw.fulfillment_status`	`string`	Fulfillment Status
4	`raw.line_items.[].name`	`string`	Name
5	`raw.fulfillments.[].line_items.[].title`	`string`	Title
6	`raw.fulfillments.[].line_items.[].sku`	`string`	Sku
7	`raw.discount_applications.[].code`	`string`	Code

Segment by Refunds — order refunded

Target customers who received refunds.

#	Property Path	Type	Description
1	`refund.refund_line_items.[].line_item.title`	`string`	Title
2	`raw.line_items.[].name`	`string`	Name
3	`raw.line_items.[].variant_title`	`string`	Variant Title
4	`raw.refunds.[]._total_refunded_amount`	`float`	Total Refunded Amount
5	`raw.refunds.[].refund_line_items.[].line_item.title`	`string`	Title
6	`raw.contact_email`	`string`	Contact Email
7	`raw.fulfillments.[].line_items.[].variant_title`	`string`	Variant Title

WooCommerce

Origin: woocommerce

Segment by What Customers Bought — ordered product

Target customers based on purchase history — the most common segmentation use case across all platforms.

#	Property Path	Type	Description
1	`raw.name`	`string`	Name
2	`raw.product.categories.[].name`	`string`	Name
3	`raw.sku`	`string`	Sku
4	`raw.product.id`	`number`	Id
5	`raw.product.tags.[].name`	`string`	Tags
6	`raw.product_id`	`number`	Product Id
7	`raw.product.name`	`string`	Name

Segment by Order Placement — placed order

Target customers based on placed orders and line item details.

#	Property Path	Type	Description
1	`raw.line_items.[].product_id`	`number`	Product Id
2	`raw.line_items.[].product.tags.[].name`	`string`	Tags
3	`raw.line_items.[].product.categories.[].name`	`string`	Name
4	`raw.line_items.[].sku`	`string`	Sku
5	`raw.line_items.[].product.id`	`number`	Id
6	`raw.line_items.[].name`	`string`	Name
7	`raw.status`	`string`	Status

Segment by Fulfillment — order fulfilled

Target customers whose orders have been shipped or delivered.

#	Property Path	Type	Description
1	`raw.line_items.[].product_id`	`number`	Product Id
2	`raw.line_items.[].variation_id`	`number`	Variation Id
3	`raw.line_items.[].product.categories.[].name`	`string`	Name
4	`raw.line_items.[].name`	`string`	Name
5	`raw.line_items.[].product.tags.[].name`	`string`	Tags
6	`raw.coupon_lines.[].code`	`string`	Code

Segment by Cart Activity — added product to cart

Target customers who added items to cart — useful for abandoned cart flows and product interest signals.

#	Property Path	Type	Description
1	`added_item.product.categories.[].name`	`string`	Name
2	`added_item.product.tags.[].name`	`string`	Tags
3	`added_item.product.id`	`number`	Id
4	`added_item.product_id`	`number`	Product Id
5	`added_item.product.name`	`string`	Name
6	`added_item.product.sku`	`string`	sku
7	`raw.items.[].product.categories.[].name`	`string`	Name

Segment by Browsing Behavior — viewed product

Target customers based on product pages they viewed.

#	Property Path	Type	Description
1	`product.categories.[].title`	`string`	Title
2	`product.title`	`string`	Title
3	`page.title`	`string`	Title
4	`product.categories.[].id`	`string`	Id
5	`product.id`	`string`	Id
6	`page.url`	`string`	Url
7	`product.url`	`string`	Url

Segment by Checkout Activity — started checkout

Target customers who initiated checkout.

#	Property Path	Type	Description
1	`raw.items.[].product.name`	`string`	name
2	`raw.items.[].product.id`	`float`	id
3	`raw.items.[].product.categories.[].name`	`string`	Name
4	`raw.items.[].product.sku`	`string`	Sku

Segment by Payment — paid for order

Target customers based on payment completion.

#	Property Path	Type	Description
1	`raw.line_items.[].product_id`	`number`	Product Id
2	`raw._total`	`number`	Total
3	`raw.line_items.[].product.categories.[].name`	`string`	Name
4	`raw._total_subtotal`	`float`	Total Subtotal
5	`raw.line_items.[].name`	`string`	Name

Segment by Cancellations — order canceled

Target customers whose orders were canceled.

#	Property Path	Type	Description
1	`raw.line_items.[].product.categories.[].name`	`string`	Name
2	`raw._total`	`float`	Total
3	`raw.line_items.[].name`	`string`	Name
4	`raw.line_items.[].product.name`	`string`	Name
5	`raw.status`	`string`	Status
6	`raw.coupon_lines.[].code`	`string`	Code

Segment by Refunds — order refunded

Target customers who received refunds.

#	Property Path	Type	Description
1	`raw.line_items.[].name`	`string`	Name
2	`raw.line_items.[].product.name`	`string`	Name
3	`raw.fee_lines.[].name`	`string`	Name
4	`raw.line_items.[].sku`	`string`	Sku

BigCommerce

Origin: bigcommerce

Segment by What Customers Bought — ordered product

Target customers based on purchase history — the most common segmentation use case across all platforms.

#	Property Path	Type	Description
1	`raw.name`	`string`	Name
2	`raw.product.categories.[].name`	`string`	Name
3	`raw.sku`	`string`	Sku
4	`raw.product.id`	`number`	Id
5	`raw.product_id`	`number`	Product Id
6	`raw.product.description`	`string`	Description
7	`raw.product.categories.[].id`	`number`	Id

Segment by Order Placement — placed order

Target customers based on placed orders and line item details.

#	Property Path	Type	Description
1	`raw.lineItems.[].product.categories.[].name`	`string`	Name
2	`raw.shipping_address.[].country`	`string`	Country
3	`raw.lineItems.[].sku`	`string`	Sku
4	`raw.coupons.[].amount`	`string`	Amount
5	`raw.coupons.[].discount`	`string`	Discount
6	`raw.lineItems.[]._total_inc_tax`	`float`	Total Inc Tax
7	`raw.lineItems.[].applied_discounts.[].name`	`string`	Name

Segment by Cart Activity — added product to cart

Target customers who added items to cart — useful for abandoned cart flows and product interest signals.

#	Property Path	Type	Description
1	`added_item.product.categories.[].name`	`string`	Name
2	`added_item.sku`	`string`	Sku
3	`added_item.product.id`	`number`	Id
4	`added_item.id`	`string`	Id
5	`added_item.product.description`	`string`	Description
6	`raw.email`	`string`	Email
7	`raw.currency`	`object`	Currency

Segment by Browsing Behavior — viewed product

Target customers based on product pages they viewed.

#	Property Path	Type	Description
1	`product.categories.[].title`	`string`	Title
2	`product.title`	`string`	Title
3	`page.title`	`string`	Title
4	`product.categories.[].id`	`string`	Id
5	`product.id`	`string`	Id
6	`page.url`	`string`	Url
7	`product.url`	`string`	Url

API

Origin: api

Segment by What Customers Bought — ordered product

Target customers based on purchase history — the most common segmentation use case across all platforms.

#	Property Path	Type	Description
1	`product.productCategories.[].title`	`string`	Title
2	`product.productTitle`	`string`	Product Title
3	`product.productCategories.[].id`	`string`	Id
4	`product.productURL`	`string`	Product URL
5	`product.productID`	`string`	Product ID
6	`product.productDescription`	`string`	Product Description

Segment by Order Placement — placed order

Target customers based on placed orders and line item details.

#	Property Path	Type	Description
1	`lineItems.[].productCategories.[].title`	`string`	Title
2	`lineItems.[].productTitle`	`string`	Product Title
3	`discounts.[].code`	`string`	Code
4	`totalPrice`	`float`	Total Price
5	`lineItems.[].productID`	`string`	Product ID
6	`billingAddress.country`	`string`	Country
7	`paymentMethod`	`string`	Payment Method

Segment by Fulfillment — order fulfilled

Target customers whose orders have been shipped or delivered.

#	Property Path	Type	Description
1	`lineItems.[].productCategories.[].title`	`string`	Title
2	`lineItems.[].productTitle`	`string`	Product Title
3	`lineItems.[].productVendor`	`string`	Product Vendor
4	`discounts.[].amount`	`float`	Amount
5	`billingAddress.country`	`string`	Country
6	`lineItems.[].productURL`	`string`	Product URL
7	`totalPrice`	`float`	Total Price

Segment by Cart Activity — added product to cart

Target customers who added items to cart — useful for abandoned cart flows and product interest signals.

#	Property Path	Type	Description
1	`addedItem.productCategories.[].title`	`string`	Title
2	`addedItem.productTitle`	`string`	Product Title
3	`addedItem.productID`	`string`	Product ID
4	`addedItem.productURL`	`string`	Product URL
5	`addedItem.productPrice`	`float`	Product Price
6	`addedItem.productCategories.[].id`	`string`	Id

Segment by Browsing Behavior — viewed product

Target customers based on product pages they viewed.

#	Property Path	Type	Description
1	`product.categories.[].title`	`string`	Title
2	`product.title`	`string`	Title
3	`page.title`	`string`	Title
4	`product.categories.[].id`	`string`	Id
5	`product.id`	`string`	Id
6	`page.url`	`string`	Url
7	`product._price`	`float`	Price

Segment by Checkout Activity — started checkout

Target customers who initiated checkout.

#	Property Path	Type	Description
1	`lineItems.[].productID`	`string`	Product ID
2	`abandonedCheckoutURL`	`string`	Abandoned checkout URL
3	`lineItems.[].productCategories.[].id`	`string`	Id
4	`lineItems.[].productDescription`	`string`	Product Description
5	`lineItems.[].productSKU`	`string`	Product SKU
6	`lineItems.[].productTitle`	`string`	Product Title

Segment by Payment — paid for order

Target customers based on payment completion.

#	Property Path	Type	Description
1	`lineItems.[].productTitle`	`string`	Product Title
2	`lineItems.[].productCategories.[].title`	`string`	Title
3	`totalPrice`	`float`	Total Price
4	`discounts.[].amount`	`float`	Amount
5	`subTotalPrice`	`float`	Sub Total Price
6	`lineItems.[].productCategories.[].id`	`string`	Id

Segment by Cancellations — order canceled

Target customers whose orders were canceled.

#	Property Path	Type	Description
1	`totalPrice`	`float`	Total Price
2	`discounts.[].code`	`string`	Code
3	`billingAddress.country`	`string`	Country
4	`discounts.[].amount`	`float`	Amount
5	`subTotalPrice`	`float`	Sub Total Price
6	`lineItems.[].productVariantTitle`	`string`	Product Variant Title

Segment by Refunds — order refunded

Target customers who received refunds.

#	Property Path	Type	Description
1	`refundedLineItems.[].productTitle`	`string`	Product title
2	`lineItems.[].productTitle`	`string`	Product title

Full Reference: All properties per event will be available later via dedicated API.