Simla.com

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.

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 op

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 re

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.

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), an

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.

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.

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 crea

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

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 custom

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 wit

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.

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.

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.

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.

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 stat

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 aut

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.

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.

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

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.

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.

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)

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.

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 cata

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

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

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

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

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

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

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.

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

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).

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

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.

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.

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.

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.

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, stat

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

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.

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

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

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.

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.

Tool to edit an existing courier by ID. Use when you need to update courier details such as name, email, phone, or active status.

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.

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.

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

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.

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.

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 directo

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.

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.

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 exis

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 stat

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.

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 cate

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.

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.

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, quanti

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.

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

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 op

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 corpora

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 as

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 ext

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.

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

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 updatin

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.

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

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

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.

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.

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 t

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.

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

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 d

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.

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 sinceI

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.

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.

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.

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.

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

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

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.

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.

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

Tool to retrieve detailed information about a specific order. Use when you need to fetch full order data by external ID before further processing.

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

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.

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

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

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.

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.

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.

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

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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

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.

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

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

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

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.

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, cust

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.

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.

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

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

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

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.

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

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.).

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

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

Tool to batch upload customer records to Simla CRM. Use when you need to create multiple customers at once. Maximum 50 customers per request.

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 p

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 wit

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.

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 s

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, cu