ordered product

Unlocked Features

Contact segmentation: Enables targeted communication by categorizing contacts based on specific criteria.

Supported Endpoints

Endpoint	eventVersion	origin
`/v5/events` (Events API)	v2	api

We recommend to send this event via JavaScript API

Example event

Below is an example event provided for testing. You can send this through the available endpoints to evaluate automation, segmentation, or any other custom functionalities.

Events API:


POST /v5/events
Host: api.omnisend.com
Content-Type: application/json

{
  "eventName": "ordered product",
  "origin": "api",
  "eventID": "f3f61bc6-07b8-4645-92d8-189d882dbcb1",
  "eventVersion": "v2",
  "eventTime": "2021-07-01T00:00:00Z",
  "contact": {
    "email": "[email protected]"
  },
  "properties": {
    "orderID": "4122111",
    "product": {
      "productCategories": [
        {
          "id": "123",
          "title": "Shoes"
        }
      ],
      "productDescription": "The best product with many various features",
      "productDiscount": 10.19,
      "productID": "1",
      "productImageURL": "https://example.com/product/232423-image.jpg",
      "productPrice": 19.99,
      "productQuantity": 2,
      "productSKU": 200,
      "productTags": [
        "tag1",
        "tag2"
      ],
      "productTitle": "The best product",
      "productURL": "https://example.com/product/232423",
      "productVariantID": "123",
      "productVariantImageURL": "https://example.com/product/232423-variant-image.jpg",
      "productVariantTitle": "Full product title - Green",
      "productVendor": "BestCompany",
      "productWeight": 20.4
    }
  }
}

Property explanation & expected types

Value Path	Description	Example	Type
orderID	Order ID	4122111	string
product	Product	-	object
product.productCategories	Product Categories	-	array of objects
product.productCategories.id	Id	123	string
product.productCategories.title	Title	Shoes	string
product.productDescription	Product Description	The best product with many various features	string
product.productDiscount	Absolute value of product discount. I.e if current price is 20 and old price is 30, then discount should be 10.	10.19	number
product.productID	Product ID	1	string
product.productImageURL	Direct link to product image	https://example.com/product/232423-image.jpg	string
product.productPrice	Current product price	19.99	number
product.productQuantity	Total added quantity	2	number
product.productSKU	Current stock units	200	string
product.productStrikeThroughPrice	!! This field was removed !!	-	number
product.productTags	Product Tags	tag1,tag2	array of strings
product.productTitle	Full product title	The best product	string
product.productURL	URL to product page	https://example.com/product/232423	string
product.productVariantID	Product Variant ID	123	string
product.productVariantImageURL	Direct link to a product variant image	https://example.com/product/232423-variant-image.jpg	string
product.productVariantTitle	Product Variant Title	Full product title - Green	string
product.productVendor	Product Vendor	BestCompany	string
product.productWeight	Product Weight	20.4	number