# Omnisend

Your Toolhouse AI Worker can connect to Omnisend using 43 specialized tools.

## Auth Connection

This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=omnisend).

## Tools (43)

### `Omnisend Add Cart Product`

Integration name: **OMNISEND\_ADD\_CART\_PRODUCT**

Tool to add a product to a cart in Omnisend (v3 API). Use when updating cart contents or tracking abandoned carts.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example                                                 | Description                                                          |
| ----------------- | ------- | :------: | ------------------------------------------------------- | -------------------------------------------------------------------- |
| `sku`             | string  |          | `"SKU-999"`                                             | Stock keeping unit identifier.                                       |
| `price`           | integer |     ✅    | `12111`                                                 | Current price in cents (e.g., 12111 for $121.11).                    |
| `title`           | string  |     ✅    | `"Nitrous oxide"`                                       | Product name or title.                                               |
| `cart_id`         | string  |     ✅    | `"test-cart-1739610001"`                                | Unique identifier of the cart to add the product to.                 |
| `currency`        | string  |     ✅    | `"USD"`                                                 | ISO 4217 currency code (3 characters).                               |
| `discount`        | integer |          | `0`                                                     | Discount amount in cents.                                            |
| `quantity`        | integer |     ✅    | `10`                                                    | Number of items. Must be a whole number greater than or equal to 1.  |
| `image_url`       | string  |          | `"http://www.example.com/images/products/prod-999.png"` | URL to product image.                                                |
| `old_price`       | integer |          | `14311`                                                 | Original price before discount in cents (e.g., 14311 for $143.11).   |
| `product_id`      | string  |     ✅    | `"prod999"`                                             | Unique product identifier from your catalog.                         |
| `variant_id`      | string  |     ✅    | `"prod999"`                                             | Product variant identifier for tracking specific product variations. |
| `description`     | string  |          | `"Test product"`                                        | Product description text.                                            |
| `product_url`     | string  |          | `"http://www.example.com/products/prod-999"`            | URL to product page.                                                 |
| `cart_product_id` | string  |     ✅    | `"2"`                                                   | Product identifier in cart. Must be unique within the cart.          |

***

### `Omnisend Create Batch`

Integration name: **OMNISEND\_CREATE\_BATCH**

Tool to create a new batch operation for multiple items. Use when you need to process many records asynchronously in one call, e.g., bulk contacts, products, orders, or events. Use after preparing the items list to avoid rate limits.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter  | Type   | Required | Example                        | Description                                                         |
| ---------- | ------ | :------: | ------------------------------ | ------------------------------------------------------------------- |
| `items`    | array  |     ✅    | `{"email":"john@example.com"}` | Array of payload objects for each operation.                        |
| `method`   | string |     ✅    | `"POST"`                       | HTTP method for all operations in this batch. Must be POST or PUT.  |
| `eventID`  | string |          | `"evt_12345"`                  | Required when endpoint is 'events'; the ID of the event to trigger. |
| `endpoint` | string |     ✅    | `"products"`                   | Target endpoint for the operations.                                 |

***

### `Omnisend Create Cart`

Integration name: **OMNISEND\_CREATE\_CART**

Tool to create a new shopping cart in Omnisend. Use when tracking customer cart activity for abandoned cart campaigns.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example                                              | Description                                                                        |
| ----------------- | ------- | :------: | ---------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `email`           | string  |          | `"customer@example.com"`                             | Customer email address associated with this cart                                   |
| `phone`           | string  |          | `"+15551234567"`                                     | Customer phone number                                                              |
| `cartID`          | string  |     ✅    | `"cart_abc123"`                                      | Unique cart identifier. Must be unique across all carts.                           |
| `cartSum`         | integer |          | `9999`                                               | Total cart value in cents (e.g., 9999 for $99.99)                                  |
| `currency`        | string  |          | `"USD"`                                              | ISO 4217 currency code (e.g., USD, EUR, GBP)                                       |
| `products`        | array   |          | —                                                    | Array of products in the cart                                                      |
| `contactID`       | string  |          | `"contact_xyz789"`                                   | Existing Omnisend contact identifier to associate with this cart                   |
| `createdAt`       | string  |          | `"2024-01-15T10:30:00Z"`                             | Cart creation timestamp in ISO 8601 format. If not provided, current time is used. |
| `updatedAt`       | string  |          | `"2024-01-15T11:45:00Z"`                             | Cart last update timestamp in ISO 8601 format                                      |
| `cartRecoveryUrl` | string  |          | `"https://store.example.com/cart/recover?id=abc123"` | URL to recover the cart, used in abandoned cart emails                             |

***

### `Omnisend Create Category`

Integration name: **OMNISEND\_CREATE\_CATEGORY**

Tool to create a new category in Omnisend. Use when organizing products into categories.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example        | Description                                                                      |
| ------------ | ------ | :------: | -------------- | -------------------------------------------------------------------------------- |
| `title`      | string |     ✅    | `"Containers"` | Display name for the category.                                                   |
| `categoryID` | string |     ✅    | `"cat666"`     | Unique identifier for the category. Must be unique within your Omnisend account. |

***

### `Omnisend Create Order`

Integration name: **OMNISEND\_CREATE\_ORDER**

