# Simla.com

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.

- **Category:** crm
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 141
- **Triggers:** 0
- **Slug:** `SIMLA_COM`
- **Version:** 20260227_00

## Tools

### Add Customer Interaction Favorite

**Slug:** `SIMLA_COM_ADD_CUSTOMER_INTERACTION_FAVORITE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | Yes | Site code identifier where the customer is registered (e.g., 'composio') |
| `favorite` | object | Yes | Favorite object containing the offer information to add |
| `customerId` | string | Yes | Customer identifier (external ID or internal ID depending on usage) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Combine Customers

**Slug:** `SIMLA_COM_COMBINE_CUSTOMERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customers` | array | Yes | List of customer objects to be merged into the result customer (up to 50 customers). These customers will be deleted after the combine operation. |
| `resultCustomer` | object | Yes | Customer that will remain after combining. All data from the merged customers will be transferred to this customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Combine Corporate Customers

**Slug:** `SIMLA_COM_COMBINE_CUSTOMERS_CORPORATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customers` | array | Yes | List of corporate customer objects to be merged into the result customer. These customers will be deleted after the combine operation. |
| `resultCustomer` | object | Yes | Corporate customer that will remain after combining. All data from the merged customers will be transferred to this customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Combine Orders

**Slug:** `SIMLA_COM_COMBINE_ORDERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | object | Yes | Source order to be combined (this order will be merged into the result order) |
| `technique` | string | Yes | Technique for combining orders. Use 'summ' to sum up the orders' data. |
| `resultOrder` | object | Yes | Target order that will receive the combined data (destination order) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Cost

**Slug:** `SIMLA_COM_CREATE_COST`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cost` | object | Yes | Cost details including period dates, amount, cost item, and optional comment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `SIMLA_COM_CREATE_CUSTOMER`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer` | object | Yes | The customer object to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Corporate Customer

**Slug:** `SIMLA_COM_CREATE_CUSTOMER_CORPORATE`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerCorporate` | object | Yes | The corporate customer object to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Interaction Cart Set

**Slug:** `SIMLA_COM_CREATE_CUSTOMER_INTERACTION_CART_SET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cart` | object | Yes | Shopping cart data including customer and items |
| `site` | string | Yes | Site code identifier where the cart belongs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Corporate Customer Address

**Slug:** `SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_ADDRESSES`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site code if managing multiple sites (optional) |
| `address` | object | Yes | Address object to create. Provide either 'text' for a simple address or detailed components |
| `externalId` | string | Yes | External ID or internal ID of the corporate customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Corporate Customer Company

**Slug:** `SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_COMPANIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company` | object | Yes | Company data to create. Must include at minimum the company name. |
| `externalId` | string | Yes | The external ID of the corporate customer to create a company for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Corporate Customer Contact

**Slug:** `SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_CONTACTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string | No | Identifier type for the corporate customer lookup - use 'externalId' or 'id' |
| `site` | string | No | Site code for multi-site configurations |
| `contact` | object | Yes | Contact data containing customer reference (either customer.id or customer.externalId must be provided) |
| `externalId` | string | Yes | External ID of the corporate customer to link the contact to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Corporate Customer Note

**Slug:** `SIMLA_COM_CREATE_CUSTOMERS_CORPORATE_NOTES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | object | Yes | Note data including customer reference and text |
| `site` | string | No | Site code for multi-store configurations (optional, uses default if omitted) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Note

**Slug:** `SIMLA_COM_CREATE_CUSTOMERS_NOTES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | object | Yes | Note data including customer reference and text |
| `site` | string | No | Site code for multi-store configurations (optional, uses default if omitted) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field

**Slug:** `SIMLA_COM_CREATE_CUSTOM_FIELD`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Fields Dictionary

**Slug:** `SIMLA_COM_CREATE_CUSTOM_FIELDS_DICTIONARIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Symbolic code for the dictionary (only at creation), must match pattern ^[a-z][\w_-]+$ |
| `name` | string | Yes | Name of the custom dictionary |
| `elements` | array | Yes | List of dictionary elements (at least one element is required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Loyalty Discount

**Slug:** `SIMLA_COM_CREATE_LOYALTY_CALCULATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site code if managing multiple sites (uses default if omitted) |
| `order` | object | Yes | Order details including customer, items, and delivery for discount calculation |
| `bonuses` | number | No | Number of loyalty bonuses to apply/charge in the calculation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `SIMLA_COM_CREATE_ORDER`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site/store code if managing multiple sites (optional, uses default if omitted) |
| `order` | object | Yes | Order details including customer info, items, and delivery |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Orders Link

