Skip to main content
Omnisend logo
  • Category: marketing automation
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 43
  • Triggers: 0
  • Slug: OMNISEND
  • Version: 20261101_00

Tools

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

Input Parameters

string
Stock keeping unit identifier.
integer
required
Current price in cents (e.g., 12111 for $121.11).
string
required
Product name or title.
string
required
Unique identifier of the cart to add the product to.
string
required
ISO 4217 currency code (3 characters).
integer
Discount amount in cents.
integer
required
Number of items. Must be a whole number greater than or equal to 1.
string
URL to product image.
integer
Original price before discount in cents (e.g., 14311 for $143.11).
string
required
Unique product identifier from your catalog.
string
required
Product variant identifier for tracking specific product variations.
string
Product description text.
string
URL to product page.
string
required
Product identifier in cart. Must be unique within the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_BATCHTool 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.

Input Parameters

array
required
Array of payload objects for each operation.
string ("POST" | "PUT")
required
HTTP method for all operations in this batch. Must be POST or PUT.
string
Required when endpoint is ‘events’; the ID of the event to trigger.
string ("contacts" | "orders" | "products" | "events" | "categories")
required
Target endpoint for the operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_CARTTool to create a new shopping cart in Omnisend. Use when tracking customer cart activity for abandoned cart campaigns.

Input Parameters

string
Customer email address associated with this cart
string
Customer phone number
string
required
Unique cart identifier. Must be unique across all carts.
integer
Total cart value in cents (e.g., 9999 for $99.99)
string
ISO 4217 currency code (e.g., USD, EUR, GBP)
array
Array of products in the cart
string
Existing Omnisend contact identifier to associate with this cart
string
Cart creation timestamp in ISO 8601 format. If not provided, current time is used.
string
Cart last update timestamp in ISO 8601 format
string
URL to recover the cart, used in abandoned cart emails

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_CATEGORYTool to create a new category in Omnisend. Use when organizing products into categories.

Input Parameters

string
required
Display name for the category.
string
required
Unique identifier for the category. Must be unique within your Omnisend account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_ORDERTool to create a new order in Omnisend v3 API. Use when recording a customer purchase or order transaction.

Input Parameters

array
Order tags
string
Customer email address (email or phone or contactID required)
string
Customer phone number (email or phone or contactID required)
string
Cart identifier
string
Order source
integer
Tax amount in cents
string
required
Unique order identifier from your store
string
required
Order currency code (e.g., USD, EUR)
string
Customer last name
integer
required
Total order amount in cents (must be integer, not float)
string
URL to view the order
array
Array of ordered products
string
Omnisend contact ID (email or phone or contactID required)
string
required
Order creation timestamp in ISO 8601 format (cannot be future date, required by API)
string
Customer first name
string
Order last update timestamp in ISO 8601 format
string
Tracking URL
string
Note about the customer or order
integer
Total discount amount in cents
integer
Order number for display
integer
Shipping cost in cents
integer
Subtotal amount in cents
string
Courier service name
object
Custom fields as key-value pairs
string
Discount code applied
string
Type of discount (e.g., fixedAmount, percentage)
string
Shipping tracking code
integer
Discount value in cents
string
Payment method description
string ("awaitingPayment" | "partiallyPaid" | "paid" | "partiallyRefunded" | "refunded" | "voided")
Payment status enum values.
object
Address information for billing or shipping.
string
Shipping method description
object
Address information for billing or shipping.
string ("unfulfilled" | "inProgress" | "fulfilled" | "delivered" | "restocked")
Fulfillment status enum values.
boolean
Whether tax is included in subtotal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_OR_UPDATE_CONTACTCreate or update an Omnisend contact using email identifiers and subscriber details.

Input Parameters

string
City name
string ("m" | "f")
Contact’s gender (‘m’ or ‘f’)
string
Street address
string
Full country name
string
Contact’s last name
string
Birthdate in YYYY-MM-DD format
string
Contact’s first name
string
Postal or ZIP code
string
ISO 3166-1 alpha-2 country code
array
required
One or more ways to identify the contact; at least one required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_PRODUCTTool to create a new product in the Omnisend product catalog. Use when adding products for email campaigns or syncing inventory.

Input Parameters