Tool to create a new order in Omnisend v3 API. Use when recording a customer purchase or order transaction.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter             | Type    | Required | Example                                            | Description                                                                          |
| --------------------- | ------- | :------: | -------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `tags`                | array   |          | `["Fragile","High Priority"]`                      | Order tags                                                                           |
| `email`               | string  |          | `"test.customer@example.com"`                      | Customer email address (email or phone or contactID required)                        |
| `phone`               | string  |          | `"+12025550142"`                                   | Customer phone number (email or phone or contactID required)                         |
| `cartID`              | string  |          | `"4557116516"`                                     | Cart identifier                                                                      |
| `source`              | string  |          | `""`                                               | Order source                                                                         |
| `taxSum`              | integer |          | `0`                                                | Tax amount in cents                                                                  |
| `orderID`             | string  |     ✅    | `"test-order-2026-02-15-002"`                      | Unique order identifier from your store                                              |
| `currency`            | string  |     ✅    | `"USD"`                                            | Order currency code (e.g., USD, EUR)                                                 |
| `lastName`            | string  |          | `"Evil"`                                           | Customer last name                                                                   |
| `orderSum`            | integer |     ✅    | `9999`                                             | Total order amount in cents (must be integer, not float)                             |
| `orderUrl`            | string  |          | `"http://www.example.com/orders/2017-05-06-14587"` | URL to view the order                                                                |
| `products`            | array   |          | —                                                  | Array of ordered products                                                            |
| `contactID`           | string  |          | —                                                  | Omnisend contact ID (email or phone or contactID required)                           |
| `createdAt`           | string  |     ✅    | `"2026-02-14T10:00:00Z"`                           | Order creation timestamp in ISO 8601 format (cannot be future date, required by API) |
| `firstName`           | string  |          | `"Dr."`                                            | Customer first name                                                                  |
| `updatedAt`           | string  |          | `"2017-06-20T16:40:12Z"`                           | Order last update timestamp in ISO 8601 format                                       |
| `courierUrl`          | string  |          | `"http://www.example.com/?trackId=666"`            | Tracking URL                                                                         |
| `contactNote`         | string  |          | `"Door code: 442"`                                 | Note about the customer or order                                                     |
| `discountSum`         | integer |          | `1111`                                             | Total discount amount in cents                                                       |
| `orderNumber`         | integer |          | `201706145`                                        | Order number for display                                                             |
| `shippingSum`         | integer |          | `0`                                                | Shipping cost in cents                                                               |
| `subTotalSum`         | integer |          | `55566`                                            | Subtotal amount in cents                                                             |
| `courierTitle`        | string  |          | `"Nuclear post"`                                   | Courier service name                                                                 |
| `customFields`        | object  |          | `{"phone":"+66 666 666 66"}`                       | Custom fields as key-value pairs                                                     |
| `discountCode`        | string  |          | `"mojo66"`                                         | Discount code applied                                                                |
| `discountType`        | string  |          | `"fixedAmount"`                                    | Type of discount (e.g., fixedAmount, percentage)                                     |
| `trackingCode`        | string  |          | `"666"`                                            | Shipping tracking code                                                               |
| `discountValue`       | integer |          | `1111`                                             | Discount value in cents                                                              |
| `paymentMethod`       | string  |          | `"Credit card"`                                    | Payment method description                                                           |
| `paymentStatus`       | string  |          | `"paid"`                                           | Payment status enum values.                                                          |
| `billingAddress`      | object  |          | —                                                  | Address information for billing or shipping.                                         |
| `shippingMethod`      | string  |          | `"Ground shipping"`                                | Shipping method description                                                          |
| `shippingAddress`     | object  |          | —                                                  | Address information for billing or shipping.                                         |
| `fulfillmentStatus`   | string  |          | `"unfulfilled"`                                    | Fulfillment status enum values.                                                      |
| `subTotalTaxIncluded` | boolean |          | `false`                                            | Whether tax is included in subtotal                                                  |

***

### `Omnisend Create Or Update Contact`

Integration name: **OMNISEND\_CREATE\_OR\_UPDATE\_CONTACT**

Tool to create or update a contact in Omnisend. Use after collecting subscriber details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type   | Required | Example           | Description                                                     |
| ------------- | ------ | :------: | ----------------- | --------------------------------------------------------------- |
| `city`        | string |          | `"New York"`      | City name                                                       |
| `gender`      | string |          | `"m"`             | Contact's gender ('m' or 'f')                                   |
| `address`     | string |          | `"123 Main St"`   | Street address                                                  |
| `country`     | string |          | `"United States"` | Full country name                                               |
| `lastName`    | string |          | `"Doe"`           | Contact's last name                                             |
| `birthdate`   | string |          | `"1985-05-15"`    | Birthdate in YYYY-MM-DD format                                  |
| `firstName`   | string |          | `"Jane"`          | Contact's first name                                            |
| `postalCode`  | string |          | `"10001"`         | Postal or ZIP code                                              |
| `countryCode` | string |          | `"US"`            | ISO 3166-1 alpha-2 country code                                 |
| `identifiers` | array  |     ✅    | —                 | One or more ways to identify the contact; at least one required |

***

### `Omnisend Create Product`

Integration name: **OMNISEND\_CREATE\_PRODUCT**