**Slug:** `SIMLA_COM_CREATE_ORDERS_LINK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link` | object | Yes | Link details containing orders to link and optional comment |
| `site` | string | No | Site code (required if API key has access to multiple stores) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Pack

**Slug:** `SIMLA_COM_CREATE_ORDERS_PACKS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pack` | object | Yes | Pack details including item ID, store, quantity, and shipment information |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Payment

**Slug:** `SIMLA_COM_CREATE_ORDERS_PAYMENTS_CREATE`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site/store code if API key has access to multiple sites (optional, uses default if omitted) |
| `payment` | object | Yes | Payment details including type, amount, and order reference |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Reference Courier

**Slug:** `SIMLA_COM_CREATE_REFERENCE_COURIER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `courier` | object | Yes | Courier object to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Reference Currency

**Slug:** `SIMLA_COM_CREATE_REFERENCE_CURRENCIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | object | Yes | Currency object to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Store Inventories Upload

**Slug:** `SIMLA_COM_CREATE_STORE_INVENTORIES_UPLOAD`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site code for multi-site configurations (optional) |
| `offers` | array | Yes | Array of inventory items to update with store quantities and prices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Store Product Groups

**Slug:** `SIMLA_COM_CREATE_STORE_PRODUCT_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productGroup` | object | Yes | Product group object to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Create Store Products

**Slug:** `SIMLA_COM_CREATE_STORE_PRODUCTS_BATCH_CREATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `catalog` | integer | Yes | Catalog ID from the site configuration (retrieve from /api/v5/reference/sites) |
| `products` | array | Yes | Array of product objects to create in batch (at least one product required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task

**Slug:** `SIMLA_COM_CREATE_TASK`

Tool to create a new task. Use after gathering task details and assignees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Task description text |
| `entity` | object | No | Related entity reference for the task |
| `comment` | string | No | Additional comment for the task |
| `userIds` | array | Yes | IDs of users assigned to the task |
| `customer` | object | No | Customer reference for the task |
| `deadline` | string | No | Task deadline in ISO 8601 datetime format |
| `taskType` | string | Yes | Type/identifier of the task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Web Analytics Visits Upload

**Slug:** `SIMLA_COM_CREATE_WEB_ANALYTICS_VISITS_UPLOAD`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `visits` | array | Yes | Array of visit records to upload in batch (at least one visit required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Cost

**Slug:** `SIMLA_COM_DELETE_COST`

Tool to delete a cost by ID. Use when you need to remove a cost record from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Cost ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Corporate Customer Note

**Slug:** `SIMLA_COM_DELETE_CUSTOMERS_CORPORATE_NOTE`

Tool to delete a corporate customer note by ID. Use when you need to remove a note record from a corporate customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Corporate customer note ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Note

**Slug:** `SIMLA_COM_DELETE_CUSTOMERS_NOTE`

Tool to delete a customer note by ID. Use when you need to remove a note record from a customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The internal ID of the customer note to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Payment

**Slug:** `SIMLA_COM_DELETE_ORDER_PAYMENT`

Tool to delete an order payment by ID. Use when you need to remove a payment record from an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Payment ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Cost

**Slug:** `SIMLA_COM_EDIT_COST`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the cost record to edit. Must be a positive integer representing an existing cost ID. |
| `cost` | object | Yes | Cost object with fields to update (at least one field should be provided) |
| `site` | string | No | Store code, required when referencing orders by externalId or number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Customer

**Slug:** `SIMLA_COM_EDIT_CUSTOMER`

Tool to edit an existing customer. Use when you need to update customer details by external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sex` | string ("male" | "female") | No | Customer's gender; 'male' or 'female' |
| `email` | string | No | Customer's email address |
| `phone` | string | No | Customer's phone number |
| `address` | object | No | Customer's address details |
| `birthday` | string | No | Customer's date of birth in 'Y-m-d' format |
| `lastName` | string | No | Customer's last name |
| `firstName` | string | No | Customer's first name |
| `externalId` | string | Yes | External identifier of the customer to edit |
| `customFields` | object | No | Custom fields associated with the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Corporate Customer