string
required
Unique product identifier from your store. Must be unique across all products.
string
required
URL to the product page on your website.
array
Tags to categorize the product for filtering and organization (max 100 items).
string
Product type to categorize products (e.g., ‘Electronics’, ‘Clothing’).
string
required
Product title displayed to customers.
array
Additional product image URLs beyond the default image (max 300 items).
string ("inStock" | "outOfStock" | "notAvailable")
required
Overall product availability status. Keep in sync with your shop to avoid sending out-of-stock products.
string
Manufacturer or brand of the product.
string
required
ISO 4217 currency code (e.g., USD, EUR, GBP).
array
required
Product variants with their own prices and SKUs. At least one variant is required (min 1, max 500 items).
string
Product creation timestamp in ISO 8601 format (e.g., 2021-01-01T00:00:00Z).
string
Last update timestamp in ISO 8601 format.
array
List of category IDs this product belongs to (max 100 items).
string
Short description of the product. Can be used in the email body.
string
Primary image URL for the product. Recommended if more than one image is needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_CREATE_PRODUCT_CATEGORYTool to create a new product category in the Omnisend catalog. Use when organizing products into categories.

Input Parameters

string
required
Title/name of the product category. Maximum 100 characters.
string
required
Unique identifier for the product category. Must be between 1 and 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_DELETE_CARTTool 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.

Input Parameters

string
required
Unique identifier of the cart to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_DELETE_CATEGORYTool 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.

Input Parameters

string
required
Unique identifier of the category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_DELETE_ORDERTool to delete an order from Omnisend by its ID. Use when you need to remove an order from the system.

Input Parameters

string
required
Unique identifier of the order to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_DELETE_PRODUCTTool 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.

Input Parameters

string
required
Unique identifier of the product to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_DELETE_PRODUCT_CATEGORYTool to remove a product category from Omnisend by its ID. Use when you need to delete a product category from your catalog.

Input Parameters

string
required
Unique identifier of the product category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_BATCHESRetrieve a list of batch operations for a required target endpoint: contacts, orders, products, events, or categories. Use it to monitor batch progress and results.

Input Parameters

string ("contacts" | "orders" | "products" | "events" | "categories")
required
Target endpoint for the batch operations to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_BATCH_INFORMATIONTool to retrieve information about a specific batch by ID. Use after submitting a batch when you need a detailed status and counts.

Input Parameters

string
required
The unique identifier of the batch to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_BATCH_ITEMTool 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.

Input Parameters

string
required
The unique identifier of the specific item to retrieve within the batch
string
required
The unique identifier of the batch containing the item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_BATCH_ITEMSRetrieve items for a specific Omnisend batch by ID to inspect individual batch operation results. Returned items can include their processing status, original request, response, and response code.

Input Parameters

string
required
The unique identifier of the batch whose items you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_BRANDTool to retrieve information about the current authenticated brand. Use when you need brand details like currency, platform, or website.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_CARTTool to retrieve a specific cart by ID from Omnisend v3 API. Use when you need detailed cart information including products and customer contact details.

Input Parameters

string
required
Unique identifier of the cart to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_CATEGORYTool to retrieve details of a specific category by ID. Use when you need to fetch information about a category.

Input Parameters

string
required
Unique identifier of the category to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_CONTACTTool to retrieve details of a single contact by ID. Use when you already have a contactId and need the full profile.

Input Parameters

string
required
Unique identifier of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_ORDERTool to retrieve details of a specific order by ID. Use when you need order information including products, addresses, and payment details.

Input Parameters

string
required
Unique identifier of the order to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_PRODUCTTool to retrieve details of a specific product by ID from Omnisend. Use when you need full product information including variants, pricing, and stock status.

Input Parameters

string
required
Unique identifier of the product to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_GET_PRODUCT_CATEGORYTool to retrieve a specific product category by ID. Use when you need details about a particular product category.

Input Parameters

string
required
Unique identifier of the product category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_CAMPAIGNSTool 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.

Input Parameters

string
Filter campaigns by type (e.g., regular, automation, split).
integer
Number of results to fetch. Default is 5000, maximum is 5000.
integer
Number of results to skip. Use for pagination. Default is 0.
string ("draft" | "paused" | "scheduled" | "inProgress" | "sent")
Campaign status values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_CARTSTool to retrieve a paginated list of carts with optional filtering. Use when you need to fetch carts by date range, contact, or segment.

Input Parameters

string
Sort order for results.
string
Filter carts by contact email address.
integer
Number of results to fetch. Default is 100, max 250.
string
Filter carts by contact phone number including country code.
string
Cart creation date to. Format: YYYY-MM-DD.
integer
Number of results to skip. Default is 0.
string
Cart creation date from. Format: YYYY-MM-DD.
string
Filter carts by contact ID.
string
Filter carts by segment ID.
string
Cart update date to. Format: YYYY-MM-DD.
string
Cart update date from. Format: YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_CATEGORIESTool to retrieve a paginated list of product categories. Use when you need category IDs for product management or catalog organization.

