Simla.com is an omnichannel CRM platform with AI for automating communications, measuring team performance, managing customer data, and integrating delivery services and order management.
Simla.com is an omnichannel CRM platform with AI for automating communications, measuring team performance, managing customer data, and integrating delivery services and order management. On Nagent, Simla.com is exposed as a fully-configurable crm integration that any agent can call — 141 actions, and API key authentication. No code is required to wire Simla.com into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Simla.com to automate the kinds of tasks crm teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Simla.com into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Simla.com, with input parameters and output schema. Drop these into any step of an agent built in Helix.
SIMLA_COM_ADD_CUSTOMER_INTERACTION_FAVORITETool to add a product offer to a customer's list of favorites. Use when you need to save a specific product to a customer's favorites on a particular site.
Input parameters
Site code identifier where the customer is registered (e.g., 'composio')
Favorite object containing the offer information to add
Customer identifier (external ID or internal ID depending on usage)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_COMBINE_CUSTOMERSTool to combine multiple customers into one. The specified customers will be merged into the result customer and then deleted. Use when you need to consolidate multiple customer records. Note: This operation is performed asynchronously - use /api/v5/customers/history to track the result.
Input parameters
List of customer objects to be merged into the result customer (up to 50 customers). These customers will be deleted after the combine operation.
Customer that will remain after combining. All data from the merged customers will be transferred to this customer.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_COMBINE_CUSTOMERS_CORPORATETool to combine multiple corporate customers into one. The specified customers will be merged into the result customer and then deleted. Use when you need to consolidate multiple corporate customer records. Note: This operation is performed asynchronously - use /api/v5/customers-corporate/history to track the result.
Input parameters
List of corporate customer objects to be merged into the result customer. These customers will be deleted after the combine operation.
Corporate customer that will remain after combining. All data from the merged customers will be transferred to this customer.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_COMBINE_ORDERSTool to combine two orders into one. The source order will be merged into the result order using the specified technique. Use when you need to consolidate order data from one order into another.
Input parameters
Source order to be combined (this order will be merged into the result order)
Technique for combining orders. Use 'summ' to sum up the orders' data.
Target order that will receive the combined data (destination order)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_COSTCreate a new cost record in Simla CRM. Use this to track business expenses with period dates, amounts, and cost categories. Required fields: dateFrom (start date), dateTo (end date), summ (amount), and costItem (category code). The cost amount must be positive and costItem must match an existing cost item in the system. Optionally associate the cost with specific stores or users.
Input parameters
Cost details including period dates, amount, cost item, and optional comment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERCreates a new customer in Simla.com. All customer fields are optional - provide at least one field (e.g., firstName, email, or phone) to create a customer. Returns the customer ID upon successful creation.
Input parameters
The customer object to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMER_CORPORATECreates a new corporate customer in Simla.com. Use when you need to add a new business or organization as a customer. At least one field (typically nickName or externalId) should be provided. Returns the corporate customer ID upon successful creation.
Input parameters
The corporate customer object to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMER_INTERACTION_CART_SETTool to create or overwrite shopping cart data for a customer. Use when you need to set cart contents for customer interaction tracking. This overwrites any existing cart data for the specified customer.
Input parameters
Shopping cart data including customer and items
Site code identifier where the cart belongs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_ADDRESSESCreates a new address for a corporate customer in Simla.com. Use when adding a delivery or billing address to an existing corporate customer account. The address can be specified as simple text or with detailed components (street, city, region, etc.).
Input parameters
Site code if managing multiple sites (optional)
Address object to create. Provide either 'text' for a simple address or detailed components
External ID or internal ID of the corporate customer
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_COMPANIESTool to create a company for a corporate customer in Simla.com. Use when you need to add a new company to an existing corporate customer record. Returns the newly created company ID on success.
Input parameters
Company data to create. Must include at minimum the company name.
The external ID of the corporate customer to create a company for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_CONTACTSTool to create a link between a corporate customer and a contact person. Use when you need to associate an existing customer as a contact for a corporate customer entity.
Input parameters
Identifier type for the corporate customer lookup - use 'externalId' or 'id'
Internal numeric ID of the corporate customer. Required when by='id'.
Site code for multi-site configurations
Contact data containing customer reference (either customer.id or customer.externalId must be provided)
External ID of the corporate customer to link the contact to. Required when by='externalId' (the default).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_NOTESTool to create a note for a corporate customer. Use when you need to add notes or comments to corporate customer records. Requires either customer ID or external ID to identify the corporate customer.
Input parameters
Note data including customer reference and text
Site code for multi-store configurations (optional, uses default if omitted)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOMERS_NOTESTool to create a note for a customer. Use when you need to add notes or comments to customer records. Requires either customer ID or external ID to identify the customer.
Input parameters
Note data including customer reference and text
Site code for multi-store configurations (optional, uses default if omitted)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOM_FIELDTool to create a custom field for a specified entity in Simla. Use when you need to extend orders, customers, corporate customers, or companies with custom metadata fields.
Input parameters
Symbolic code for the field (lowercase letters, numbers, underscores, must start with letter). Automatically generated if omitted.
Display name of the custom field.
Data type of the custom field.
The entity to which the custom field will be added.
Whether the field is shown in list views.
Whether the field is available in filtering UI.
Display order of the field (defaults to 50).
Whether this field is mandatory.
Form visibility mode (defaults to editable).
Related directory code (required if type is dictionary or multiselect_dictionary).
UI area where the field is displayed. Depends on entity type.
Whether the field can be used in bulk actions.
Mobile app visibility mode (defaults to editable).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_CUSTOM_FIELDS_DICTIONARIESTool to create a custom fields dictionary with elements. Use when you need to create a new directory for dictionary-type or multiselect_dictionary-type custom fields.
Input parameters
Symbolic code for the dictionary (only at creation), must match pattern ^\[a-z\]\[\\w_-\]+$
Name of the custom dictionary
List of dictionary elements (at least one element is required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_LOYALTY_CALCULATETool to calculate maximum loyalty discount and bonuses for an order. Use when you need to preview loyalty benefits before order creation or show customers potential savings based on their loyalty status.
Input parameters
Site code if managing multiple sites (uses default if omitted)
Order details including customer, items, and delivery for discount calculation
Number of loyalty bonuses to apply/charge in the calculation
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_ORDERCreate a new order in Simla with customer details and line items. This action registers an order with customer information, items (with offer IDs), delivery address, and optional metadata. The API automatically creates customers and offers if they don't exist. Returns complete order details including assigned order ID and number. Key requirements: - At least one item with a valid offer identifier (id, externalId, or xmlId) - Quantity must be greater than 0 - Customer contact info (name/phone/email) is optional but recommended
Input parameters
Site/store code if managing multiple sites (optional, uses default if omitted)
Order details including customer info, items, and delivery
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_ORDERS_LINKTool to create a link between multiple orders in Simla. Use when you need to associate two or more orders together with an optional comment.
Input parameters
Link details containing orders to link and optional comment
Site code (required if API key has access to multiple stores)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_ORDERS_PACKSTool to create a new order pack in Simla. Use when you need to register pack shipment details for an order item, including store location, quantity, shipment date, and invoice/delivery note numbers.
Input parameters
Pack details including item ID, store, quantity, and shipment information
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_ORDERS_PAYMENTS_CREATECreate a new payment record for an order in Simla CRM. Use when recording payments received for orders. Required fields: type (payment type code), amount (must be positive), and order reference (id or externalId). The payment type must match an existing payment type in the system (e.g., 'cash', 'bank-card'). Use this to track payment transactions against specific orders.
Input parameters
Site/store code if API key has access to multiple sites (optional, uses default if omitted)
Payment details including type, amount, and order reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_REFERENCE_COURIERTool to create a new courier in Simla.com. Use when you need to add a new courier to the system for delivery management. Returns the courier ID upon successful creation.
Input parameters
Courier object to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_REFERENCE_CURRENCIESTool to create a new currency in Simla.com. Use when you need to add a new currency to the system for financial operations and multi-currency support.
Input parameters
Currency object to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_STORE_INVENTORIES_UPLOADTool to batch update inventory quantities and purchase prices across warehouses/stores. Use when you need to sync stock levels and cost pricing for offers. Updates leftover stocks (available quantity) and purchasing prices for existing offers in the system.
Input parameters
Site code for multi-site configurations (optional)
Array of inventory items to update with store quantities and prices
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_STORE_PRODUCT_GROUPSTool to create a new product group in Simla.com store. Use when you need to add a new product group for organizing products. Returns the product group ID upon successful creation.
Input parameters
Product group object to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_STORE_PRODUCTS_BATCH_CREATETool to batch create products and services in the store catalog. Use when you need to create multiple products at once. Each product requires a name, article (SKU), and catalogId that matches the catalog parameter.
Input parameters
Catalog ID from the site configuration (retrieve from /api/v5/reference/sites)
Array of product objects to create in batch (at least one product required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_TASKTool to create a new task. Use after gathering task details and assignees.
Input parameters
Task description text
Related entity reference for the task
ID of the user assigned to the task (performer)
Additional comment for the task
Customer reference for the task
Task deadline in ISO 8601 datetime format
Type/identifier of the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_CREATE_WEB_ANALYTICS_VISITS_UPLOADTool to batch upload web analytics visit records to Simla CRM. Use when tracking customer visits with traffic source attribution. Each visit must include site code, customer identifier, timestamp, and traffic source/medium information.
Input parameters
Array of visit records to upload in batch (at least one visit required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_DELETE_COSTTool to delete a cost by ID. Use when you need to remove a cost record from the system.
Input parameters
Cost ID to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_DELETE_CUSTOMERS_CORPORATE_NOTETool to delete a corporate customer note by ID. Use when you need to remove a note record from a corporate customer.
Input parameters
Corporate customer note ID to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_DELETE_CUSTOMERS_NOTETool to delete a customer note by ID. Use when you need to remove a note record from a customer.
Input parameters
The internal ID of the customer note to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_DELETE_ORDER_PAYMENTTool to delete an order payment by ID. Use when you need to remove a payment record from an order.
Input parameters
Payment ID to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_COSTTool to edit an existing cost record by ID. Use when you need to update cost details such as amount, dates, cost item, or attribution information for expense tracking and analysis.
Input parameters
Unique identifier of the cost record to edit. Must be a positive integer representing an existing cost ID.
Cost object with fields to update (at least one field should be provided)
Store code, required when referencing orders by externalId or number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOMERTool to edit an existing customer. Use when you need to update customer details by external ID.
Input parameters
Customer's gender; 'male' or 'female'
Customer's email address
Customer's phone number
Customer's address details
Customer's date of birth in 'Y-m-d' format
Customer's last name
Customer's first name
External identifier of the customer to edit
Custom fields associated with the customer
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOMER_CORPORATETool to edit an existing corporate customer. Use when you need to update corporate customer details such as nickname, discount, VIP status, or custom fields by external ID.
Input parameters
Type of identifier used for the corporate customer ('id' for internal ID, 'externalId' for external ID)
Site code for multi-site installations
Corporate customer identifier (ID or external ID depending on 'by' parameter)
Corporate customer object with fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_ADDRESSTool to edit an address for a corporate customer. Use when you need to update address details (name, city, street, building, etc.) for a specific corporate customer address by its external ID.
Input parameters
Site code for multi-site installations
Address object containing the fields to update. Provide only the fields you want to change.
External ID of the corporate customer
External ID of the address entity to edit
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_COMPANYTool to edit a company associated with a corporate customer. Use when you need to update company details such as name or main status for a corporate customer's company entity.
Input parameters
Type of identifier used for the corporate customer ('id' for internal ID, 'externalId' for external ID)
Site code where the corporate customer belongs
Company object with fields to update
Type of identifier used for the company entity ('id' for internal ID, 'externalId' for external ID)
Corporate customer identifier (ID or external ID depending on 'by' parameter)
Company entity identifier (ID or external ID depending on 'entityBy' parameter)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_CONTACTSTool to edit the link between a corporate customer and a contact person. Use when you need to update contact properties such as marking a contact as the main contact person for a corporate customer.
Input parameters
Identifier type for the corporate customer lookup - use 'externalId' or 'id'
Site code for multi-site configurations
Contact data to update - currently supports 'isMain' field to set/unset as main contact
Identifier type for the contact person lookup - use 'externalId' or 'id'
Identifier of the corporate customer (ID or external ID depending on 'by' parameter)
Identifier of the contact person (ID or external ID depending on 'entityBy' parameter)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOM_FIELDEdit an existing custom field's properties by entity type and field code. Use this to modify custom field settings such as display name, description, type, visibility flags, sort order, default values, or settings (for dictionary-type fields). At least one property besides entity and code must be provided. The field must already exist.
Input parameters
Unique code of the custom field to edit.
New display name for the custom field.
Sort order index; must be non-negative.
Data type of the custom field.
The entity type to which the custom field belongs.
Whether the custom field is active/enabled.
Additional settings for dictionary-type fields. Each item should have 'key' (internal value) and 'label' (display text) properties. Used to define dropdown/select options.
Whether the custom field is visible in UI.
Whether the custom field is editable by users.
Whether the custom field is required.
Detailed description of the custom field.
New default value for the custom field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_CUSTOM_FIELDS_DICTIONARYTool to edit an existing custom fields directory by code. Use when you need to update the directory name or modify its elements (add, remove, or reorder entries).
Input parameters
The symbolic identifier of the directory being modified (path parameter)
The updated display name for the directory
Array of directory elements (entries). Each element must have a name, and optionally a code and ordering value. Must contain at least one element.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_DELIVERY_GENERIC_SETTINGTool to register or edit a delivery service integration configuration. Use when you need to create a new delivery service integration or update existing delivery settings including API endpoints, statuses, custom fields, and integration metadata.
Input parameters
Delivery service integration subcode identifier (used in URL path)
Complete delivery service configuration including name, URLs, actions, statuses, and settings
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_FILETool to edit an existing file by ID. Use when you need to update file properties such as filename.
Input parameters
The ID of the file to edit. Must be a positive integer.
File object with fields to update (e.g., filename)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_INTEGRATION_MODULETool to create or edit an integration module configuration. Use when you need to register or update an integration module with its base URL, client ID, and display settings.
Input parameters
Code identifier of the integration module to edit
Integration module configuration data to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_ORDERTool to edit an existing order by external ID. Use when you need to update order details by external ID.
Input parameters
Code of the site where the order belongs
Order object with fields to update
External ID of the order to edit
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_ORDERS_PAYMENTTool to edit an existing order payment. Use when you need to update payment details such as amount, status, or type.
Input parameters
Payment ID to edit
Payment object with fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_COST_GROUPTool to edit an existing cost group by code. Use when you need to update cost group properties such as name, color, active status, or display ordering.
Input parameters
The cost group code (symbolic identifier) to edit
Cost group object with fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_COST_ITEMTool to edit an existing cost item reference by code. Use when you need to update cost item properties such as name, group, type, or activation status in the system's cost item directory.
Input parameters
Symbolic code of the cost item to edit. Must match an existing cost item code in the system.
Cost item fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_COURIERTool to edit an existing courier by ID. Use when you need to update courier details such as name, email, phone, or active status.
Input parameters
Courier ID (internal identifier)
Courier data object with fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_CURRENCYTool to edit an existing currency configuration by ID. Use when you need to update currency properties such as base currency status, auto-conversion settings, or conversion rates.
Input parameters
Unique identifier of the currency to edit
Currency object containing the fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_DELIVERY_SERVICETool to edit an existing delivery service by code. Use when you need to update delivery service properties such as name, code, or active status.
Input parameters
The delivery service code (symbolic identifier) to edit
Delivery service object with fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_DELIVERY_TYPESTool to create or edit a delivery type in Simla.com. Use when you need to add a new delivery type or modify an existing one. This endpoint handles both creation (if the code doesn't exist) and updates (if it does). Provide at least the name and active status.
Input parameters
The symbolic code of the delivery type to create or edit
Delivery type object with properties to create or update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_ORDER_METHODTool to edit an existing order method reference by code. Use when you need to update order method properties such as name, active status, or default settings in the system's order method directory.
Input parameters
Symbolic code of the order method to edit. Must match an existing order method code in the system.
Order method fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_ORDER_TYPETool to create or edit an order type by code. Use when you need to create a new order type or update properties of an existing one such as name, active status, or default settings.
Input parameters
The symbolic code of the order type to create/edit
Order type object with fields to create or update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_PAYMENT_STATUSTool to edit an existing payment status reference by code. Use when you need to update payment status properties such as name, active status, or default settings in the system's payment status directory.
Input parameters
Symbolic code of the payment status to edit. Must match an existing payment status code in the system.
Payment status fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_PAYMENT_TYPETool to edit an existing payment type or create a new one by code. Use when you need to update payment type properties such as name, code, active status, description, ordering, or default settings.
Input parameters
The payment type code (symbolic identifier) to edit or create
Payment type object with fields to update or create (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_PRICE_TYPETool to edit an existing price type in the reference data. Use when you need to update price type properties such as name, active status, default flag, or associated customer groups.
Input parameters
The symbolic code of the price type to edit
The name of the price type
Whether the price type is active and available for use
Customer group codes associated with this price type
Whether this price type should be set as the default
Currency code for the price type (ISO 4217, e.g., USD, EUR)
Display ordering of the price type (lower numbers appear first)
Description of the price type
Filter expression for the price type (defines when this price applies)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_PRODUCT_STATUSTool to create or edit product status in the reference directory. Use when you need to add a new product status or update an existing one. Set code to 'new' when creating a new status, or use the existing status code to edit.
Input parameters
Symbolic code of the product status to create or edit (use 'new' for creating new statuses)
Product status fields to create or update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_STATUSESTool to edit an existing order status reference by code. Use when you need to update order status properties such as name, active status, display ordering, or group classification in the system's status directory.
Input parameters
Symbolic code of the order status to edit. Must match an existing status code in the system.
Status fields to update (at least one field should be provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_STORESTool to create or edit a warehouse/store by code. Use when you need to update store information such as name, contact details, address, or active status.
Input parameters
Store code identifier (path parameter)
Store data object with fields to edit
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_SUBSCRIPTIONTool to create or edit a subscription category in Simla. Use when you need to configure subscription categories for different communication channels (email, sms, waba). Creates a new subscription category if the code doesn't exist, or updates an existing one.
Input parameters
Unique code identifier for the subscription category
Communication channel for the subscription (e.g., 'email', 'sms', 'waba')
Subscription category configuration data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_REFERENCE_UNITTool to create or edit a unit of measurement reference by code. Use when you need to add new units or update existing unit properties such as name or symbol in the system's unit directory.
Input parameters
Alphanumeric code of measurement unit. Can contain a-Z, 0-9, underscore, dash. First symbol should be a-z. Maximum 255 characters.
Unit properties to create or update. At least one field (name or sym) should be provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_STORE_PRODUCT_GROUPTool to edit an existing product group by external ID. Use when you need to update product group details such as name, site, or active status.
Input parameters
External ID of the product group to edit
Product group object with fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_STORE_PRODUCTS_BATCHTool to batch edit multiple products and services at once. Use when you need to update multiple products in a single operation. This action allows updating multiple product fields (name, price, quantity, active status, etc.) for multiple products in a single API call. Each product must be identified by its internal ID. Returns the count of successfully processed products and any products that were not found.
Input parameters
Array of product objects to edit. Each product must contain 'id' field and the fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_STORE_SETTINGTool to register or update warehouse system configuration in Simla. Use when you need to configure a warehouse integration with name, code, and account URL.
Input parameters
Warehouse system identifier code (used in the URL path)
Warehouse configuration object containing name, code, and accountUrl
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_TASKTool to edit an existing task. Use after confirming task ID and fields to update. Updates only provided fields on the task.
Input parameters
Unique identifier of the task to edit
Object containing one or more fields to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_EDIT_TELEPHONY_SETTINGTool to create or edit a telephony integration setting in Simla. Use when you need to register or update a telephony integration with its configuration including client ID, name, active status, and optional webhook URLs for call handling.
Input parameters
Unique telephony integration code identifier (used in URL path)
Telephony configuration object with all integration settings
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_FIX_CUSTOMERS_CORPORATE_EXTERNAL_IDSTool to perform mass recording of corporate customer external IDs in Simla. Use when you need to map internal corporate customer IDs to external system identifiers in bulk. Accepts an array of corporate customer ID mappings and assigns external IDs to the corresponding corporate customers.
Input parameters
Array of corporate customer ID mappings. Each entry contains the internal corporate customer ID and the external ID to assign to it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_FIX_CUSTOMERS_EXTERNAL_IDSTool to perform mass recording of customer external IDs in Simla. Use when you need to map internal customer IDs to external system identifiers in bulk. Accepts an array of customer ID mappings and assigns external IDs to the corresponding customers.
Input parameters
Array of customer ID mappings. Each entry contains the internal customer ID and the external ID to assign to it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_FIX_ORDERS_EXTERNAL_IDSTool to perform mass recording of order external IDs in Simla. Use when you need to map internal order IDs to external system identifiers in bulk. Accepts an array of order ID mappings and assigns external IDs to the corresponding orders.
Input parameters
Array of order ID mappings. Each entry contains the internal order ID and the external ID to assign to it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_API_CREDENTIALSTool to retrieve available API methods and stores for the current API key. Use when you need to verify API permissions or discover which endpoints and sites are accessible.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_API_VERSIONSTool to retrieve a list of available API versions. Use when you need to discover which API versions are supported by the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_COSTRetrieves detailed information about a specific cost record by its ID. Use this when you need to fetch cost data including amount, dates, cost item, and attribution details before analyzing or updating cost records.
Input parameters
Unique identifier of the cost record to retrieve. Must be a positive integer representing an existing cost ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERRetrieves detailed information about a specific customer by ID or external ID. Returns comprehensive customer data including contact info, address, subscriptions, order statistics, and custom fields. Use this when you need complete customer details for a known identifier.
Input parameters
Identifier type: 'id' for internal numeric ID, 'externalId' for external string ID
Symbolic code of the store to filter by (optional). Use when customer belongs to a specific site
The customer identifier. This can be either an internal ID (numeric) or external ID (string) depending on the 'by' parameter
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMER_CORPORATERetrieves detailed information about a corporate customer by external ID. Returns comprehensive corporate customer data including tags, custom fields, order statistics, and discount information. Use this when you need complete corporate customer details for a known external identifier.
Input parameters
External ID of the corporate customer to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMER_INTERACTION_FAVORITESTool to retrieve a list of favorite product offers for a specific customer. Use when you need to fetch customer's saved favorites from a particular site.
Input parameters
Type of customer identifier: 'id' for internal numeric ID (default), 'externalId' for external string ID
Site code identifier where the customer is registered
Customer identifier (ID or external ID depending on 'by' parameter)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERSTool to retrieve a list of customers. Use after setting optional filters (IDs, email, custom fields) to fetch paginated customer data.
Input parameters
Filter customers by a list of IDs
Page number for pagination
Filter customers by email address
Number of customers to return per page
Filter customers by a custom field key
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_CORPORATETool to retrieve a list of corporate customers matching the specified filters. Use after setting optional filters (managers, manager groups, discount card, IDs) to fetch paginated corporate customer data.
Input parameters
Filter by array of internal identifiers
Page number for pagination (default: 1)
Number of results per page (default: 20, max: 100)
Filter by internal IDs of managers
Filter by array of external identifiers
Filter by symbol codes of manager groups
Filter by discount card number (if Loyalty module is active)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_CORPORATE_COMPANIESTool to retrieve the list of companies associated with a corporate customer contact person. Use when you need to see which companies are linked to a specific corporate customer.
Input parameters
Page number for pagination
Number of items per page (valid values: 20, 50, or 100)
The external ID of the corporate customer to retrieve companies for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_CORPORATE_HISTORYTool to retrieve corporate customer change history for synchronization or audit purposes. Use when tracking corporate customer modifications over time or implementing incremental data sync with sinceId.
Input parameters
Page number for pagination (starts at 1)
Number of history records to return per page. Must be 20, 50, or 100 (default: 20)
End datetime of change period in Y-m-d H:i:s format (e.g., '2024-12-31 23:59:59')
Starting history ID for incremental synchronization. Use the ID from the last processed record to get only newer changes.
Start datetime of change period in Y-m-d H:i:s format (e.g., '2024-01-01 00:00:00')
Filter history by specific corporate customer ID
Filter history by external corporate customer ID reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_CORPORATE_NOTESTool to retrieve a list of corporate customer notes. Use when you need to fetch notes with optional filters (note IDs, corporate customer IDs, manager IDs, text search, date range) and pagination.
Input parameters
Filter notes by a list of note internal identifiers
Page number for pagination (default: 1)
Filter notes by partial text match
Number of notes to return per page (default: 20). Allowed values: 20, 50, 100
Filter notes by a list of manager internal identifiers
End of creation time range in ISO 8601 format
Filter notes by a list of corporate customer internal identifiers
Start of creation time range in ISO 8601 format
Filter notes by a list of corporate customer external identifiers
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_HISTORYTool to retrieve customer change history for synchronization or audit purposes. Use when tracking customer modifications over time or implementing incremental data sync with sinceId.
Input parameters
Page number for pagination (starts at 1)
Number of history records to return per page. Must be 20, 50, or 100 (default: 20)
End datetime of change period in Y-m-d H:i:s format (e.g., '2024-12-31 23:59:59')
Starting history ID for incremental synchronization. Use the ID from the last processed record to get only newer changes.
Start datetime of change period in Y-m-d H:i:s format (e.g., '2024-01-01 00:00:00')
Filter history by specific customer ID
Filter history by external customer ID reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOMERS_NOTESTool to retrieve a list of customer notes. Use when you need to fetch notes with optional filters (note IDs, customer IDs, manager IDs, text search, date range) and pagination.
Input parameters
Filter notes by a list of note internal identifiers
Page number for pagination (default: 1)
Filter notes by partial text match
Number of notes to return per page (default: 20). Allowed values: 20, 50, 100
Filter notes by a list of manager internal identifiers
End of creation time range in ISO 8601 format
Filter notes by a list of customer internal identifiers
Start of creation time range in ISO 8601 format
Filter notes by a list of customer external identifiers
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOM_FIELDTool to retrieve detailed information about a specific custom field by entity and code. Use when you need to get properties and settings of a particular custom field.
Input parameters
Symbolic code of the custom field. Must start with a lowercase letter and contain only alphanumeric characters and underscores.
Entity type for the custom field (customer, loyalty_account, or order)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOM_FIELDSTool to list custom fields. Use when retrieving custom field definitions with optional filtering by entity or code.
Input parameters
Page number to return (default: 1)
Number of records per page (default: 20, max: 250)
Filter by entity type (e.g., customer, order)
Filter by custom field code
Filter by custom field type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOM_FIELDS_DICTIONARIESTool to retrieve the list of custom dictionaries. Use when you need to get available custom directory definitions with their elements and codes.
Input parameters
Page number for pagination (default: 1)
Number of items per page (valid values: 20, 50, 100, 250)
Filter by symbolic code
Filter by dictionary name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_CUSTOM_FIELDS_DICTIONARYTool to retrieve a custom fields dictionary by its code identifier. Use when you need to get detailed information about a specific dictionary including its name, code, and all elements.
Input parameters
The code identifier of the custom dictionary to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_DELIVERY_GENERIC_SETTINGTool to retrieve integration configuration for a delivery module instance. Use when you need to fetch delivery service settings including metadata, supported actions, and status mappings.
Input parameters
Symbolic code of the delivery module instance specified in integrationModule\[code\] when registering the delivery service
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_DELIVERY_SHIPMENTSTool to retrieve a list of delivery shipments. Use when you need to fetch shipments with optional date filters and pagination.
Input parameters
Page number for pagination
Valid limit values for pagination
Filter shipments by date to (format: Y-m-d, e.g., 2024-12-31)
Filter shipments by date from (format: Y-m-d, e.g., 2024-01-01)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_FILESTool to retrieve a list of files. Use when you need to fetch files with optional filters like IDs and pagination.
Input parameters
Filter by a list of file IDs
Page number to retrieve (default: 1)
Valid limit values for files endpoint
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_LOYALTY_ACCOUNTSTool to retrieve a list of customer loyalty program accounts. Use when you need to fetch loyalty accounts with optional filters (loyalty program IDs, phone number) and pagination.
Input parameters
Page number for pagination
Number of loyalty accounts to return per page
Filter by array of loyalty program IDs
Filter loyalty accounts by customer phone number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_LOYALTY_BONUS_OPERATIONSTool to retrieve the history of bonus account operations for all participations. Use when you need to fetch loyalty bonus transaction history with optional date range and type filters.
Input parameters
Page number for pagination
Number of bonus operations to return per page. Must be exactly 20, 50, or 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_LOYALTY_LOYALTIESTool to retrieve a list of loyalty programs. Use when you need to fetch available loyalty programs with optional pagination.
Input parameters
Page number for pagination (default: 1)
Number of loyalty programs per page (default: 20)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_ORDERTool to retrieve detailed information about a specific order. Use when you need to fetch full order data by external ID before further processing.
Input parameters
External identifier of the order to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_ORDERSTool to retrieve a list of orders. Use when you need to fetch orders with optional filters (order numbers, custom fields) and pagination.
Input parameters
Page number for pagination (default: 1)
Number of orders per page (default: 20)
List of order numbers to filter by
Filters for custom fields, as a dict where each key is the field name and value defines min/max
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_ORDERS_HISTORYTool to retrieve order change history. Use when you need to track changes to orders over time with optional date filters and pagination via sinceId.
Input parameters
Page number for pagination. Note: Since May 15, 2023, using both page and filter\[sinceId\] together returns HTTP 400 error. Recommended to use filter\[sinceId\] instead of page for pagination.
Pagination limit for number of records returned. Default and maximum is 100.
Filter to get records starting from a specific history ID. Used for pagination in subsequent calls. Should contain the last history record ID from previous call.
Filter history by start date (e.g., history for 1 month). Format: YYYY-MM-DD HH:MM:SS
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_ORDERS_PACKS_HISTORYTool to retrieve the history of order packing changes. Use when you need to track pack status updates, modifications, or apply warehouse system synchronization. Call without parameters initially, then use sinceId for incremental updates.
Input parameters
Page number for pagination when totalPageCount > 1
ID from the last processed history record. Use this in subsequent calls to get only new changes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_PRODUCTSTool to retrieve a list of products. Use when you need to list products with optional filters.
Input parameters
Filter by a list of product IDs
Filter by product name
Page number to retrieve (default: 1)
Number of products to return per page (max: 250)
Filter active products
Filter by available quantity
Filter products by maximum price
Filter products by minimum price
Filter by external product ID
ISO8601 datetime; only products created before this timestamp
ISO8601 datetime; only products updated before this timestamp
ISO8601 datetime; only products created after this timestamp
ISO8601 datetime; only products updated after this timestamp
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_COST_GROUPSTool to retrieve a list of all cost groups configured in the system. Use when you need to discover available cost groups for organizing expenses or costs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_COST_ITEMSTool to retrieve a list of all cost items configured in the system. Use when you need to discover available cost item codes for order or operation cost tracking.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_COUNTRIESTool to retrieve a list of all available country ISO codes in the system. Use when you need to discover available countries for order or customer creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_COURIERSTool to retrieve the list of available couriers. Use when you need to fetch courier information or get courier codes for deliveries.
Input parameters
Page number for pagination
Number of couriers per page (items to return)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_CURRENCIESTool to retrieve the list of all configured currencies in the system. Use when you need to discover available currencies for order creation or financial operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_DELIVERY_SERVICESTool to retrieve a list of all configured delivery services in the system. Use when you need to discover available delivery services for order creation or to get delivery service codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_DELIVERY_TYPESTool to retrieve the list of delivery types from the system. Use when you need to discover available delivery types for order management or to get delivery type codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_LEGAL_ENTITIESTool to retrieve a list of all configured legal entities in the system. Use when you need to get available legal entity codes or legal entity details for business operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_MG_CHANNELSTool to retrieve a list of all MessageGateway channels in the system. Use when you need to discover available messaging channels for communication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_ORDER_METHODSTool to retrieve a list of all available order methods in the system. Use when you need to discover available order methods for order creation or to get order method codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_ORDER_TYPESTool to retrieve the list of order types from the system. Use when you need to discover available order types for order management or to get order type codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_PAYMENT_STATUSESTool to retrieve the list of payment statuses configured in the system. Use when you need to discover available payment statuses or get payment status codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_PAYMENT_TYPESTool to retrieve a list of all configured payment types in the system. Use when you need to discover available payment methods for orders or to get payment type codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_PRICE_TYPESTool to retrieve the list of price types from the reference data. Use when you need to discover available price types for order or product pricing.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_PRODUCT_STATUSESTool to retrieve the list of all product statuses configured in the system. Use when you need to discover available product statuses for order items or to get status codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_STATUSESTool to retrieve the list of order statuses from the system. Use when you need to discover available statuses for order management or to get status codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_STATUS_GROUPSTool to retrieve the list of all order status groups in the system. Use when you need to discover available status groups for order processing or categorization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_SUBSCRIPTIONSTool to retrieve the list of all subscription categories in the system. Use when you need to discover available subscription channels (email, sms, waba) and their configuration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_REFERENCE_UNITSTool to retrieve the list of units of measurement from the system. Use when you need to discover available units for product management or to get unit codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_SEGMENTSTool to retrieve a list of customer segments. Use when you need to list segments with optional filters after authentication.
Input parameters
Page number for pagination. Default is 1.
Symbolic code of the store. Required if the API key has access to multiple stores.
Number of segments per page. Must be 20, 50, or 100. Default is 20.
Filter segments by name.
Filter segments by active status.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_SETTINGSTool to retrieve system settings including default currency, language, timezone, and message gateway configuration. Use when you need to discover system-wide configuration or settings for the account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_SITESTool to retrieve a list of all configured sites/stores in the system. Use when you need to discover available sites for order creation or to get site codes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STATISTIC_UPDATETool to trigger an update of CRM basic statistics. Use when you need to refresh statistical data in the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STORE_INVENTORIESTool to retrieve store inventories with leftover stocks and purchasing prices. Use when you need to check inventory levels across warehouses or get cost pricing information for offers.
Input parameters
Page number for pagination (default: 1)
Allowed values for limit parameter
Filter by a list of offer IDs
Include detailed information (1 for yes, 0 for no)
Filter by product active status (1 for active, 0 for inactive)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STORE_OFFERSTool to retrieve a list of store offers with pagination support. Use when you need to fetch available offers from the store catalog.
Input parameters
Page number for pagination (default: 1)
Number of offers to return per page. Must be one of: 20, 50, or 100 (default: 20)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STORE_PRODUCTS_PROPERTIESTool to retrieve a list of product properties from the store. Use when you need to fetch product property definitions with pagination support.
Input parameters
Page number for pagination (default: 1)
Number of items per page (default: 20)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STORE_PRODUCTS_PROPERTIES_VALUESTool to retrieve product property values from the store. Use when you need to list property values with optional filters.
Input parameters
Page number to retrieve (default: 1)
Number of property values to return per page. Must be 20, 50, or 100
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_STORESTool to retrieve a list of all warehouses/stores in the system. Use when you need to discover available stores for inventory management or order fulfillment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_TASKRetrieves detailed information about a specific task by its ID. Use this to view task details including description, deadline, completion status, assigned performer, and related entities (orders, customers) before editing, completing, or analyzing tasks.
Input parameters
Unique identifier of the task to retrieve. Must be a positive integer representing an existing task ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_TASKSTool to retrieve a list of tasks with optional filters. Use when you need to fetch tasks after specifying filter criteria like IDs, status, or date range.
Input parameters
Filter by specific task IDs
Maximum number of tasks to return
Related entities to expand in the response
Custom filter conditions as defined by the API (array of objects)
Number of tasks to skip for pagination
Filter tasks by status
Filter by related order IDs
ISO 8601 datetime to include tasks created on or before this timestamp
ISO 8601 datetime to include tasks created on or after this timestamp
Filter by IDs of users responsible for the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_TASKS_COMMENTSTool to retrieve comments on a specific task by task ID. Use when you need to view all comments associated with a task for context, collaboration, or audit purposes.
Input parameters
Unique identifier of the task to retrieve comments for. Must be a positive integer representing an existing task ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_TASKS_HISTORYTool to retrieve task change history. Use when you need to track changes to tasks over time. Use sinceId for incremental synchronization.
Input parameters
Return history records with ID greater than specified value. Used for incremental synchronization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_TELEPHONY_SETTINGTool to retrieve telephony integration settings by code. Use when you need to fetch configuration details for a specific telephony integration.
Input parameters
The unique code/identifier of the telephony integration whose settings you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_USERTool to retrieve detailed information about a specific user by ID. Use when you need complete user data for a known user identifier.
Input parameters
The user ID to retrieve information for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_USER_GROUPSTool to retrieve a list of user groups with their permissions and configuration. Use when you need to fetch available user groups with optional pagination.
Input parameters
Page number for pagination
Number of user groups to return per page. Must be 20, 50, or 100
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_GET_USERSTool to retrieve a list of users. Use when you need to fetch users with optional pagination, filtering, and sorting.
Input parameters
Page number for pagination
Number of users to return per page
Field name to sort by
Sort order: 'asc' or 'desc'
Filter by external user ID
Filter users created before this timestamp (YYYY-MM-DD HH:MM:SS)
Filter by a custom field
Filter users created after this timestamp (YYYY-MM-DD HH:MM:SS)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPDATE_CUSTOMER_SUBSCRIPTIONSTool to subscribe or unsubscribe a customer to mailing channels. Use when you need to manage customer communication preferences across different channels (email, SMS, WhatsApp, etc.).
Input parameters
External identifier of the customer to update subscriptions for
Array of subscription configurations to update. Each item specifies a channel and whether the customer should be subscribed or unsubscribed to that channel
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPDATE_USER_STATUSTool to change a user's status. Use when you need to update a user's current work status.
Input parameters
The user ID whose status to change
New status for the user. Must be one of: free, busy, dinner, or break
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_COSTSTool to batch upload cost records to Simla CRM. Use when you need to create multiple cost entries at once for tracking expenses like advertising, salaries, or other operational costs. Maximum 50 costs per request.
Input parameters
Array of cost records to upload (1-50 items per request)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_CUSTOMERSTool to batch upload customer records to Simla CRM. Use when you need to create multiple customers at once. Maximum 50 customers per request.
Input parameters
Symbolic code of the store receiving the customers
Array of customer records to upload (1-50 items per request)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_CUSTOMERS_CORPORATETool to batch upload corporate customers to Simla.com CRM. Use when you need to create multiple corporate customer records at once with their companies, contacts, and addresses. Maximum 50 customers per request.
Input parameters
Array of corporate customer objects to upload (1-50 items per request)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_ORDERSUpload multiple orders to Simla in a single batch operation. Use when you need to create multiple orders efficiently (up to 50 per request). Each order requires an externalId and at least one item with an offer identifier. The API processes all orders and returns details for successful uploads along with any errors.
Input parameters
Default site/store code for all orders (optional, can be overridden per order)
Array of order objects to upload in batch (maximum 50 orders per request)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_STORE_PRICESTool to batch update SKU prices in Simla store catalog. Use when you need to set or update prices for product offers. Can also remove specific price types using the remove flag.
Input parameters
Array of offers with their price information to upload (at least one required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_WEB_ANALYTICS_CLIENT_IDSTool to batch upload web analytics client IDs to Simla CRM for tracking purposes. Use when you need to associate Google Analytics (or other web analytics) client IDs with orders and customers in the system.
Input parameters
Array of client ID records to upload for web analytics tracking (at least 1 required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMLA_COM_UPLOAD_WEB_ANALYTICS_SOURCESTool to batch upload web analytics sources to Simla CRM. Use when tracking traffic sources for orders or customers from marketing campaigns. Each source must include at least one identifier (order, customer, or clientId) along with optional UTM parameters (source, medium, campaign, keyword, content).
Input parameters
Array of web analytics source records to upload (at least one required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 66 agents privately built on Nagent that already use Simla.com.
Build on Nagent
Connect Simla.com to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Simla.com, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Simla.com is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Simla.com is connected, you configure its 141 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Simla.com steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Simla.com event fires, the agent kicks off automatically.
Every Simla.com action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Simla.com ships with 141 pre-built crm actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Simla.com together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Simla.com-based workflows tailored to your business.