**Slug:** `SIMLA_COM_EDIT_CUSTOMER_CORPORATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string ("id" | "externalId") | No | Type of identifier used for the corporate customer ('id' for internal ID, 'externalId' for external ID) |
| `site` | string | No | Site code for multi-site installations |
| `externalId` | string | Yes | Corporate customer identifier (ID or external ID depending on 'by' parameter) |
| `customerCorporate` | object | Yes | Corporate customer object with fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Corporate Customer Address

**Slug:** `SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_ADDRESS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Site code for multi-site installations |
| `address` | object | Yes | Address object containing the fields to update. Provide only the fields you want to change. |
| `externalId` | string | Yes | External ID of the corporate customer |
| `entityExternalId` | string | Yes | External ID of the address entity to edit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Corporate Customer Company

**Slug:** `SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_COMPANY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string ("id" | "externalId") | No | Type of identifier used for the corporate customer ('id' for internal ID, 'externalId' for external ID) |
| `site` | string | No | Site code where the corporate customer belongs |
| `company` | object | Yes | Company object with fields to update |
| `entityBy` | string ("id" | "externalId") | No | Type of identifier used for the company entity ('id' for internal ID, 'externalId' for external ID) |
| `externalId` | string | Yes | Corporate customer identifier (ID or external ID depending on 'by' parameter) |
| `entityExternalId` | string | Yes | Company entity identifier (ID or external ID depending on 'entityBy' parameter) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Corporate Customer Contact

**Slug:** `SIMLA_COM_EDIT_CUSTOMERS_CORPORATE_CONTACTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string | No | Identifier type for the corporate customer lookup - use 'externalId' or 'id' |
| `site` | string | No | Site code for multi-site configurations |
| `contact` | object | Yes | Contact data to update - currently supports 'isMain' field to set/unset as main contact |
| `entityBy` | string | No | Identifier type for the contact person lookup - use 'externalId' or 'id' |
| `externalId` | string | Yes | Identifier of the corporate customer (ID or external ID depending on 'by' parameter) |
| `entityExternalId` | string | Yes | Identifier of the contact person (ID or external ID depending on 'entityBy' parameter) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Custom Field

**Slug:** `SIMLA_COM_EDIT_CUSTOM_FIELD`

Edit 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Custom Fields Dictionary

**Slug:** `SIMLA_COM_EDIT_CUSTOM_FIELDS_DICTIONARY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The symbolic identifier of the directory being modified (path parameter) |
| `name` | string | Yes | The updated display name for the directory |
| `elements` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Delivery Generic Setting

**Slug:** `SIMLA_COM_EDIT_DELIVERY_GENERIC_SETTING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subcode` | string | Yes | Delivery service integration subcode identifier (used in URL path) |
| `configuration` | object | Yes | Complete delivery service configuration including name, URLs, actions, statuses, and settings |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit File

**Slug:** `SIMLA_COM_EDIT_FILE`

Tool to edit an existing file by ID. Use when you need to update file properties such as filename.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the file to edit. Must be a positive integer. |
| `file` | object | Yes | File object with fields to update (e.g., filename) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Integration Module

**Slug:** `SIMLA_COM_EDIT_INTEGRATION_MODULE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Code identifier of the integration module to edit |
| `integrationModule` | object | Yes | Integration module configuration data to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Order

**Slug:** `SIMLA_COM_EDIT_ORDER`

Tool to edit an existing order by external ID. Use when you need to update order details by external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Code of the site where the order belongs |
| `order` | object | Yes | Order object with fields to update |
| `externalId` | string | Yes | External ID of the order to edit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Orders Payment

**Slug:** `SIMLA_COM_EDIT_ORDERS_PAYMENT`

Tool to edit an existing order payment. Use when you need to update payment details such as amount, status, or type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Payment ID to edit |
| `payment` | object | Yes | Payment object with fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Cost Group

**Slug:** `SIMLA_COM_EDIT_REFERENCE_COST_GROUP`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The cost group code (symbolic identifier) to edit |
| `costGroup` | object | Yes | Cost group object with fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Cost Item

**Slug:** `SIMLA_COM_EDIT_REFERENCE_COST_ITEM`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the cost item to edit. Must match an existing cost item code in the system. |
| `costItem` | object | Yes | Cost item fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Courier

**Slug:** `SIMLA_COM_EDIT_REFERENCE_COURIER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Courier ID (internal identifier) |
| `courier` | object | Yes | Courier data object with fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Currency

**Slug:** `SIMLA_COM_EDIT_REFERENCE_CURRENCY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the currency to edit |
| `currency` | object | Yes | Currency object containing the fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Delivery Service