Input Parameters

string
Field to sort results by. Format: ‘fieldName’ for ascending, ‘-fieldName’ for descending.
integer
Number of results to fetch. Defaults to 100, maximum 250.
integer
Number of results to skip. Defaults to 0. Use for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_CONTACTSTool to retrieve a paginated list of contacts with optional filtering. Use when you need to fetch contacts in batches and handle cursor pagination.

Input Parameters

string
Filter contacts by tag.
string
Cursor for pagination: contacts after this base64-encoded ContactID.
string
Filter contacts by exact email address.
integer
Number of results per page. Defaults to 100, maximum 250.
string
Filter contacts by full phone number including country code.
string
Cursor for pagination: contacts before this base64-encoded ContactID.
string ("subscribed" | "nonSubscribed" | "unsubscribed")
Filter contacts by email channel status.
integer
Filter contacts by segment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_EVENTSTool to retrieve all custom events created in Omnisend app. Use when you need to view available event types for automation workflows or event tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_PRODUCT_CATEGORIESTool to retrieve a paginated list of product categories from the Omnisend catalog. Use when fetching category data for product organization.

Input Parameters

string ("date" | "createdAt" | "updatedAt")
Field to sort by. Allowed values: ‘date’, ‘createdAt’, or ‘updatedAt’.
integer
Maximum number of categories to return. Defaults to 100.
integer
Zero-based index of the first category to return. Use to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_LIST_PRODUCTSTool to retrieve a paginated list of products. Use when syncing product catalog before campaign creation.

Input Parameters

string ("date" | "createdAt" | "updatedAt")
Field to sort by. Allowed values: ‘date’, ‘createdAt’, or ‘updatedAt’.
integer
Maximum number of products to return. Defaults to 100.
integer
Zero-based index of the first product to return. Use to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REMOVE_CART_PRODUCTTool to remove a product from a cart in Omnisend. Use when you need to delete a specific product from a cart.

Input Parameters

string
required
Unique identifier of the cart.
string
required
Unique identifier of the product in the cart to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REPLACE_CARTTool 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.

Input Parameters

string
required
Unique identifier of the cart to replace
integer
required
Total cart value in cents (e.g., 78777 = $787.77)
string
required
ISO 4217 currency code for the cart (e.g., USD, EUR, GBP)
array
required
List of products in the cart
string
ISO 8601 timestamp when the cart was created
string
ISO 8601 timestamp when the cart was last updated
string
URL to restore the cart, used for abandoned cart recovery

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REPLACE_CART_PRODUCTTool 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.

Input Parameters

string
Stock keeping unit identifier.
integer
required
Product price in cents, without commas. For example, for 1.25 USD use 125.
string
required
Product title.
string
required
Unique identifier of the cart containing the product to replace.
string
required
ISO currency code (3 characters).
integer
Discount sum in cents.
string
Link to product image (must be a valid URI).
integer
Old price in cents, without commas. For example, for 1.43 USD use 143.
integer
required
Product quantity (only whole numbers, minimum 1).
string
required
Product identifier.
string
required
Product modification identifier (variant ID).
string
Link to product page (must be a valid URI).
string
Product description.
string
required
Unique identifier of the product in the cart to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REPLACE_CATEGORYTool to replace a category’s title by ID. Use when you need to update an entire category resource.

Input Parameters

string
required
New title for the category
string
required
Unique identifier of the category to replace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REPLACE_ORDERTool to completely replace an existing order in Omnisend. Use when you need to update all order details at once, replacing the entire order record.

Input Parameters

array
Tags associated with the order
string
Identifier of the cart that led to this order
string
Source of the order (e.g., ‘web’, ‘mobile’)
integer
Total tax amount in smallest currency unit
string
required
Unique identifier of the order to replace
string
required
ISO 4217 currency code (e.g., ‘USD’, ‘EUR’)
integer
required
Total order amount in the smallest currency unit (e.g., cents)
string
URL to view the order
array
List of products in the order
string
required
ISO 8601 timestamp when the order was created
string
ISO 8601 timestamp when the order was last updated
string
URL for courier tracking
string
Notes about the customer
integer
Total discount amount in smallest currency unit
integer
Human-readable order number
integer
Shipping cost in smallest currency unit
integer
Subtotal before taxes and shipping in smallest currency unit
string
Reason for order cancellation if applicable
string
ISO 8601 timestamp when the order was canceled
string
Name of the shipping courier
string
Discount or coupon code applied
string
Type of discount (e.g., ‘percentage’, ‘fixed’)
string
Shipment tracking code
integer
Discount value (percentage or fixed amount)
string
Payment method used (e.g., ‘credit_card’, ‘paypal’)
string
Payment status. Available values: awaitingPayment, partiallyPaid, paid, partiallyRefunded, refunded, voided
object
Billing address information for the order.
string
Shipping method used
object
Shipping address information for the order.
string
Fulfillment status (e.g., ‘fulfilled’, ‘unfulfilled’, ‘partially_fulfilled’)
boolean
Whether subtotal includes tax

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_REPLACE_PRODUCTTool to replace an existing product in the Omnisend catalog. Use when you need to completely replace all product data with new information.