Tool to create a new product in the Omnisend product catalog. Use when adding products for email campaigns or syncing inventory.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type   | Required | Example                                                                                                                    | Description                                                                                               |
| ----------------- | ------ | :------: | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `id`              | string |     ✅    | `"test-product-12345"`                                                                                                     | Unique product identifier from your store. Must be unique across all products.                            |
| `url`             | string |     ✅    | `"https://example.com/test-product"`                                                                                       | URL to the product page on your website.                                                                  |
| `tags`            | array  |          | `["tag1","tag2","tag3"]`                                                                                                   | Tags to categorize the product for filtering and organization (max 100 items).                            |
| `type`            | string |          | `"Super Product"`                                                                                                          | Product type to categorize products (e.g., 'Electronics', 'Clothing').                                    |
| `title`           | string |     ✅    | `"Test Product"`                                                                                                           | Product title displayed to customers.                                                                     |
| `images`          | array  |          | `["https://example.com/img1.jpg","https://example.com/img2.jpg"]`                                                          | Additional product image URLs beyond the default image (max 300 items).                                   |
| `status`          | string |     ✅    | `"inStock"`                                                                                                                | Overall product availability status. Keep in sync with your shop to avoid sending out-of-stock products.  |
| `vendor`          | string |          | `"My Vendor"`                                                                                                              | Manufacturer or brand of the product.                                                                     |
| `currency`        | string |     ✅    | `"USD"`                                                                                                                    | ISO 4217 currency code (e.g., USD, EUR, GBP).                                                             |
| `variants`        | array  |     ✅    | `[{"id":"variant-1","url":"https://example.com/test-product","price":29.99,"title":"Default Variant","status":"inStock"}]` | Product variants with their own prices and SKUs. At least one variant is required (min 1, max 500 items). |
| `createdAt`       | string |          | `"2021-01-01T00:00:00Z"`                                                                                                   | Product creation timestamp in ISO 8601 format (e.g., 2021-01-01T00:00:00Z).                               |
| `updatedAt`       | string |          | `"2021-01-01T00:00:00Z"`                                                                                                   | Last update timestamp in ISO 8601 format.                                                                 |
| `categoryIDs`     | array  |          | `["1234567890","99934567890"]`                                                                                             | List of category IDs this product belongs to (max 100 items).                                             |
| `description`     | string |          | `"A high-quality product for your needs"`                                                                                  | Short description of the product. Can be used in the email body.                                          |
| `defaultImageUrl` | string |          | `"https://example.com/image.jpg"`                                                                                          | Primary image URL for the product. Recommended if more than one image is needed.                          |

***

### `Omnisend Create Product Category`

Integration name: **OMNISEND\_CREATE\_PRODUCT\_CATEGORY**

Tool to create a new product category in the Omnisend catalog. Use when organizing products into categories.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example             | Description                                                                       |
| ------------ | ------ | :------: | ------------------- | --------------------------------------------------------------------------------- |
| `title`      | string |     ✅    | `"Beauty products"` | Title/name of the product category. Maximum 100 characters.                       |
| `categoryID` | string |     ✅    | `"C1234"`           | Unique identifier for the product category. Must be between 1 and 100 characters. |

***

### `Omnisend Delete Cart`

Integration name: **OMNISEND\_DELETE\_CART**

Tool to delete a cart from Omnisend by its ID (v3 API). Use when you need to remove an abandoned or expired cart from the system.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example              | Description                              |
| --------- | ------ | :------: | -------------------- | ---------------------------------------- |
| `cartID`  | string |     ✅    | `"test-cart-123456"` | Unique identifier of the cart to delete. |

***

### `Omnisend Delete Category`

Integration name: **OMNISEND\_DELETE\_CATEGORY**

Tool to remove a category from Omnisend by its ID. Use when you need to delete a category and ensure it is no longer available in your catalog.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type   | Required | Example                 | Description                                  |
| ------------- | ------ | :------: | ----------------------- | -------------------------------------------- |
| `category_id` | string |     ✅    | `"test-cat-1739605000"` | Unique identifier of the category to delete. |

***

### `Omnisend Delete Order`

Integration name: **OMNISEND\_DELETE\_ORDER**

Tool to delete an order from Omnisend by its ID. Use when you need to remove an order from the system.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                        | Description                               |
| --------- | ------ | :------: | ------------------------------ | ----------------------------------------- |
| `orderID` | string |     ✅    | `"test-order-delete-20250215"` | Unique identifier of the order to delete. |

***

### `Omnisend Delete Product`

Integration name: **OMNISEND\_DELETE\_PRODUCT**

Tool to remove a product from Omnisend by its ID. Use when you need to delete a product and ensure it is no longer available in your catalog.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                                  | Description                                 |
| ------------ | ------ | :------: | ---------------------------------------- | ------------------------------------------- |
| `product_id` | string |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | Unique identifier of the product to delete. |

***

### `Omnisend Delete Product Category`

Integration name: **OMNISEND\_DELETE\_PRODUCT\_CATEGORY**

Tool to remove a product category from Omnisend by its ID. Use when you need to delete a product category from your catalog.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type   | Required | Example          | Description                                          |
| ------------- | ------ | :------: | ---------------- | ---------------------------------------------------- |
| `category_id` | string |     ✅    | `"TEST_CAT_001"` | Unique identifier of the product category to delete. |

***

### `Omnisend Get Batches`

Integration name: **OMNISEND\_GET\_BATCHES**

Tool to retrieve a list of batch operations. Use after initiating a batch job to monitor its progress and results.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter  | Type   | Required | Example      | Description                                           |
| ---------- | ------ | :------: | ------------ | ----------------------------------------------------- |
| `endpoint` | string |     ✅    | `"contacts"` | Target endpoint for the batch operations to retrieve. |

***

### `Omnisend Get Batch Information`

Integration name: **OMNISEND\_GET\_BATCH\_INFORMATION**

