Skip to main content
Simla.com logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 141
  • Triggers: 0
  • Slug: SIMLA_COM
  • Version: 20261101_00

Tools

Slug: 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

string
required
Site code identifier where the customer is registered (e.g., ‘composio’)
object
required
Favorite object containing the offer information to add
string
required
Customer identifier (external ID or internal ID depending on usage)

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: 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

array
required
List of customer objects to be merged into the result customer (up to 50 customers). These customers will be deleted after the combine operation.
object
required
Customer that will remain after combining. All data from the merged customers will be transferred to this customer.

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: 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

array
required
List of corporate customer objects to be merged into the result customer. These customers will be deleted after the combine operation.
object
required
Corporate customer that will remain after combining. All data from the merged customers will be transferred to this customer.

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: 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

object
required
Source order to be combined (this order will be merged into the result order)
string
required
Technique for combining orders. Use ‘summ’ to sum up the orders’ data.
object
required
Target order that will receive the combined data (destination order)

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: 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

object
required
Cost details including period dates, amount, cost item, and optional comment

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: 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

object
required
The customer object to create

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: 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

object
required
The corporate customer object to create

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: SIMLA_COM_CREATE_CUSTOMER_INTERACTION_CART_SETCreates or overwrites a customer’s shopping cart for interaction tracking on a specified site. The cart must contain at least one item, and setting it overwrites existing cart data for the customer.

Input Parameters

object
required
Shopping cart data including customer and items
string
required
Site code identifier where the cart belongs

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: 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

string
Site code if managing multiple sites (optional)
object
required
Address object to create. Provide either ‘text’ for a simple address or detailed components
string
required
External ID or internal ID of the corporate customer

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: 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

object
required
Company data to create. Must include at minimum the company name.
string
required
The external ID of the corporate customer to create a company for

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: 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

string
Identifier type for the corporate customer lookup - use ‘externalId’ or ‘id’
integer
Internal numeric ID of the corporate customer. Required when by=‘id’.
string
Site code for multi-site configurations
object
required
Contact data containing customer reference (either customer.id or customer.externalId must be provided)
string
External ID of the corporate customer to link the contact to. Required when by=‘externalId’ (the default).

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: 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

object
required
Note data including customer reference and text
string
Site code for multi-store configurations (optional, uses default if omitted)

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: 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

object
required
Note data including customer reference and text
string
Site code for multi-store configurations (optional, uses default if omitted)

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: SIMLA_COM_CREATE_CUSTOM_FIELDCreates a custom metadata field for an order, customer, or loyalty account in Simla.

Input Parameters

string
Symbolic code for the field (lowercase letters, numbers, underscores, must start with letter). Automatically generated if omitted.
string
required
Display name of the custom field.
string ("string" | "text" | "integer" | "numeric" | "boolean" | "dictionary" | "date" | "datetime" | "email" | "multiselect_dictionary")
required
Data type of the custom field.
string ("order" | "customer" | "loyalty_account")
required
The entity to which the custom field will be added.
boolean
Whether the field is shown in list views.
boolean
Whether the field is available in filtering UI.
integer
Display order of the field (defaults to 50).
boolean
Whether this field is mandatory.
string ("editable" | "not_editable" | "miss")
Form visibility mode (defaults to editable).
string
Related directory code (required if type is dictionary or multiselect_dictionary).
string
UI area where the field is displayed. Depends on entity type.
boolean
Whether the field can be used in bulk actions.
string ("editable" | "not_editable" | "miss")
Mobile app visibility mode (defaults to editable).

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: 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