Input Parameters

string
required
Product ID - must match the product_id path parameter
string
required
URL pointing to the product page on your website
array
Tags for product categorization (max 100 items)
string
Product type for categorization purposes
string
required
Product title
array
Additional product image URLs (max 300 items)
string ("inStock" | "outOfStock" | "notAvailable")
required
Product stock status. Keep in sync with your shop to avoid sending out-of-stock products
string
Manufacturer or brand of the product
string
required
ISO 4217 currency code (e.g., USD, EUR, GBP)
array
required
Product variants (different versions like sizes/colors). At least one variant required
string
Creation timestamp in ISO 8601 format
string
required
Unique identifier of the product to replace. Must match the product ID in the request body
string
Last update timestamp in ISO 8601 format
string
Short description of the product for email body usage
array
List of category IDs the product belongs to (max 100 items)
string
Primary image URL. Recommended if you need more than one image - additional images go in the images array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_SEND_EVENTTool 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.

Input Parameters

string
required
Source of the event. Use ‘api’ for general API integrations. Platform or app integrations should have dedicated origin values.
object
required
Contact information. Contact will be created or updated based on the data provided. At least one identifier (email, phone, or id) is required.
string
UUID of the event (v4, v5, v6, v7). Used for event deduplication along with eventTime. If not provided, it will be generated automatically.
string
required
Name of the event (e.g., ‘order placed’, ‘product viewed’, ‘test_event’). Check event documentation for standard event names.
string
Event timestamp in RFC3339 format (e.g., ‘2021-07-01T00:00:00Z’). If not provided, current time will be used.
object
Event-specific properties such as order details, product info, etc. Check events guide for recommended properties for each event type.
string
Event version string. Check event documentation for required version for each event. Leave empty for custom events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_UPDATE_CARTPartially update a cart in Omnisend’s v3 API, including its recovery URL or products. Currency and total cart amount are required on every update.

Input Parameters

string
required
Unique identifier of the cart to update
integer
required
Total cart value in cents, without commas. For example, for $1.25 USD use 125
string
required
ISO currency code (3 characters)
array
List of products in the cart
string
URL to recover the cart

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_UPDATE_CART_PRODUCTTool 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.

Input Parameters

string
Stock keeping unit (SKU).
integer
Current price in cents (e.g., 125 for $1.25).
string
Product title.
string
required
Unique identifier of the cart.
string
required
ISO currency code (3 characters). Must match the cart’s currency.
integer
Discount sum in cents.
integer
Product quantity (must be a whole number, minimum 1).
string
Link to product image.
integer
Original price in cents (e.g., 125 for $1.25).
string
Product identifier.
string
Product variant identifier.
string
Product description.
string
Link to product page.
string
required
Unique identifier of the product in the cart to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_UPDATE_CONTACTTool 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’})

Input Parameters

object
required
Fields to update on the contact
string
required
Unique identifier of the contact to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_UPDATE_ORDER_STATUSTool 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.

Input Parameters

string
Identifier of the cart associated with this order.
string
required
Unique identifier of the order to update.
string
URL to track the shipment (must be a valid URI).
string
Reason for order cancellation.
string
ISO 8601 date-time when the order was canceled (e.g., ‘2017-05-30T14:11:12Z’).
string
Name of the courier/shipping company.
string
Tracking code for the shipment.
string
Payment status of the order. You need to map your status with Omnisend’s statuses (e.g., ‘pending’, ‘paid’).
string
Fulfillment status of the order. You need to map your status with Omnisend’s statuses (e.g., ‘unfulfilled’, ‘fulfilled’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OMNISEND_UPDATE_PRODUCT_CATEGORYTool to update an existing product category title in Omnisend. Use when you need to modify a category’s name.

Input Parameters

string
required
Updated title for the product category
string
required
Product category ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not