Tool to retrieve information about a specific batch by ID. Use after submitting a batch when you need a detailed status and counts.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example           | Description                                    |
| --------- | ------ | :------: | ----------------- | ---------------------------------------------- |
| `batchId` | string |     ✅    | `"batchId_12345"` | The unique identifier of the batch to retrieve |

***

### `Omnisend Get Batch Item`

Integration name: **OMNISEND\_GET\_BATCH\_ITEM**

Tool to retrieve a specific item within a batch by batchID and itemID. Use when you need to inspect the result of a single batch operation.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                      | Description                                                             |
| --------- | ------ | :------: | ---------------------------- | ----------------------------------------------------------------------- |
| `itemID`  | string |     ✅    | `"69916a482638fcce46d0e14d"` | The unique identifier of the specific item to retrieve within the batch |
| `batchID` | string |     ✅    | `"69916a482638fcce46d0e14c"` | The unique identifier of the batch containing the item                  |

***

### `Omnisend Get Batch Items`

Integration name: **OMNISEND\_GET\_BATCH\_ITEMS**

Tool to retrieve processed items of a specific batch by ID. Use when you need to inspect individual results of a batch operation after fetching batch details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                      | Description                                                          |
| --------- | ------ | :------: | ---------------------------- | -------------------------------------------------------------------- |
| `batchId` | string |     ✅    | `"5f8d0d55bf7a230008fa0f9d"` | The unique identifier of the batch whose items you want to retrieve. |

***

### `Omnisend Get Brand`

Integration name: **OMNISEND\_GET\_BRAND**

Tool to retrieve information about the current authenticated brand. Use when you need brand details like currency, platform, or website.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.*

***

### `Omnisend Get Cart`

Integration name: **OMNISEND\_GET\_CART**

Tool to retrieve a specific cart by ID from Omnisend v3 API. Use when you need detailed cart information including products and customer contact details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                  | Description                                |
| --------- | ------ | :------: | ------------------------ | ------------------------------------------ |
| `cartID`  | string |     ✅    | `"test-cart-1739608800"` | Unique identifier of the cart to retrieve. |

***

### `Omnisend Get Category`

Integration name: **OMNISEND\_GET\_CATEGORY**

Tool to retrieve details of a specific category by ID. Use when you need to fetch information about a category.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example     | Description                                    |
| ------------ | ------ | :------: | ----------- | ---------------------------------------------- |
| `categoryID` | string |     ✅    | `"cat-001"` | Unique identifier of the category to retrieve. |

***

### `Omnisend Get Contact`

Integration name: **OMNISEND\_GET\_CONTACT**

Tool to retrieve details of a single contact by ID. Use when you already have a contactId and need the full profile.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type   | Required | Example                      | Description                                  |
| ----------- | ------ | :------: | ---------------------------- | -------------------------------------------- |
| `contactId` | string |     ✅    | `"60e7412b1234567890abcdef"` | Unique identifier of the contact to retrieve |

***

### `Omnisend Get Order`

Integration name: **OMNISEND\_GET\_ORDER**

Tool to retrieve details of a specific order by ID. Use when you need order information including products, addresses, and payment details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example              | Description                                |
| --------- | ------ | :------: | -------------------- | ------------------------------------------ |
| `orderID` | string |     ✅    | `"test-order-12345"` | Unique identifier of the order to retrieve |

***

### `Omnisend Get Product`

Integration name: **OMNISEND\_GET\_PRODUCT**

Tool to retrieve details of a specific product by ID from Omnisend. Use when you need full product information including variants, pricing, and stock status.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                | Description                                   |
| ------------ | ------ | :------: | ---------------------- | --------------------------------------------- |
| `product_id` | string |     ✅    | `"test-product-12345"` | Unique identifier of the product to retrieve. |

***

### `Omnisend Get Product Category`

Integration name: **OMNISEND\_GET\_PRODUCT\_CATEGORY**

Tool to retrieve a specific product category by ID. Use when you need details about a particular product category.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example     | Description                                           |
| ------------ | ------ | :------: | ----------- | ----------------------------------------------------- |
| `categoryID` | string |     ✅    | `"cat-001"` | Unique identifier of the product category to retrieve |

***

### `Omnisend List Campaigns`

Integration name: **OMNISEND\_LIST\_CAMPAIGNS**

Tool to retrieve a paginated list of campaigns with optional filtering by status and type. Use when you need to view or analyze campaign performance across multiple campaigns.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example | Description                                                   |
| --------- | ------- | :------: | ------- | ------------------------------------------------------------- |
| `type`    | string  |          | —       | Filter campaigns by type (e.g., regular, automation, split).  |
| `limit`   | integer |          | `100`   | Number of results to fetch. Default is 5000, maximum is 5000. |
| `offset`  | integer |          | `0`     | Number of results to skip. Use for pagination. Default is 0.  |
| `status`  | string  |          | —       | Campaign status values.                                       |

***

### `Omnisend List Carts`

Integration name: **OMNISEND\_LIST\_CARTS**