**Slug:** `SIMLA_COM_EDIT_REFERENCE_DELIVERY_SERVICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The delivery service code (symbolic identifier) to edit |
| `deliveryService` | object | Yes | Delivery service object with fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Delivery Type

**Slug:** `SIMLA_COM_EDIT_REFERENCE_DELIVERY_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The symbolic code of the delivery type to create or edit |
| `deliveryType` | object | Yes | Delivery type object with properties to create or update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Order Method

**Slug:** `SIMLA_COM_EDIT_REFERENCE_ORDER_METHOD`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the order method to edit. Must match an existing order method code in the system. |
| `orderMethod` | object | Yes | Order method fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Order Type

**Slug:** `SIMLA_COM_EDIT_REFERENCE_ORDER_TYPE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The symbolic code of the order type to create/edit |
| `orderType` | object | Yes | Order type object with fields to create or update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Payment Status

**Slug:** `SIMLA_COM_EDIT_REFERENCE_PAYMENT_STATUS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the payment status to edit. Must match an existing payment status code in the system. |
| `paymentStatus` | object | Yes | Payment status fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Payment Type

**Slug:** `SIMLA_COM_EDIT_REFERENCE_PAYMENT_TYPE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The payment type code (symbolic identifier) to edit or create |
| `paymentType` | object | Yes | Payment type object with fields to update or create (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Price Type

**Slug:** `SIMLA_COM_EDIT_REFERENCE_PRICE_TYPE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Product Status

