---
updatedAt: 2026-03-26T14:49:31.000Z
agentTools:
  projectIndex: https://api-docs.omnisend.com/llms.txt
---

# ordered product

### Unlocked Features

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

### Supported Endpoints

| Endpoint                                                                                      | eventVersion | origin |
| --------------------------------------------------------------------------------------------- | ------------ | ------ |
| `/api/events` ([Events API](https://api-docs.omnisend.com/v2026-03-15/reference/post_events)) | 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:

```http

POST /api/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": "example@example.com"
  },
  "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

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