> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Omnisend > Omnisend is a marketing automation platform for ecommerce businesses, focusing on email and SMS marketing Omnisend is a marketing automation platform for ecommerce businesses, focusing on email and SMS marketing. `omnisend` · **43 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth omnisend run auth omnisend --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run omnisend # common commands run omnisend --all # every command ``` ```ts theme={"theme":"github-dark"} import { omnisend } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-cart-product` | Tool to add a product to a cart in Omnisend (v3 API). Use when updating cart contents or tracking abandoned carts. | | `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... | | `create-cart` | Tool to create a new shopping cart in Omnisend. Use when tracking customer cart activity for abandoned cart campaigns. | | `create-category` | Tool to create a new category in Omnisend. Use when organizing products into categories. | | `create-order` | Tool to create a new order in Omnisend v3 API. Use when recording a customer purchase or order transaction. | | `create-or-update-contact` | Tool to create or update a contact in Omnisend. Use after collecting subscriber details. | | `create-product` | Tool to create a new product in the Omnisend product catalog. | | `create-product-category` | Tool to create a new product category in the Omnisend catalog. | | `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. | | `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. | | `delete-order` | Tool to delete an order from Omnisend by its ID. Use when you need to remove an order from the system. | | `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. | | `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. | | `get-batches` | Tool to retrieve a list of batch operations. Use after initiating a batch job to monitor its progress and results. | | `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. | | `get-batch-item` | Tool to retrieve a specific item within a batch by batchID and itemID. | | `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. | | `get-brand` | Tool to retrieve information about the current authenticated brand. | | `get-cart` | Tool to retrieve a specific cart by ID from Omnisend v3 API. | | `get-category` | Tool to retrieve details of a specific category by ID. Use when you need to fetch information about a category. | | `get-contact` | Tool to retrieve details of a single contact by ID. Use when you already have a contactId and need the full profile. | | `get-order` | Tool to retrieve details of a specific order by ID. Use when you need order information including products, addresses, and payment details. | | `get-product` | Tool to retrieve details of a specific product by ID from Omnisend. | | `list-campaigns` | Tool to retrieve a paginated list of campaigns with optional filtering by status and type. | | `list-carts` | Tool to retrieve a paginated list of carts with optional filtering. | | Tool | What it does | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-cart-product` | Tool to add a product to a cart in Omnisend (v3 API). Use when updating cart contents or tracking abandoned carts. | | `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... | | `create-cart` | Tool to create a new shopping cart in Omnisend. Use when tracking customer cart activity for abandoned cart campaigns. | | `create-category` | Tool to create a new category in Omnisend. Use when organizing products into categories. | | `create-order` | Tool to create a new order in Omnisend v3 API. Use when recording a customer purchase or order transaction. | | `create-or-update-contact` | Tool to create or update a contact in Omnisend. Use after collecting subscriber details. | | `create-product` | Tool to create a new product in the Omnisend product catalog. | | `create-product-category` | Tool to create a new product category in the Omnisend catalog. | | `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. | | `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. | | `delete-order` | Tool to delete an order from Omnisend by its ID. Use when you need to remove an order from the system. | | `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. | | `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. | | `get-batches` | Tool to retrieve a list of batch operations. Use after initiating a batch job to monitor its progress and results. | | `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. | | `get-batch-item` | Tool to retrieve a specific item within a batch by batchID and itemID. | | `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. | | `get-brand` | Tool to retrieve information about the current authenticated brand. | | `get-cart` | Tool to retrieve a specific cart by ID from Omnisend v3 API. | | `get-category` | Tool to retrieve details of a specific category by ID. Use when you need to fetch information about a category. | | `get-contact` | Tool to retrieve details of a single contact by ID. Use when you already have a contactId and need the full profile. | | `get-order` | Tool to retrieve details of a specific order by ID. Use when you need order information including products, addresses, and payment details. | | `get-product` | Tool to retrieve details of a specific product by ID from Omnisend. | | `get-product-category` | Tool to retrieve a specific product category by ID. Use when you need details about a particular product category. | | `list-campaigns` | Tool to retrieve a paginated list of campaigns with optional filtering by status and type. | | `list-carts` | Tool to retrieve a paginated list of carts with optional filtering. | | `list-categories` | Tool to retrieve a paginated list of product categories. Use when you need category IDs for product management or catalog organization. | | `list-contacts` | Tool to retrieve a paginated list of contacts with optional filtering. | | `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. | | `list-product-categories` | Tool to retrieve a paginated list of product categories from the Omnisend catalog. | | `list-products` | Tool to retrieve a paginated list of products. Use when syncing product catalog before campaign creation. | | `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. | | `replace-cart` | Tool to replace an existing cart in Omnisend using the v3 API. | | `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. | | `replace-category` | Tool to replace a category's title by ID. Use when you need to update an entire category resource. | | `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. | | `replace-product` | Tool to replace an existing product in the Omnisend catalog. | | `send-event` | Tool to send a customer event to Omnisend. Events can trigger automations and track customer behavior. | | `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. | | `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. | | `update-contact` | Tool to update fields of an existing contact by ID. Use after retrieving contact ID. | | `update-order-status` | Tool to partially update an order status in Omnisend (v3 API). | | `update-product-category` | Tool to update an existing product category title in Omnisend. | [Open Omnisend in the console →](https://app.boxd.sh/integrations/detail/omnisend)