Tool to retrieve a paginated list of carts with optional filtering. Use when you need to fetch carts by date range, contact, or segment.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example                      | Description                                                  |
| ------------- | ------- | :------: | ---------------------------- | ------------------------------------------------------------ |
| `sort`        | string  |          | `"createdAt"`                | Sort order for results.                                      |
| `email`       | string  |          | `"user@example.com"`         | Filter carts by contact email address.                       |
| `limit`       | integer |          | `100`                        | Number of results to fetch. Default is 100, max 250.         |
| `phone`       | string  |          | `"+14155552671"`             | Filter carts by contact phone number including country code. |
| `dateTo`      | string  |          | `"2024-12-31"`               | Cart creation date to. Format: YYYY-MM-DD.                   |
| `offset`      | integer |          | `0`                          | Number of results to skip. Default is 0.                     |
| `dateFrom`    | string  |          | `"2024-01-01"`               | Cart creation date from. Format: YYYY-MM-DD.                 |
| `contactID`   | string  |          | `"5f8d3a4b2c1e8f001f6d9a7c"` | Filter carts by contact ID.                                  |
| `segmentID`   | string  |          | `"12345"`                    | Filter carts by segment ID.                                  |
| `updatedTo`   | string  |          | `"2024-12-31"`               | Cart update date to. Format: YYYY-MM-DD.                     |
| `updatedFrom` | string  |          | `"2024-01-01"`               | Cart update date from. Format: YYYY-MM-DD.                   |

***

### `Omnisend List Categories`

Integration name: **OMNISEND\_LIST\_CATEGORIES**

Tool to retrieve a paginated list of product categories. Use when you need category IDs for product management or catalog organization.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example   | Description                                                                               |
| --------- | ------- | :------: | --------- | ----------------------------------------------------------------------------------------- |
| `sort`    | string  |          | `"title"` | Field to sort results by. Format: 'fieldName' for ascending, '-fieldName' for descending. |
| `limit`   | integer |          | `100`     | Number of results to fetch. Defaults to 100, maximum 250.                                 |
| `offset`  | integer |          | `0`       | Number of results to skip. Defaults to 0. Use for pagination.                             |

***

### `Omnisend List Contacts`

Integration name: **OMNISEND\_LIST\_CONTACTS**

Tool to retrieve a paginated list of contacts with optional filtering. Use when you need to fetch contacts in batches and handle cursor pagination.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type    | Required | Example              | Description                                                           |
| ----------- | ------- | :------: | -------------------- | --------------------------------------------------------------------- |
| `tag`       | string  |          | `"VIP"`              | Filter contacts by tag.                                               |
| `after`     | string  |          | —                    | Cursor for pagination: contacts after this base64-encoded ContactID.  |
| `email`     | string  |          | `"user@example.com"` | Filter contacts by exact email address.                               |
| `limit`     | integer |          | `100`                | Number of results per page. Defaults to 100, maximum 250.             |
| `phone`     | string  |          | `"+14155552671"`     | Filter contacts by full phone number including country code.          |
| `before`    | string  |          | —                    | Cursor for pagination: contacts before this base64-encoded ContactID. |
| `status`    | string  |          | —                    | Filter contacts by email channel status.                              |
| `segmentID` | integer |          | `12345`              | Filter contacts by segment ID.                                        |

***

### `Omnisend List Events`

Integration name: **OMNISEND\_LIST\_EVENTS**

Tool to retrieve all custom events created in Omnisend app. Use when you need to view available event types for automation workflows or event tracking.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.*

***

### `Omnisend List Product Categories`

Integration name: **OMNISEND\_LIST\_PRODUCT\_CATEGORIES**

Tool to retrieve a paginated list of product categories from the Omnisend catalog. Use when fetching category data for product organization.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example       | Description                                                                    |
| --------- | ------- | :------: | ------------- | ------------------------------------------------------------------------------ |
| `sort`    | string  |          | `"createdAt"` | Field to sort by. Allowed values: 'date', 'createdAt', or 'updatedAt'.         |
| `limit`   | integer |          | `100`         | Maximum number of categories to return. Defaults to 100.                       |
| `offset`  | integer |          | `0`           | Zero-based index of the first category to return. Use to page through results. |

***

### `Omnisend List Products`

Integration name: **OMNISEND\_LIST\_PRODUCTS**

Tool to retrieve a paginated list of products. Use when syncing product catalog before campaign creation.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example       | Description                                                                   |
| --------- | ------- | :------: | ------------- | ----------------------------------------------------------------------------- |
| `sort`    | string  |          | `"createdAt"` | Field to sort by. Allowed values: 'date', 'createdAt', or 'updatedAt'.        |
| `limit`   | integer |          | `100`         | Maximum number of products to return. Defaults to 100.                        |
| `offset`  | integer |          | `0`           | Zero-based index of the first product to return. Use to page through results. |

***

### `Omnisend Remove Cart Product`

Integration name: **OMNISEND\_REMOVE\_CART\_PRODUCT**

Tool to remove a product from a cart in Omnisend. Use when you need to delete a specific product from a cart.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type   | Required | Example                  | Description                                             |
| ----------------- | ------ | :------: | ------------------------ | ------------------------------------------------------- |
| `cart_id`         | string |     ✅    | `"test-cart-1739614800"` | Unique identifier of the cart.                          |
| `cart_product_id` | string |     ✅    | `"test-prod-1"`          | Unique identifier of the product in the cart to remove. |

***

### `Omnisend Replace Cart`

Integration name: **OMNISEND\_REPLACE\_CART**