**Slug:** `SIMLA_COM_EDIT_REFERENCE_PRODUCT_STATUS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the product status to create or edit (use 'new' for creating new statuses) |
| `productStatus` | object | Yes | Product status fields to create or update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Statuses

**Slug:** `SIMLA_COM_EDIT_REFERENCE_STATUSES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the order status to edit. Must match an existing status code in the system. |
| `status` | object | Yes | Status fields to update (at least one field should be provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Stores

**Slug:** `SIMLA_COM_EDIT_REFERENCE_STORES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Store code identifier (path parameter) |
| `store` | object | Yes | Store data object with fields to edit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Subscription

**Slug:** `SIMLA_COM_EDIT_REFERENCE_SUBSCRIPTION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Unique code identifier for the subscription category |
| `channel` | string | Yes | Communication channel for the subscription (e.g., 'email', 'sms', 'waba') |
| `subscription` | object | Yes | Subscription category configuration data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Reference Unit

**Slug:** `SIMLA_COM_EDIT_REFERENCE_UNIT`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Store Product Group

**Slug:** `SIMLA_COM_EDIT_STORE_PRODUCT_GROUP`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `externalId` | string | Yes | External ID of the product group to edit |
| `productGroup` | object | Yes | Product group object with fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Store Products Batch

**Slug:** `SIMLA_COM_EDIT_STORE_PRODUCTS_BATCH`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `products` | array | Yes | Array of product objects to edit. Each product must contain 'id' field and the fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Store Setting

**Slug:** `SIMLA_COM_EDIT_STORE_SETTING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Warehouse system identifier code (used in the URL path) |
| `configuration` | object | Yes | Warehouse configuration object containing name, code, and accountUrl |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Task

**Slug:** `SIMLA_COM_EDIT_TASK`

Tool to edit an existing task. Use after confirming task ID and fields to update. Updates only provided fields on the task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the task to edit |
| `task` | object | Yes | Object containing one or more fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Telephony Setting

**Slug:** `SIMLA_COM_EDIT_TELEPHONY_SETTING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Unique telephony integration code identifier (used in URL path) |
| `configuration` | object | Yes | Telephony configuration object with all integration settings |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fix Corporate Customers External IDs

**Slug:** `SIMLA_COM_FIX_CUSTOMERS_CORPORATE_EXTERNAL_IDS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customersCorporate` | array | Yes | Array of corporate customer ID mappings. Each entry contains the internal corporate customer ID and the external ID to assign to it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fix Customers External IDs

**Slug:** `SIMLA_COM_FIX_CUSTOMERS_EXTERNAL_IDS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customers` | array | Yes | Array of customer ID mappings. Each entry contains the internal customer ID and the external ID to assign to it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fix Orders External IDs

**Slug:** `SIMLA_COM_FIX_ORDERS_EXTERNAL_IDS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orders` | array | Yes | Array of order ID mappings. Each entry contains the internal order ID and the external ID to assign to it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Credentials

**Slug:** `SIMLA_COM_GET_API_CREDENTIALS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Versions

**Slug:** `SIMLA_COM_GET_API_VERSIONS`

Tool to retrieve a list of available API versions. Use when you need to discover which API versions are supported by the system.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cost

**Slug:** `SIMLA_COM_GET_COST`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the cost record to retrieve. Must be a positive integer representing an existing cost ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `SIMLA_COM_GET_CUSTOMER`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string ("id" | "externalId") | No | Identifier type: 'id' for internal numeric ID, 'externalId' for external string ID |
| `site` | string | No | Symbolic code of the store to filter by (optional). Use when customer belongs to a specific site |
| `externalId` | string | Yes | The customer identifier. This can be either an internal ID (numeric) or external ID (string) depending on the 'by' parameter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Corporate Customer

**Slug:** `SIMLA_COM_GET_CUSTOMER_CORPORATE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `externalId` | string | Yes | External ID of the corporate customer to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Interaction Favorites

**Slug:** `SIMLA_COM_GET_CUSTOMER_INTERACTION_FAVORITES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `by` | string ("id" | "externalId") | No | Type of customer identifier: 'id' for internal numeric ID (default), 'externalId' for external string ID |
| `site` | string | Yes | Site code identifier where the customer is registered |
| `customerId` | string | Yes | Customer identifier (ID or external ID depending on 'by' parameter) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers

**Slug:** `SIMLA_COM_GET_CUSTOMERS`

Tool to retrieve a list of customers. Use after setting optional filters (IDs, email, custom fields) to fetch paginated customer data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter customers by a list of IDs |
| `page` | integer | No | Page number for pagination |
| `email` | string | No | Filter customers by email address |
| `limit` | integer | No | Number of customers to return per page |
| `customFieldKey` | string | No | Filter customers by a custom field key |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Corporate Customers

**Slug:** `SIMLA_COM_GET_CUSTOMERS_CORPORATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter by array of internal identifiers |
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer | No | Number of results per page (default: 20, max: 100) |
| `managers` | array | No | Filter by internal IDs of managers |
| `externalIds` | array | No | Filter by array of external identifiers |
| `managerGroups` | array | No | Filter by symbol codes of manager groups |
| `discountCardNumber` | string | No | Filter by discount card number (if Loyalty module is active) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Corporate Customer Companies

**Slug:** `SIMLA_COM_GET_CUSTOMERS_CORPORATE_COMPANIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of items per page (valid values: 20, 50, or 100) |
| `externalId` | string | Yes | The external ID of the corporate customer to retrieve companies for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Corporate Customers History

**Slug:** `SIMLA_COM_GET_CUSTOMERS_CORPORATE_HISTORY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Corporate Customers Notes

**Slug:** `SIMLA_COM_GET_CUSTOMERS_CORPORATE_NOTES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter notes by a list of note internal identifiers |
| `page` | integer | No | Page number for pagination (default: 1) |
| `text` | string | No | Filter notes by partial text match |
| `limit` | integer | No | Number of notes to return per page (default: 20). Allowed values: 20, 50, 100 |
| `managerIds` | array | No | Filter notes by a list of manager internal identifiers |
| `createdAtTo` | string | No | End of creation time range in ISO 8601 format |
| `customerIds` | array | No | Filter notes by a list of corporate customer internal identifiers |
| `createdAtFrom` | string | No | Start of creation time range in ISO 8601 format |
| `customerExternalIds` | array | No | Filter notes by a list of corporate customer external identifiers |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers History

**Slug:** `SIMLA_COM_GET_CUSTOMERS_HISTORY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers Notes

**Slug:** `SIMLA_COM_GET_CUSTOMERS_NOTES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter notes by a list of note internal identifiers |
| `page` | integer | No | Page number for pagination (default: 1) |
| `text` | string | No | Filter notes by partial text match |
| `limit` | integer | No | Number of notes to return per page (default: 20). Allowed values: 20, 50, 100 |
| `managerIds` | array | No | Filter notes by a list of manager internal identifiers |
| `createdAtTo` | string | No | End of creation time range in ISO 8601 format |
| `customerIds` | array | No | Filter notes by a list of customer internal identifiers |
| `createdAtFrom` | string | No | Start of creation time range in ISO 8601 format |
| `customerExternalIds` | array | No | Filter notes by a list of customer external identifiers |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Field

**Slug:** `SIMLA_COM_GET_CUSTOM_FIELD`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Symbolic code of the custom field. Must start with a lowercase letter and contain only alphanumeric characters and underscores. |
| `entity` | string ("customer" | "loyalty_account" | "order") | Yes | Entity type for the custom field (customer, loyalty_account, or order) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Fields

**Slug:** `SIMLA_COM_GET_CUSTOM_FIELDS`

Tool to list custom fields. Use when retrieving custom field definitions with optional filtering by entity or code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to return (default: 1) |
| `limit` | integer | No | Number of records per page (default: 20, max: 250) |
| `entity` | string | No | Filter by entity type (e.g., customer, order) |
| `filter_code` | string | No | Filter by custom field code |
| `filter_type` | string | No | Filter by custom field type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Fields Dictionaries

**Slug:** `SIMLA_COM_GET_CUSTOM_FIELDS_DICTIONARIES`

Tool to retrieve the list of custom dictionaries. Use when you need to get available custom directory definitions with their elements and codes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer | No | Number of items per page (valid values: 20, 50, 100, 250) |
| `filter_code` | string | No | Filter by symbolic code |
| `filter_name` | string | No | Filter by dictionary name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Fields Dictionary

**Slug:** `SIMLA_COM_GET_CUSTOM_FIELDS_DICTIONARY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The code identifier of the custom dictionary to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Delivery Generic Setting

**Slug:** `SIMLA_COM_GET_DELIVERY_GENERIC_SETTING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subcode` | string | Yes | Symbolic code of the delivery module instance specified in integrationModule[code] when registering the delivery service |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Delivery Shipments

**Slug:** `SIMLA_COM_GET_DELIVERY_SHIPMENTS`

Tool to retrieve a list of delivery shipments. Use when you need to fetch shipments with optional date filters and pagination.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Files

**Slug:** `SIMLA_COM_GET_FILES`

Tool to retrieve a list of files. Use when you need to fetch files with optional filters like IDs and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter by a list of file IDs |
| `page` | integer | No | Page number to retrieve (default: 1) |
| `limit` | string ("20" | "50" | "100") | No | Valid limit values for files endpoint |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Loyalty Accounts

**Slug:** `SIMLA_COM_GET_LOYALTY_ACCOUNTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of loyalty accounts to return per page |
| `loyalties` | array | No | Filter by array of loyalty program IDs |
| `phoneNumber` | string | No | Filter loyalty accounts by customer phone number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Loyalty Bonus Operations

**Slug:** `SIMLA_COM_GET_LOYALTY_BONUS_OPERATIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of bonus operations to return per page. Must be exactly 20, 50, or 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Loyalty Loyalties

**Slug:** `SIMLA_COM_GET_LOYALTY_LOYALTIES`

Tool to retrieve a list of loyalty programs. Use when you need to fetch available loyalty programs with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer | No | Number of loyalty programs per page (default: 20) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `SIMLA_COM_GET_ORDER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | External identifier of the order to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders

**Slug:** `SIMLA_COM_GET_ORDERS`

Tool to retrieve a list of orders. Use when you need to fetch orders with optional filters (order numbers, custom fields) and pagination.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders History

**Slug:** `SIMLA_COM_GET_ORDERS_HISTORY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders Packs History

**Slug:** `SIMLA_COM_GET_ORDERS_PACKS_HISTORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination when totalPageCount > 1 |
| `sinceId` | integer | No | ID from the last processed history record. Use this in subsequent calls to get only new changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Products

**Slug:** `SIMLA_COM_GET_PRODUCTS`

Tool to retrieve a list of products. Use when you need to list products with optional filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter by a list of product IDs |
| `name` | string | No | Filter by product name |
| `page` | integer | No | Page number to retrieve (default: 1) |
| `limit` | integer | No | Number of products to return per page (max: 250) |
| `active` | boolean | No | Filter active products |
| `quantity` | integer | No | Filter by available quantity |
| `max_price` | number | No | Filter products by maximum price |
| `min_price` | number | No | Filter products by minimum price |
| `external_id` | string | No | Filter by external product ID |
| `created_at_to` | string | No | ISO8601 datetime; only products created before this timestamp |
| `updated_at_to` | string | No | ISO8601 datetime; only products updated before this timestamp |
| `created_at_from` | string | No | ISO8601 datetime; only products created after this timestamp |
| `updated_at_from` | string | No | ISO8601 datetime; only products updated after this timestamp |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Cost Groups

**Slug:** `SIMLA_COM_GET_REFERENCE_COST_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Cost Items

**Slug:** `SIMLA_COM_GET_REFERENCE_COST_ITEMS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Countries

**Slug:** `SIMLA_COM_GET_REFERENCE_COUNTRIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Couriers

**Slug:** `SIMLA_COM_GET_REFERENCE_COURIERS`

Tool to retrieve the list of available couriers. Use when you need to fetch courier information or get courier codes for deliveries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of couriers per page (items to return) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Currencies

**Slug:** `SIMLA_COM_GET_REFERENCE_CURRENCIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Delivery Services

**Slug:** `SIMLA_COM_GET_REFERENCE_DELIVERY_SERVICES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Delivery Types

**Slug:** `SIMLA_COM_GET_REFERENCE_DELIVERY_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Legal Entities

**Slug:** `SIMLA_COM_GET_REFERENCE_LEGAL_ENTITIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MessageGateway Channels

**Slug:** `SIMLA_COM_GET_REFERENCE_MG_CHANNELS`

Tool to retrieve a list of all MessageGateway channels in the system. Use when you need to discover available messaging channels for communication.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Order Methods

**Slug:** `SIMLA_COM_GET_REFERENCE_ORDER_METHODS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Order Types

**Slug:** `SIMLA_COM_GET_REFERENCE_ORDER_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Payment Statuses

**Slug:** `SIMLA_COM_GET_REFERENCE_PAYMENT_STATUSES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Payment Types

**Slug:** `SIMLA_COM_GET_REFERENCE_PAYMENT_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Price Types

**Slug:** `SIMLA_COM_GET_REFERENCE_PRICE_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Statuses

**Slug:** `SIMLA_COM_GET_REFERENCE_PRODUCT_STATUSES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Statuses

**Slug:** `SIMLA_COM_GET_REFERENCE_STATUSES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Status Groups

**Slug:** `SIMLA_COM_GET_REFERENCE_STATUS_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Subscriptions

**Slug:** `SIMLA_COM_GET_REFERENCE_SUBSCRIPTIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference Units

**Slug:** `SIMLA_COM_GET_REFERENCE_UNITS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segments

**Slug:** `SIMLA_COM_GET_SEGMENTS`

Tool to retrieve a list of customer segments. Use when you need to list segments with optional filters after authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default is 1. |
| `site` | string | No | Symbolic code of the store. Required if the API key has access to multiple stores. |
| `limit` | integer | No | Number of segments per page. Must be 20, 50, or 100. Default is 20. |
| `filter_name` | string | No | Filter segments by name. |
| `filter_active` | boolean | No | Filter segments by active status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Settings

**Slug:** `SIMLA_COM_GET_SETTINGS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sites

**Slug:** `SIMLA_COM_GET_SITES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Statistic Update

**Slug:** `SIMLA_COM_GET_STATISTIC_UPDATE`

Tool to trigger an update of CRM basic statistics. Use when you need to refresh statistical data in the system.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Inventories

**Slug:** `SIMLA_COM_GET_STORE_INVENTORIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer ("20" | "50" | "100" | "250") | No | Allowed values for limit parameter |
| `filter_ids` | array | No | Filter by a list of offer IDs |
| `filter_details` | integer | No | Include detailed information (1 for yes, 0 for no) |
| `filter_product_active` | integer | No | Filter by product active status (1 for active, 0 for inactive) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Offers

**Slug:** `SIMLA_COM_GET_STORE_OFFERS`

Tool to retrieve a list of store offers with pagination support. Use when you need to fetch available offers from the store catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer | No | Number of offers to return per page. Must be one of: 20, 50, or 100 (default: 20) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Products Properties

**Slug:** `SIMLA_COM_GET_STORE_PRODUCTS_PROPERTIES`

Tool to retrieve a list of product properties from the store. Use when you need to fetch product property definitions with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `limit` | integer | No | Number of items per page (default: 20) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Products Properties Values

**Slug:** `SIMLA_COM_GET_STORE_PRODUCTS_PROPERTIES_VALUES`

Tool to retrieve product property values from the store. Use when you need to list property values with optional filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve (default: 1) |
| `limit` | integer | No | Number of property values to return per page. Must be 20, 50, or 100 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stores

**Slug:** `SIMLA_COM_GET_STORES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `SIMLA_COM_GET_TASK`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the task to retrieve. Must be a positive integer representing an existing task ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tasks

**Slug:** `SIMLA_COM_GET_TASKS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Filter by specific task IDs |
| `limit` | integer | No | Maximum number of tasks to return |
| `expand` | array | No | Related entities to expand in the response |
| `filter` | array | No | Custom filter conditions as defined by the API (array of objects) |
| `offset` | integer | No | Number of tasks to skip for pagination |
| `status` | string | No | Filter tasks by status |
| `orderIds` | array | No | Filter by related order IDs |
| `createdAtTo` | string | No | ISO 8601 datetime to include tasks created on or before this timestamp |
| `createdAtFrom` | string | No | ISO 8601 datetime to include tasks created on or after this timestamp |
| `responsibleUserIds` | array | No | Filter by IDs of users responsible for the task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tasks Comments

**Slug:** `SIMLA_COM_GET_TASKS_COMMENTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the task to retrieve comments for. Must be a positive integer representing an existing task ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tasks History

**Slug:** `SIMLA_COM_GET_TASKS_HISTORY`

Tool to retrieve task change history. Use when you need to track changes to tasks over time. Use sinceId for incremental synchronization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sinceId` | integer | No | Return history records with ID greater than specified value. Used for incremental synchronization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Telephony Setting

**Slug:** `SIMLA_COM_GET_TELEPHONY_SETTING`

Tool to retrieve telephony integration settings by code. Use when you need to fetch configuration details for a specific telephony integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The unique code/identifier of the telephony integration whose settings you want to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `SIMLA_COM_GET_USER`

Tool to retrieve detailed information about a specific user by ID. Use when you need complete user data for a known user identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The user ID to retrieve information for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Groups

**Slug:** `SIMLA_COM_GET_USER_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of user groups to return per page. Must be 20, 50, or 100 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Users

**Slug:** `SIMLA_COM_GET_USERS`

Tool to retrieve a list of users. Use when you need to fetch users with optional pagination, filtering, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of users to return per page |
| `sortBy` | string | No | Field name to sort by |
| `sortOrder` | string ("asc" | "desc") | No | Sort order: 'asc' or 'desc' |
| `externalId` | string | No | Filter by external user ID |
| `createdAtTo` | string | No | Filter users created before this timestamp (YYYY-MM-DD HH:MM:SS) |
| `customField` | string | No | Filter by a custom field |
| `createdAtFrom` | string | No | Filter users created after this timestamp (YYYY-MM-DD HH:MM:SS) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Subscriptions

**Slug:** `SIMLA_COM_UPDATE_CUSTOMER_SUBSCRIPTIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `externalId` | string | Yes | External identifier of the customer to update subscriptions for |
| `subscriptions` | array | Yes | Array of subscription configurations to update. Each item specifies a channel and whether the customer should be subscribed or unsubscribed to that channel |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Status

**Slug:** `SIMLA_COM_UPDATE_USER_STATUS`

Tool to change a user's status. Use when you need to update a user's current work status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The user ID whose status to change |
| `status` | string ("free" | "busy" | "dinner" | "break") | Yes | New status for the user. Must be one of: free, busy, dinner, or break |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Costs

**Slug:** `SIMLA_COM_UPLOAD_COSTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `costs` | array | Yes | Array of cost records to upload (1-50 items per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Customers

**Slug:** `SIMLA_COM_UPLOAD_CUSTOMERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Symbolic code of the store receiving the customers |
| `customers` | array | Yes | Array of customer records to upload (1-50 items per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Corporate Customers

**Slug:** `SIMLA_COM_UPLOAD_CUSTOMERS_CORPORATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customersCorporate` | array | Yes | Array of corporate customer objects to upload (1-50 items per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Orders

**Slug:** `SIMLA_COM_UPLOAD_ORDERS`

Upload 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site` | string | No | Default site/store code for all orders (optional, can be overridden per order) |
| `orders` | array | Yes | Array of order objects to upload in batch (maximum 50 orders per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Store Prices

**Slug:** `SIMLA_COM_UPLOAD_STORE_PRICES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prices` | array | Yes | Array of offers with their price information to upload (at least one required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Web Analytics Client IDs

**Slug:** `SIMLA_COM_UPLOAD_WEB_ANALYTICS_CLIENT_IDS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `clientIds` | array | Yes | Array of client ID records to upload for web analytics tracking (at least 1 required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Web Analytics Sources

**Slug:** `SIMLA_COM_UPLOAD_WEB_ANALYTICS_SOURCES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sources` | array | Yes | Array of web analytics source records to upload (at least one required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
