Reference

Create Batch

Send large volumes of contacts, products, orders, or events to Omnisend in a single asynchronous operation without hitting rate limits. This is ideal when you need to process multiple records at once instead of making individual API calls.

Get Batch Information

Retrieve detailed status and performance metrics for a specific email batch, including delivery counts and processing information. Use this to monitor the results of campaigns you've sent through Omnisend.

Get Batch Item

Retrieve details about a specific item within a batch to check the status or outcome of a single operation you've sent to your contacts. Use this when you need to verify if an email, SMS, or other communication was successfully processed for a particular recipient.

Get Batch Items

Retrieves the individual items and results from a completed batch operation, allowing you to see exactly what was processed and any results or errors for each item.

Get Batches

Retrieve a list of batch operations to monitor the progress and results of bulk marketing tasks you've initiated. Use this to track the status of email campaigns, contact imports, or other large-scale operations.

Get Brand

Retrieves the current brand's profile information including currency, platform, and website details. Use this to access your brand's core settings and configuration within your Omnisend account.

List Campaigns

Retrieve all your email marketing campaigns in one view with optional filtering by status and type, helping you track and manage your email marketing efforts across multiple campaigns.

Create Cart

Track customer shopping carts in Omnisend to enable abandoned cart recovery campaigns and retargeting efforts. This helps you reconnect with customers who added items but didn't complete their purchase.

Add Cart Product

Adds a product to a customer's cart in Omnisend to track purchase intent and enable abandoned cart recovery campaigns.

Delete Cart

Remove a specific cart from Omnisend to clean up abandoned or outdated shopping sessions. This helps maintain accurate customer data and prevents stale cart information from cluttering your marketing platform.

Get Cart

Retrieve detailed information about a specific customer's shopping cart, including products, quantities, and customer contact details for follow-up actions.

List Carts

Retrieve your store's shopping carts to analyze customer shopping behavior and identify abandoned purchases that need follow-up.

Remove Cart Product

Deletes a specific product from a customer's shopping cart in Omnisend, allowing you to manage cart contents and help customers modify their orders before checkout.

Replace Cart

Completely update a customer's shopping cart in Omnisend by replacing all its contents, including products, prices, and recovery details in one operation.

Replace Cart Product

Swap out a product in a customer's cart with a different item or updated version, keeping the cart intact while changing what they're about to purchase. This is useful for inventory management, product corrections, or upselling alternatives.

Update Cart

Modify cart details in Omnisend such as currency, total amount, recovery URL, or product information without replacing the entire cart.

Update Cart Product

Modify product details in a customer's cart, such as adjusting quantity, price, or other attributes without requiring the customer to manually update their cart. This helps you sync inventory changes, apply dynamic pricing, or correct errors in real-time before checkout.

Create Category

Organize your products by creating new categories in Omnisend to structure your store and make items easier for customers to find.

Create Product Category

Organize your product inventory by creating new product categories in Omnisend, making it easier to manage and segment your catalog for targeted marketing campaigns.

Delete Category

Remove a category from your Omnisend catalog when you no longer need it, ensuring your product organization stays clean and up-to-date.

Delete Product Category

Remove a product category from your Omnisend catalog when you no longer need it or want to reorganize your product structure. This helps keep your product catalog clean and up-to-date for customer communications.

Get Category

Retrieves detailed information about a specific product or content category by its ID, allowing you to access category details for your marketing campaigns and product organization.

Get Product Category

Retrieve detailed information about a specific product category, including its name, description, and configuration. Use this when you need to verify category details or pull category information for customer communications and reporting.

List Categories

Retrieve your product categories to organize and manage your store's catalog structure. This helps you understand your product organization and find category IDs needed for product management tasks.

List Product Categories

Retrieve all product categories from your Omnisend catalog to understand your product organization structure and make data-driven marketing decisions.

Replace Category

Update an existing category's title in your Omnisend account to keep your contact lists organized and accurately labeled. This helps ensure your audience segments remain relevant as your business evolves.

Update Product Category

Modify the name or details of an existing product category in Omnisend to keep your product organization current and aligned with your business structure. This helps ensure your email campaigns reference accurate category information when targeting customers.

Create or Update Contact

Adds a new contact to your Omnisend account or updates an existing contact's information with subscriber details like email, phone, and custom attributes.

List Contacts

Retrieve your contact list from Omnisend with filtering and pagination options to manage and organize your customer database efficiently.

Get Contact

Retrieve complete profile information for a specific contact using their ID. Use this when you need to access detailed contact data for personalization, verification, or segmentation purposes.

Update Contact

Modify contact information like name, email, or custom fields for an existing subscriber in your Omnisend list. This lets you keep customer data accurate and up-to-date as their information changes.

Send Event

Record customer interactions and behaviors in Omnisend to trigger automated marketing campaigns and build a complete activity history. This enables personalized customer journeys based on real actions like product views, purchases, or cart updates.

List Events

Retrieve all custom events you've created in Omnisend to see what automation triggers and tracking options are available for your marketing workflows.

Create Order

Records a customer purchase in Omnisend to sync order data with your email marketing campaigns and customer profiles. This enables you to track sales activity and trigger order-related automations like receipts and follow-ups.

Update Order Status

Modify order status, shipping details, or payment information in Omnisend to keep customer records accurate and up-to-date. This helps you maintain synchronized order data across your sales and marketing channels.

Delete Order

Remove an order from your Omnisend system when it's no longer needed or has been cancelled. This helps keep your customer data and order records accurate and up-to-date.

Get Order

Retrieve complete details about a specific customer order, including products purchased, shipping and billing addresses, and payment information. Use this to access order data for fulfillment, customer support, or business analysis.

Replace Order

Completely updates an existing order in Omnisend by replacing all its details at once, useful when order information needs to be corrected or significantly modified.

List Products

Retrieve your product catalog from Omnisend to view all available products and their details. This is essential for syncing your inventory before creating marketing campaigns or email promotions.

Create Product

Add a new product to your Omnisend catalog so you can feature it in email campaigns and keep your product inventory synchronized across marketing channels.

Delete Product

Removes a product from your Omnisend catalog so it's no longer available for marketing campaigns, email promotions, or customer communications.

Get Product

Retrieve complete details about a specific product from your Omnisend catalog, including variants, pricing, and stock information. Use this when you need to verify product data before sending promotional campaigns or managing inventory.

Replace Product

Completely update an existing product in your Omnisend catalog with new information, replacing all previous product details.