Tool to replace an existing cart in Omnisend using the v3 API. Use when you need to completely replace all cart data including products, pricing, and recovery URL.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example                                                            | Description                                               |
| ----------------- | ------- | :------: | ------------------------------------------------------------------ | --------------------------------------------------------- |
| `cartID`          | string  |     ✅    | `"test-cart-1739608800"`                                           | Unique identifier of the cart to replace                  |
| `cartSum`         | integer |     ✅    | `78777`                                                            | Total cart value in cents (e.g., 78777 = $787.77)         |
| `currency`        | string  |     ✅    | `"EUR"`                                                            | ISO 4217 currency code for the cart (e.g., USD, EUR, GBP) |
| `products`        | array   |     ✅    | —                                                                  | List of products in the cart                              |
| `createdAt`       | string  |          | `"2017-06-20T15:40:12Z"`                                           | ISO 8601 timestamp when the cart was created              |
| `updatedAt`       | string  |          | `"2017-06-20T15:45:12Z"`                                           | ISO 8601 timestamp when the cart was last updated         |
| `cartRecoveryUrl` | string  |          | `"http://www.example.com/carts/?restoreCart=test-cart-1739608800"` | URL to restore the cart, used for abandoned cart recovery |

***

### `Omnisend Replace Cart Product`

Integration name: **OMNISEND\_REPLACE\_CART\_PRODUCT**

Tool to replace a product in a cart using Omnisend v3 API. Use when you need to update all details of a specific product in a cart.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type    | Required | Example                                                 | Description                                                                |
| --------------- | ------- | :------: | ------------------------------------------------------- | -------------------------------------------------------------------------- |
| `sku`           | string  |          | —                                                       | Stock keeping unit identifier.                                             |
| `price`         | integer |     ✅    | `12111`                                                 | Product price in cents, without commas. For example, for 1.25 USD use 125. |
| `title`         | string  |     ✅    | `"Updated Product Title"`                               | Product title.                                                             |
| `cartID`        | string  |     ✅    | `"test-cart-1771137590"`                                | Unique identifier of the cart containing the product to replace.           |
| `currency`      | string  |     ✅    | `"USD"`                                                 | ISO currency code (3 characters).                                          |
| `discount`      | integer |          | `500`                                                   | Discount sum in cents.                                                     |
| `imageUrl`      | string  |          | `"http://www.example.com/images/products/prod-999.png"` | Link to product image (must be a valid URI).                               |
| `oldPrice`      | integer |          | `14311`                                                 | Old price in cents, without commas. For example, for 1.43 USD use 143.     |
| `quantity`      | integer |     ✅    | `10`                                                    | Product quantity (only whole numbers, minimum 1).                          |
| `productID`     | string  |     ✅    | `"prod999-updated"`                                     | Product identifier.                                                        |
| `variantID`     | string  |     ✅    | `"var999-updated"`                                      | Product modification identifier (variant ID).                              |
| `productUrl`    | string  |          | `"http://www.example.com/products/prod-999"`            | Link to product page (must be a valid URI).                                |
| `description`   | string  |          | `"Updated product description"`                         | Product description.                                                       |
| `cartProductID` | string  |     ✅    | `"prod-1"`                                              | Unique identifier of the product in the cart to replace.                   |

***

### `Omnisend Replace Category`

Integration name: **OMNISEND\_REPLACE\_CATEGORY**

Tool to replace a category's title by ID. Use when you need to update an entire category resource.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                         | Description                                  |
| ------------ | ------ | :------: | ------------------------------- | -------------------------------------------- |
| `title`      | string |     ✅    | `"Updated Test Category Title"` | New title for the category                   |
| `categoryID` | string |     ✅    | `"test-cat-1739612000"`         | Unique identifier of the category to replace |

***

### `Omnisend Replace Order`

Integration name: **OMNISEND\_REPLACE\_ORDER**

Tool to completely replace an existing order in Omnisend. Use when you need to update all order details at once, replacing the entire order record.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter             | Type    | Required | Example                  | Description                                                                                                 |
| --------------------- | ------- | :------: | ------------------------ | ----------------------------------------------------------------------------------------------------------- |
| `tags`                | array   |          | —                        | Tags associated with the order                                                                              |
| `cartID`              | string  |          | —                        | Identifier of the cart that led to this order                                                               |
| `source`              | string  |          | —                        | Source of the order (e.g., 'web', 'mobile')                                                                 |
| `taxSum`              | integer |          | —                        | Total tax amount in smallest currency unit                                                                  |
| `orderID`             | string  |     ✅    | `"test-order-12345"`     | Unique identifier of the order to replace                                                                   |
| `currency`            | string  |     ✅    | `"EUR"`                  | ISO 4217 currency code (e.g., 'USD', 'EUR')                                                                 |
| `orderSum`            | integer |     ✅    | `25000`                  | Total order amount in the smallest currency unit (e.g., cents)                                              |
| `orderUrl`            | string  |          | —                        | URL to view the order                                                                                       |
| `products`            | array   |          | —                        | List of products in the order                                                                               |
| `createdAt`           | string  |     ✅    | `"2024-01-15T10:00:00Z"` | ISO 8601 timestamp when the order was created                                                               |
| `updatedAt`           | string  |          | —                        | ISO 8601 timestamp when the order was last updated                                                          |
| `courierUrl`          | string  |          | —                        | URL for courier tracking                                                                                    |
| `contactNote`         | string  |          | —                        | Notes about the customer                                                                                    |
| `discountSum`         | integer |          | —                        | Total discount amount in smallest currency unit                                                             |
| `orderNumber`         | integer |          | —                        | Human-readable order number                                                                                 |
| `shippingSum`         | integer |          | —                        | Shipping cost in smallest currency unit                                                                     |
| `subTotalSum`         | integer |          | —                        | Subtotal before taxes and shipping in smallest currency unit                                                |
| `cancelReason`        | string  |          | —                        | Reason for order cancellation if applicable                                                                 |
| `canceledDate`        | string  |          | —                        | ISO 8601 timestamp when the order was canceled                                                              |
| `courierTitle`        | string  |          | —                        | Name of the shipping courier                                                                                |
| `discountCode`        | string  |          | —                        | Discount or coupon code applied                                                                             |
| `discountType`        | string  |          | —                        | Type of discount (e.g., 'percentage', 'fixed')                                                              |
| `trackingCode`        | string  |          | —                        | Shipment tracking code                                                                                      |
| `discountValue`       | integer |          | —                        | Discount value (percentage or fixed amount)                                                                 |
| `paymentMethod`       | string  |          | —                        | Payment method used (e.g., 'credit\_card', 'paypal')                                                        |
| `paymentStatus`       | string  |          | `"paid"`                 | Payment status. Available values: awaitingPayment, partiallyPaid, paid, partiallyRefunded, refunded, voided |
| `billingAddress`      | object  |          | —                        | Billing address information for the order.                                                                  |
| `shippingMethod`      | string  |          | —                        | Shipping method used                                                                                        |
| `shippingAddress`     | object  |          | —                        | Shipping address information for the order.                                                                 |
| `fulfillmentStatus`   | string  |          | `"fulfilled"`            | Fulfillment status (e.g., 'fulfilled', 'unfulfilled', 'partially\_fulfilled')                               |
| `subTotalTaxIncluded` | boolean |          | —                        | Whether subtotal includes tax                                                                               |