string
Symbolic code for the dictionary (only at creation), must match pattern ^[a-z][\w_-]+$
string
required
Name of the custom dictionary
array
required
List of dictionary elements (at least one element is 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: 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

string
Site code if managing multiple sites (uses default if omitted)
object
required
Order details including customer, items, and delivery for discount calculation
number
Number of loyalty bonuses to apply/charge in the calculation

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: SIMLA_COM_CREATE_ORDERCreate a new order in Simla with customer details, line items, delivery address, and optional metadata. The response may include the assigned order ID and order details.

Input Parameters

string
Site/store code if managing multiple sites (optional, uses default if omitted)
object
required
Order details including customer info, items, and delivery

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: 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

object
required
Pack details including item ID, store, quantity, and shipment information

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: 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

string
Site/store code if API key has access to multiple sites (optional, uses default if omitted)
object
required
Payment details including type, amount, and order reference

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: 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

object
required
Courier object to create

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: 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

object
required
Currency object to create

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: 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

string
Site code for multi-site configurations (optional)
array
required
Array of inventory items to update with store quantities and prices

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: 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

object
required
Product group object to create

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: 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

integer
required
Catalog ID from the site configuration (retrieve from /api/v5/reference/sites)
array
required
Array of product objects to create in batch (at least one product 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: SIMLA_COM_CREATE_TASKTool to create a new task. Use after gathering task details and assignees.

Input Parameters

string
required
Task description text
object
Related entity reference for the task
integer
required
ID of the user assigned to the task (performer)
string
Additional comment for the task
object
Customer reference for the task
string
Task deadline in ISO 8601 datetime format
string
required
Type/identifier of the task

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: 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
required
Array of visit records to upload in batch (at least one visit 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: SIMLA_COM_DELETE_COSTTool to delete a cost by ID. Use when you need to remove a cost record from the system.

Input Parameters

integer
required
Cost ID 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: 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

integer
required
Corporate customer note ID 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: 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

integer
required
The internal ID of the customer note 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: 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

integer
required
Payment ID 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: 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

integer
required
Unique identifier of the cost record to edit. Must be a positive integer representing an existing cost ID.
object
required
Cost object with fields to update (at least one field should be provided)
string
Store code, required when referencing orders by externalId or number

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: SIMLA_COM_EDIT_CUSTOMERTool to edit an existing customer. Use when you need to update customer details by external ID.

Input Parameters

string ("male" | "female")
Customer’s gender; ‘male’ or ‘female’
string
Customer’s email address
string
Customer’s phone number
object
Customer’s address details
string
Customer’s date of birth in ‘Y-m-d’ format
string
Customer’s last name
string
Customer’s first name
string
required
External identifier of the customer to edit
object
Custom fields associated with the customer

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: 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

string ("id" | "externalId")
Type of identifier used for the corporate customer (‘id’ for internal ID, ‘externalId’ for external ID)
string
Site code for multi-site installations
string
required
Corporate customer identifier (ID or external ID depending on ‘by’ parameter)
object
required
Corporate customer object with fields 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: 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

string
Site code for multi-site installations
object
required
Address object containing the fields to update. Provide only the fields you want to change.
string
required
External ID of the corporate customer
string
required
External ID of the address entity to edit

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: 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

string ("id" | "externalId")
Type of identifier used for the corporate customer (‘id’ for internal ID, ‘externalId’ for external ID)
string
Site code where the corporate customer belongs
object
required
Company object with fields to update
string ("id" | "externalId")
Type of identifier used for the company entity (‘id’ for internal ID, ‘externalId’ for external ID)
string
required
Corporate customer identifier (ID or external ID depending on ‘by’ parameter)
string
required
Company entity identifier (ID or external ID depending on ‘entityBy’ parameter)

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: 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

string
Identifier type for the corporate customer lookup - use ‘externalId’ or ‘id’
string
Site code for multi-site configurations
object
required
Contact data to update - currently supports ‘isMain’ field to set/unset as main contact
string
Identifier type for the contact person lookup - use ‘externalId’ or ‘id’
string
required
Identifier of the corporate customer (ID or external ID depending on ‘by’ parameter)
string
required
Identifier of the contact person (ID or external ID depending on ‘entityBy’ parameter)

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: 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

string
required
Unique code of the custom field to edit.
string
New display name for the custom field.
integer
Sort order index; must be non-negative.
string ("string" | "text" | "integer" | "number" | "bool" | "dictionary" | "date" | "email")
Data type of the custom field.
string ("order" | "customer" | "corporate_customer" | "company")
required
The entity type to which the custom field belongs.
boolean
Whether the custom field is active/enabled.
array
Additional settings for dictionary-type fields. Each item should have ‘key’ (internal value) and ‘label’ (display text) properties. Used to define dropdown/select options.
boolean
Whether the custom field is visible in UI.
boolean
Whether the custom field is editable by users.
boolean
Whether the custom field is required.
string
Detailed description of the custom field.
string
New default value for the custom field.

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: SIMLA_COM_EDIT_CUSTOM_FIELDS_DICTIONARYEdit an existing custom fields directory by code, supplying its name and elements. Use to update the name or modify entries, including adding, removing, or reordering them.

Input Parameters

string
required
The symbolic identifier of the directory being modified (path parameter)
string
required
The updated display name for the directory
array
required
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

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: 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

string
required
Delivery service integration subcode identifier (used in URL path)
object
required
Complete delivery service configuration including name, URLs, actions, statuses, and settings

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: SIMLA_COM_EDIT_FILETool to edit an existing file by ID. Use when you need to update file properties such as filename.

Input Parameters

integer
required
The ID of the file to edit. Must be a positive integer.
object
required
File object with fields to update (e.g., filename)

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: 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

string
required
Code identifier of the integration module to edit
object
required
Integration module configuration data 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: 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

string
Code of the site where the order belongs
object
required
Order object with fields to update
string
required
External ID of the order to edit

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: 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

integer
required
Payment ID to edit
object
required
Payment object with fields 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: 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

string
required
The cost group code (symbolic identifier) to edit
object
required
Cost group object with fields to update (at least one field should be provided)

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: 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

string
required
Symbolic code of the cost item to edit. Must match an existing cost item code in the system.
object
required
Cost item fields to update (at least one field should be provided)

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: 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

integer
required
Courier ID (internal identifier)
object
required
Courier data object with fields 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: 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

integer
required
Unique identifier of the currency to edit
object
required
Currency object containing the fields 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: 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

string
required
The delivery service code (symbolic identifier) to edit
object
required
Delivery service object with fields to update (at least one field should be provided)

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: 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

string
required
The symbolic code of the delivery type to create or edit
object
required
Delivery type object with properties to create or 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: 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

string
required
Symbolic code of the order method to edit. Must match an existing order method code in the system.
object
required
Order method fields to update (at least one field should be provided)

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: 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

string
required
The symbolic code of the order type to create/edit
object
required
Order type object with fields to create or 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: 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

string
required
Symbolic code of the payment status to edit. Must match an existing payment status code in the system.
object
required
Payment status fields to update (at least one field should be provided)

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: 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

string
required
The payment type code (symbolic identifier) to edit or create
object
required
Payment type object with fields to update or create (at least one field should be provided)

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: 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

string
required
The symbolic code of the price type to edit
string
The name of the price type
boolean
Whether the price type is active and available for use
array
Customer group codes associated with this price type
boolean
Whether this price type should be set as the default
string
Currency code for the price type (ISO 4217, e.g., USD, EUR)
integer
Display ordering of the price type (lower numbers appear first)
string
Description of the price type
string
Filter expression for the price type (defines when this price applies)

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: 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

string
required
Symbolic code of the product status to create or edit (use ‘new’ for creating new statuses)
object
required
Product status fields to create or 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: 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

string
required
Symbolic code of the order status to edit. Must match an existing status code in the system.
object
required
Status fields to update (at least one field should be provided)

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: 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

string
required
Store code identifier (path parameter)
object
required
Store data object with fields to edit

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: 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

string
required
Unique code identifier for the subscription category
string
required
Communication channel for the subscription (e.g., ‘email’, ‘sms’, ‘waba’)
object
required
Subscription category configuration data

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: 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

string
required
Alphanumeric code of measurement unit. Can contain a-Z, 0-9, underscore, dash. First symbol should be a-z. Maximum 255 characters.
object
required
Unit properties to create or update. At least one field (name or sym) should be provided.

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: 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

string
required
External ID of the product group to edit
object
required
Product group object with fields 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: 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
required
Array of product objects to edit. Each product must contain ‘id’ field and the fields 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: 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

string
required
Warehouse system identifier code (used in the URL path)
object
required
Warehouse configuration object containing name, code, and accountUrl

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: 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

integer
required
Unique identifier of the task to edit
object
required
Object containing one or more fields 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: 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

string
required
Unique telephony integration code identifier (used in URL path)
object
required
Telephony configuration object with all integration settings

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: 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
required
Array of corporate customer ID mappings. Each entry contains the internal corporate customer ID and the external ID to assign to it.

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: 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
required
Array of customer ID mappings. Each entry contains the internal customer ID and the external ID to assign to it.

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: 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
required
Array of order ID mappings. Each entry contains the internal order ID and the external ID to assign to it.

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: 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

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: 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

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: 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

integer
required
Unique identifier of the cost record to retrieve. Must be a positive integer representing an existing cost 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: 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

string ("id" | "externalId")
Identifier type: ‘id’ for internal numeric ID, ‘externalId’ for external string ID
string
Symbolic code of the store to filter by (optional). Use when customer belongs to a specific site
string
required
The customer identifier. This can be either an internal ID (numeric) or external ID (string) depending on the ‘by’ parameter

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: 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

string
required
External ID of the corporate customer 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: 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

string ("id" | "externalId")
Type of customer identifier: ‘id’ for internal numeric ID (default), ‘externalId’ for external string ID
string
required
Site code identifier where the customer is registered
string
required
Customer identifier (ID or external ID depending on ‘by’ parameter)

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: 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

array
Filter customers by a list of IDs
integer
Page number for pagination
string
Filter customers by email address
integer
Number of customers to return per page
string
Filter customers by a custom field key

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: 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

array
Filter by array of internal identifiers
integer
Page number for pagination (default: 1)
integer
Number of results per page (default: 20, max: 100)
array
Filter by internal IDs of managers
array
Filter by array of external identifiers
array
Filter by symbol codes of manager groups
string
Filter by discount card number (if Loyalty module is active)

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: 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

integer
Page number for pagination
integer
Number of items per page (valid values: 20, 50, or 100)
string
required
The external ID of the corporate customer to retrieve companies for

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: 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

integer
Page number for pagination (starts at 1)
integer
Number of history records to return per page. Must be 20, 50, or 100 (default: 20)
string
End datetime of change period in Y-m-d H:i:s format (e.g., ‘2024-12-31 23:59:59’)
integer
Starting history ID for incremental synchronization. Use the ID from the last processed record to get only newer changes.
string
Start datetime of change period in Y-m-d H:i:s format (e.g., ‘2024-01-01 00:00:00’)
integer
Filter history by specific corporate customer ID
string
Filter history by external corporate customer ID reference

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: 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

array
Filter notes by a list of note internal identifiers
integer
Page number for pagination (default: 1)
string
Filter notes by partial text match
integer
Number of notes to return per page (default: 20). Allowed values: 20, 50, 100
array
Filter notes by a list of manager internal identifiers
string
End of creation time range in ISO 8601 format
array
Filter notes by a list of corporate customer internal identifiers
string
Start of creation time range in ISO 8601 format
array
Filter notes by a list of corporate customer external identifiers

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: 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

integer
Page number for pagination (starts at 1)
integer
Number of history records to return per page. Must be 20, 50, or 100 (default: 20)
string
End datetime of change period in Y-m-d H:i:s format (e.g., ‘2024-12-31 23:59:59’)
integer
Starting history ID for incremental synchronization. Use the ID from the last processed record to get only newer changes.
string
Start datetime of change period in Y-m-d H:i:s format (e.g., ‘2024-01-01 00:00:00’)
integer
Filter history by specific customer ID
string
Filter history by external customer ID reference

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: 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

array
Filter notes by a list of note internal identifiers
integer
Page number for pagination (default: 1)
string
Filter notes by partial text match
integer
Number of notes to return per page (default: 20). Allowed values: 20, 50, 100
array
Filter notes by a list of manager internal identifiers
string
End of creation time range in ISO 8601 format
array
Filter notes by a list of customer internal identifiers
string
Start of creation time range in ISO 8601 format
array
Filter notes by a list of customer external identifiers

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: 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

string
required
Symbolic code of the custom field. Must start with a lowercase letter and contain only alphanumeric characters and underscores.
string ("customer" | "loyalty_account" | "order")
required
Entity type for the custom field (customer, loyalty_account, or order)

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: SIMLA_COM_GET_CUSTOM_FIELDSTool to list custom fields. Use when retrieving custom field definitions with optional filtering by entity or code.

Input Parameters

integer
Page number to return (default: 1)
integer
Number of records per page (default: 20, max: 250)
string
Filter by entity type (e.g., customer, order)
string
Filter by custom field code
string
Filter by custom field type

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: 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

integer
Page number for pagination (default: 1)
integer
Number of items per page (valid values: 20, 50, 100, 250)
string
Filter by symbolic code
string
Filter by dictionary name

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: 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

string
required
The code identifier of the custom dictionary 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: 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

string
required
Symbolic code of the delivery module instance specified in integrationModule[code] when registering the delivery service

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: 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

integer
Page number for pagination
integer ("20" | "50" | "100")
Valid limit values for pagination
string
Filter shipments by date to (format: Y-m-d, e.g., 2024-12-31)
string
Filter shipments by date from (format: Y-m-d, e.g., 2024-01-01)

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: 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

array
Filter by a list of file IDs
integer
Page number to retrieve (default: 1)
string ("20" | "50" | "100")
Valid limit values for files endpoint

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: 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

integer
Page number for pagination
integer
Number of loyalty accounts to return per page
array
Filter by array of loyalty program IDs
string
Filter loyalty accounts by customer phone number

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: SIMLA_COM_GET_LOYALTY_BONUS_OPERATIONSRetrieve the history of loyalty bonus account operations for participations, with optional pagination.

Input Parameters

integer
Page number for pagination
integer
Number of bonus operations to return per page. Must be exactly 20, 50, or 100.

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: 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

integer
Page number for pagination (default: 1)
integer
Number of loyalty programs per page (default: 20)

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: 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

string
required
External 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: SIMLA_COM_GET_ORDERSRetrieve a list of orders with pagination and optional order-number or numeric custom-field range filters. When multiple order numbers are supplied, only the last is sent.

Input Parameters

integer
Page number for pagination (default: 1)
integer
Number of orders per page (default: 20)
array
List of order numbers to filter by
object
Filters for custom fields, as a dict where each key is the field name and value defines min/max

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: 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

integer
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.
integer
Pagination limit for number of records returned. Default and maximum is 100.
integer
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.
string
Filter history by start date (e.g., history for 1 month). Format: YYYY-MM-DD HH:MM:SS

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: 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

integer
Page number for pagination when totalPageCount > 1
integer
ID from the last processed history record. Use this in subsequent calls to get only new changes.

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: SIMLA_COM_GET_PRODUCTSTool to retrieve a list of products. Use when you need to list products with optional filters.

Input Parameters

array
Filter by a list of product IDs
string
Filter by product name
integer
Page number to retrieve (default: 1)
integer
Number of products to return per page (max: 250)
boolean
Filter active products
integer
Filter by available quantity
number
Filter products by maximum price
number
Filter products by minimum price
string
Filter by external product ID
string
ISO8601 datetime; only products created before this timestamp
string
ISO8601 datetime; only products updated before this timestamp
string
ISO8601 datetime; only products created after this timestamp
string
ISO8601 datetime; only products updated after this timestamp

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: 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

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: 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

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: 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

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: 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

integer
Page number for pagination
integer
Number of couriers per page (items to return)

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

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: 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

integer
Page number for pagination. Default is 1.
string
Symbolic code of the store. Required if the API key has access to multiple stores.
integer
Number of segments per page. Must be 20, 50, or 100. Default is 20.
string
Filter segments by name.
boolean
Filter segments by active status.

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: 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

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: 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

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: 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

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: 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

integer
Page number for pagination (default: 1)
integer ("20" | "50" | "100" | "250")
Allowed values for limit parameter
array
Filter by a list of offer IDs
integer
Include detailed information (1 for yes, 0 for no)
integer
Filter by product active status (1 for active, 0 for inactive)

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: 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

integer
Page number for pagination (default: 1)
integer
Number of offers to return per page. Must be one of: 20, 50, or 100 (default: 20)

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: 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

integer
Page number for pagination (default: 1)
integer
Number of items per page (default: 20)

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: SIMLA_COM_GET_STORE_PRODUCTS_PROPERTIES_VALUESRetrieves product property values from the store with optional pagination.

Input Parameters

integer
Page number to retrieve (default: 1)
integer
Number of property values to return per page. Must be 20, 50, or 100

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: 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

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: 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

integer
required
Unique identifier of the task to retrieve. Must be a positive integer representing an existing task 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: 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

array
Filter by specific task IDs
integer
Maximum number of tasks to return
array
Related entities to expand in the response
array
Custom filter conditions as defined by the API (array of objects)
integer
Number of tasks to skip for pagination
string
Filter tasks by status
array
Filter by related order IDs
string
ISO 8601 datetime to include tasks created on or before this timestamp
string
ISO 8601 datetime to include tasks created on or after this timestamp
array
Filter by IDs of users responsible for the task

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: 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

integer
required
Unique identifier of the task to retrieve comments for. Must be a positive integer representing an existing task 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: 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

integer
Return history records with ID greater than specified value. Used for incremental synchronization.

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: 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

string
required
The unique code/identifier of the telephony integration whose settings 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: SIMLA_COM_GET_USERRetrieve details for a specific Simla user by ID, including available identity, status, role and group information.

Input Parameters

integer
required
The user ID to retrieve information for

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: 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

integer
Page number for pagination
integer
Number of user groups to return per page. Must be 20, 50, or 100

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: 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

integer
Page number for pagination
integer
Number of users to return per page
string
Field name to sort by
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’
string
Filter by external user ID
string
Filter users created before this timestamp (YYYY-MM-DD HH:MM:SS)
string
Filter by a custom field
string
Filter users created after this timestamp (YYYY-MM-DD HH:MM:SS)

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: 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

string
required
External identifier of the customer to update subscriptions for
array
required
Array of subscription configurations to update. Each item specifies a channel and whether the customer should be subscribed or unsubscribed to that channel

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: 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

integer
required
The user ID whose status to change
string ("free" | "busy" | "dinner" | "break")
required
New status for the user. Must be one of: free, busy, dinner, or break

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: 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
required
Array of cost records to upload (1-50 items per request)

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: 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

string
Symbolic code of the store receiving the customers
array
required
Array of customer records to upload (1-50 items per request)

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: 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
required
Array of corporate customer objects to upload (1-50 items per request)

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: SIMLA_COM_UPLOAD_ORDERSUpload up to 50 orders to Simla in a single batch; each order requires an external ID and at least one item with an offer identifier. The response can include uploaded order details and errors.

Input Parameters

string
Default site/store code for all orders (optional, can be overridden per order)
array
required
Array of order objects to upload in batch (maximum 50 orders per request)

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: 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
required
Array of offers with their price information to upload (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: 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
required
Array of client ID records to upload for web analytics tracking (at least 1 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: 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
required
Array of web analytics source records to upload (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