***

### `Omnisend Replace Product`

Integration name: **OMNISEND\_REPLACE\_PRODUCT**

Tool to replace an existing product in the Omnisend catalog. Use when you need to completely replace all product data with new information.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type   | Required | Example                                       | Description                                                                                               |
| ----------------- | ------ | :------: | --------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `id`              | string |     ✅    | `"test-replace-product-456"`                  | Product ID - must match the product\_id path parameter                                                    |
| `url`             | string |     ✅    | `"https://example.com/replaced-product"`      | URL pointing to the product page on your website                                                          |
| `tags`            | array  |          | —                                             | Tags for product categorization (max 100 items)                                                           |
| `type`            | string |          | `"Super Product"`                             | Product type for categorization purposes                                                                  |
| `title`           | string |     ✅    | `"Replaced Test Product"`                     | Product title                                                                                             |
| `images`          | array  |          | —                                             | Additional product image URLs (max 300 items)                                                             |
| `status`          | string |     ✅    | `"inStock"`                                   | Product stock status. Keep in sync with your shop to avoid sending out-of-stock products                  |
| `vendor`          | string |          | `"My Vendor"`                                 | Manufacturer or brand of the product                                                                      |
| `currency`        | string |     ✅    | `"USD"`                                       | ISO 4217 currency code (e.g., USD, EUR, GBP)                                                              |
| `variants`        | array  |     ✅    | —                                             | Product variants (different versions like sizes/colors). At least one variant required                    |
| `createdAt`       | string |          | `"2021-01-01T00:00:00Z"`                      | Creation timestamp in ISO 8601 format                                                                     |
| `updatedAt`       | string |          | `"2021-01-01T00:00:00Z"`                      | Last update timestamp in ISO 8601 format                                                                  |
| `product_id`      | string |     ✅    | `"test-replace-product-456"`                  | Unique identifier of the product to replace. Must match the product ID in the request body                |
| `categoryIDs`     | array  |          | —                                             | List of category IDs the product belongs to (max 100 items)                                               |
| `description`     | string |          | `"This product has been completely replaced"` | Short description of the product for email body usage                                                     |
| `defaultImageUrl` | string |          | `"https://example.com/replaced-image.jpg"`    | Primary image URL. Recommended if you need more than one image - additional images go in the images array |

***

### `Omnisend Send Event`

Integration name: **OMNISEND\_SEND\_EVENT**

Tool to send a customer event to Omnisend. Events can trigger automations and track customer behavior. Use when you need to record customer interactions such as product views, cart actions, or custom events.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter      | Type   | Required | Example                                               | Description                                                                                                                                    |
| -------------- | ------ | :------: | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `origin`       | string |     ✅    | `"api"`                                               | Source of the event. Use 'api' for general API integrations. Platform or app integrations should have dedicated origin values.                 |
| `contact`      | object |     ✅    | —                                                     | Contact information. Contact will be created or updated based on the data provided. At least one identifier (email, phone, or id) is required. |
| `eventID`      | string |          | `"9afca57b-d157-478b-adde-b9506322b16f"`              | UUID of the event (v4, v5, v6, v7). Used for event deduplication along with eventTime. If not provided, it will be generated automatically.    |
| `eventName`    | string |     ✅    | `"product_viewed"`                                    | Name of the event (e.g., 'order placed', 'product viewed', 'test\_event'). Check event documentation for standard event names.                 |
| `eventTime`    | string |          | `"2021-07-01T00:00:00Z"`                              | Event timestamp in RFC3339 format (e.g., '2021-07-01T00:00:00Z'). If not provided, current time will be used.                                  |
| `properties`   | object |          | `{"price":29.99,"currency":"USD","product_id":"123"}` | Event-specific properties such as order details, product info, etc. Check events guide for recommended properties for each event type.         |
| `eventVersion` | string |          | `""`                                                  | Event version string. Check event documentation for required version for each event. Leave empty for custom events.                            |

***

### `Omnisend Update Cart`

Integration name: **OMNISEND\_UPDATE\_CART**

Tool to partially update a cart in Omnisend (v3 API). Use when you need to modify cart details such as currency, total amount, recovery URL, or products.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example                                                  | Description                                                                   |
| ----------------- | ------- | :------: | -------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `cartID`          | string  |     ✅    | `"test-cart-1739607123"`                                 | Unique identifier of the cart to update                                       |
| `cartSum`         | integer |     ✅    | `78777`                                                  | Total cart value in cents, without commas. For example, for $1.25 USD use 125 |
| `currency`        | string  |     ✅    | `"USD"`                                                  | ISO currency code (3 characters)                                              |
| `products`        | array   |          | —                                                        | List of products in the cart                                                  |
| `cartRecoveryUrl` | string  |          | `"http://www.example.com/carts/?restoreCart=4557116516"` | URL to recover the cart                                                       |

***

### `Omnisend Update Cart Product`

Integration name: **OMNISEND\_UPDATE\_CART\_PRODUCT**

Tool to update a product in a cart (v3 API). Use when you need to modify product details such as quantity, price, or other attributes for an existing cart item.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example                                                 | Description                                                       |
| ----------------- | ------- | :------: | ------------------------------------------------------- | ----------------------------------------------------------------- |
| `sku`             | string  |          | —                                                       | Stock keeping unit (SKU).                                         |
| `price`           | integer |          | `12111`                                                 | Current price in cents (e.g., 125 for $1.25).                     |
| `title`           | string  |          | `"Updated Test Product"`                                | Product title.                                                    |
| `cart_id`         | string  |     ✅    | `"test-cart-1739608123"`                                | Unique identifier of the cart.                                    |
| `currency`        | string  |     ✅    | `"USD"`                                                 | ISO currency code (3 characters). Must match the cart's currency. |
| `discount`        | integer |          | `100`                                                   | Discount sum in cents.                                            |
| `quantity`        | integer |          | `10`                                                    | Product quantity (must be a whole number, minimum 1).             |
| `image_url`       | string  |          | `"http://www.example.com/images/products/prod-999.png"` | Link to product image.                                            |
| `old_price`       | integer |          | `14311`                                                 | Original price in cents (e.g., 125 for $1.25).                    |
| `product_id`      | string  |          | `"prod999"`                                             | Product identifier.                                               |
| `variant_id`      | string  |          | `"prod999"`                                             | Product variant identifier.                                       |
| `description`     | string  |          | —                                                       | Product description.                                              |
| `product_url`     | string  |          | `"http://www.example.com/products/prod-999"`            | Link to product page.                                             |
| `cart_product_id` | string  |     ✅    | `"prod-123"`                                            | Unique identifier of the product in the cart to update.           |

***

### `Omnisend Update Contact`

Integration name: **OMNISEND\_UPDATE\_CONTACT**

Tool to update fields of an existing contact by ID. Use after retrieving contact ID. PATCH <https://api.omnisend.com/v3/contacts/{contactId}> Example: UpdateContact(contactId="..., body={firstName: 'John'})

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type   | Required | Example                      | Description                                |
| ----------- | ------ | :------: | ---------------------------- | ------------------------------------------ |
| `body`      | object |     ✅    | —                            | Fields to update on the contact            |
| `contactId` | string |     ✅    | `"615b9bd0e123456789abcdef"` | Unique identifier of the contact to update |

***

### `Omnisend Update Order Status`

Integration name: **OMNISEND\_UPDATE\_ORDER\_STATUS**

Tool to partially update an order status in Omnisend (v3 API). Use when you need to update shipping details, payment status, or fulfillment status of an existing order.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter           | Type   | Required | Example                                    | Description                                                                                                               |
| ------------------- | ------ | :------: | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| `cartID`            | string |          | `"cart-12345"`                             | Identifier of the cart associated with this order.                                                                        |
| `orderID`           | string |     ✅    | `"test-order-1739599200"`                  | Unique identifier of the order to update.                                                                                 |
| `courierUrl`        | string |          | `"http://www.example.com/?trackId=666-66"` | URL to track the shipment (must be a valid URI).                                                                          |
| `cancelReason`      | string |          | `"Customer requested cancellation"`        | Reason for order cancellation.                                                                                            |
| `canceledDate`      | string |          | `"2017-05-30T14:11:12Z"`                   | ISO 8601 date-time when the order was canceled (e.g., '2017-05-30T14:11:12Z').                                            |
| `courierTitle`      | string |          | `"Nuclear post"`                           | Name of the courier/shipping company.                                                                                     |
| `trackingCode`      | string |          | `"666-66"`                                 | Tracking code for the shipment.                                                                                           |
| `paymentStatus`     | string |          | `"paid"`                                   | Payment status of the order. You need to map your status with Omnisend's statuses (e.g., 'pending', 'paid').              |
| `fulfillmentStatus` | string |          | `"fulfilled"`                              | Fulfillment status of the order. You need to map your status with Omnisend's statuses (e.g., 'unfulfilled', 'fulfilled'). |

***

### `Omnisend Update Product Category`

Integration name: **OMNISEND\_UPDATE\_PRODUCT\_CATEGORY**

Tool to update an existing product category title in Omnisend. Use when you need to modify a category's name.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example             | Description                            |
| ------------ | ------ | :------: | ------------------- | -------------------------------------- |
| `title`      | string |     ✅    | `"Beauty products"` | Updated title for the product category |
| `categoryID` | string |     ✅    | `"TEST_CAT_001"`    | Product category ID to update          |

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.toolhouse.ai/toolhouse/integrations/omnisend.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.