> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Simla.com

The Simla.com connector lets your AI agent act in each user's Simla.com account. Each user connects their own Simla.com API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 55 tools.

**Authentication:** API Key
**Categories:** CRM & Sales
**Tools:** 55: 41 read, 13 write, 1 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SIMLA)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Simla.com connection

   In **AgentKit > Connections**, create a Simla.com connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'simla'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Simla.com:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'simla_corporate_customers_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "simla"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Simla.com:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="simla_corporate_customers_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Simla.com credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'simla_corporate_customer_get',
  toolInput: {
    external_id: '<external_id>',
  },
  connector: 'simla',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="simla_corporate_customer_get",
    tool_input={
        "external_id": "<external_id>",
    },
    connection_name="simla",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `simla_corporate_customer_get`

Get Corporate Customer · Read-only

Get one Simla corporate customer by external ID (or internal ID with by=id).
Returns the corporate customer with companies, contact persons, addresses and manager.
Use this for a company's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): Customer ID. Example: ext-1001.
- `by` (`string`, optional): Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) ID. By default it is externalId. Example: externalId. One of: `id`, `externalId`.
- `site` (`string`, optional): Symbolic code of store. Is specified in case of handling by externalId (by=externalId). Example: main-store.

Example input: `{"external_id":"<external_id>"}`

### `simla_corporate_customers_list`

List Corporate Customers · Read-only

List Simla corporate customers (companies).
Returns corporate customers with ID, external ID, nickname, companies, contacts and manager.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_city` (`string`, optional): City. Example: Sofia.
- `filter_name` (`string`, optional): Customer. Example: Jane.
- `filter_region` (`string`, optional): Region. Example: Sofia City.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_couriers_list`

List Couriers · Read-only

List the couriers configured in Simla.
Returns couriers with ID, name, phone and active flag.
Use this to assign couriers to deliveries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_credentials_get`

Get API Key Permissions · Read-only

Get the API methods and stores the Simla API key can access.
Returns the allowed scopes, stores (sites) and the system version.
Use this to check the connection and the key's permissions first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_currencies_list`

List Currencies · Read-only

List the currencies configured in Simla.
Returns currencies with code, base flag and exchange rate settings.
Use this to check currencies used by stores.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_custom_fields_list`

List Custom Fields · Read-only

List the custom fields defined in Simla for orders, customers and other entities.
Returns fields with code, name, entity and type.
Use this to find custom field codes for create and update calls.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`, `250`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_customer_get`

Get Customer · Read-only

Get one Simla customer by external ID (or internal ID with by=id).
Returns the customer's full record: names, contacts, address, manager, tags, custom fields and order stats.
Use this for a customer's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): Customer ID. Example: ext-1001.
- `by` (`string`, optional): Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId. Example: externalId. One of: `id`, `externalId`.
- `site` (`string`, optional): Symbolic code of store. Example: main-store.

Example input: `{"external_id":"<external_id>"}`

### `simla_customer_notes_list`

List Customer Notes · Read-only

List notes on Simla customers, filtered by text or creation date.
Returns notes with ID, text, customer, manager and date.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_created_at_from` (`string`, optional): Date/time of creation (from). Example: 2026-10-01 00:00:00.
- `filter_created_at_to` (`string`, optional): Date/time of creation (to). Example: 2026-10-31 23:59:59.
- `filter_text` (`string`, optional): Note text. Example: call back.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_customers_history_list`

List Customer History · Read-only

List changes made to Simla customers, oldest first, optionally for one customer or a date range.
Returns history records with field, old and new values, source and user.
Use this to sync customer changes incrementally with filter_since_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_customer_external_id` (`string`, optional): Customer external ID. Example: cust-2201.
- `filter_customer_id` (`integer`, optional): Customer ID. Example: 2201.
- `filter_end_date` (`string`, optional): End DateTime of change. Example: 2026-10-31 23:59:59.
- `filter_since_id` (`integer`, optional): Starting with customers history ID. Example: 1.
- `filter_start_date` (`string`, optional): Start DateTime of change. Example: 2026-10-01 00:00:00.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_customers_list`

List Customers · Read-only

List Simla customers (individuals), filtered by name, email, city, registration date, segment or other fields.
Returns customers with ID, external ID, names, contacts, address, order stats and pagination.
Use limit 20, 50 or 100 and page to move through results. Use simla_customer_get for one customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_bad` (`boolean`, optional): BAD customer. Example: true.
- `filter_city` (`string`, optional): City. Example: Sofia.
- `filter_date_from` (`string`, optional): Registration date (from). Example: 2026-10-01.
- `filter_date_to` (`string`, optional): Registration date (to). Example: 2026-10-31.
- `filter_email` (`string`, optional): E-mail. Example: jane@example.com.
- `filter_min_orders_count` (`integer`, optional): Orders count (from). Example: 10.
- `filter_name` (`string`, optional): Customer. Example: Jane.
- `filter_region` (`string`, optional): Region. Example: Sofia City.
- `filter_segment` (`string`, optional): Segment. Example: vip-buyers.
- `filter_vip` (`boolean`, optional): VIP customer. Example: true.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_delivery_services_list`

List Delivery Services · Read-only

List the delivery services configured in Simla.
Returns services with code, name and delivery type.
Use this to get delivery service codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_delivery_types_list`

List Delivery Types · Read-only

List the delivery types configured in Simla.
Returns delivery types with code, name, default cost and allowed payment types.
Use this to get delivery codes for orders.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_inventories_list`

List Inventories · Read-only

List Simla stock balances and purchase prices of offers per warehouse.
Returns offers with stock quantity per store and purchase price.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_details` (`boolean`, optional): Return the details for stock balance. Defaults to false. Example: true.
- `filter_offer_active` (`boolean`, optional): Return the stock balance only for active SKUs. Example: true.
- `filter_product_active` (`boolean`, optional): Return the stock balance only for active products. Example: true.
- `filter_product_external_id` (`string`, optional): Product external ID. Example: prod-77.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`, `250`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_knowledge_base_documents_list`

List Knowledge Base Documents · Read-only

List the Simla knowledge base documents.
Returns documents with ID, title, section and dates.
Use this to find help articles for support.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.

Example input: `{}`

### `simla_offers_list`

List Offers · Read-only

List Simla offers (SKUs), filtered by name, article or barcode, price type, activity or price.
Returns offers with ID, external ID, name, article, barcode, prices and quantity.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_active` (`boolean`, optional): Activity. Example: True. One of: `true`, `false`.
- `filter_max_price` (`integer`, optional): Offer price (to). Example: 100.
- `filter_min_price` (`integer`, optional): Offer price (from). Example: 10.
- `filter_name` (`string`, optional): Name/article of the product or article/barcode of the offer. Example: Jane.
- `filter_price_type` (`string`, optional): Price type. Example: base.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_order_get`

Get Order · Read-only

Get one Simla order by external ID (or internal ID with by=id).
Returns the order with status, customer, items, totals, delivery, payments and custom fields.
Use this for an order's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): Order ID. Example: ext-1001.
- `by` (`string`, optional): Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) order ID. By default it is externalId. Example: externalId. One of: `id`, `externalId`.
- `site` (`string`, optional): Symbolic code of store. Example: main-store.

Example input: `{"external_id":"<external_id>"}`

### `simla_order_methods_list`

List Order Methods · Read-only

List the order methods (channels) configured in Simla, such as shopping cart or phone.
Returns methods with code and name.
Use this to get orderMethod codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_order_packs_list`

List Order Packs · Read-only

List Simla order packs (items reserved and packed from a warehouse).
Returns packs with ID, order item, store, quantity and shipment date.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_order_types_list`

List Order Types · Read-only

List the order types configured in Simla.
Returns order types with code and name.
Use this to get orderType codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_orders_history_list`

List Order History · Read-only

List changes made to Simla orders, oldest first, optionally for one order or a date range.
Returns history records with field, old and new values, source and user.
Use this to sync order changes incrementally with filter_since_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_end_date` (`string`, optional): End DateTime of change. Example: 2026-10-31 23:59:59.
- `filter_order_external_id` (`string`, optional): Order external ID. Example: ext-1001.
- `filter_order_id` (`integer`, optional): Order ID. Example: 1501.
- `filter_since_id` (`integer`, optional): Starting with orders history ID. Example: 1.
- `filter_start_date` (`string`, optional): Start DateTime of change. Example: 2026-10-01 00:00:00.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_orders_list`

List Orders · Read-only

List Simla orders, filtered by customer, email, product, region or other fields.
Returns orders with ID, number, status, customer, items, totals, delivery and payments, plus pagination.
Use limit 20, 50 or 100 and page to move through results. Use simla_order_get for one order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_call` (`boolean`, optional): Call required. Example: true.
- `filter_customer` (`string`, optional): Customer (Name or phone number). Example: Jane Doe.
- `filter_customer_external_id` (`string`, optional): Customer external ID. Example: cust-2201.
- `filter_customer_id` (`integer`, optional): Customer ID. Example: 2201.
- `filter_email` (`string`, optional): E-mail. Example: jane@example.com.
- `filter_expired` (`boolean`, optional): Order expired. Example: true.
- `filter_product` (`string`, optional): Product (title or article). Example: Hoodie.
- `filter_region` (`string`, optional): Region. Example: Sofia City.
- `filter_vip` (`boolean`, optional): VIP customer. Example: true.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_payment_statuses_list`

List Payment Statuses · Read-only

List the payment statuses configured in Simla.
Returns statuses with code and name.
Use this to get payment status codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_payment_types_list`

List Payment Types · Read-only

List the payment types configured in Simla.
Returns payment types with code, name and allowed statuses.
Use this to get payment type codes for orders.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_price_types_list`

List Price Types · Read-only

List the price types configured in Simla.
Returns price types with code, name and default flag.
Use this to get price type codes for simla_prices_upload.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_product_groups_list`

List Product Groups · Read-only

List Simla product groups (catalog categories).
Returns groups with ID, external ID, name, parent and site.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_products_list`

List Products · Read-only

List Simla catalog products and their SKUs (offers), filtered by name or article, manufacturer, external ID, price, quantity or activity.
Returns products with ID, name, article, prices, quantities, groups and offers.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_active` (`boolean`, optional): Activity. Example: true.
- `filter_external_id` (`string`, optional): External ID. Example: prod-77.
- `filter_manufacturer` (`string`, optional): Manufacturer. Example: Acme.
- `filter_max_price` (`integer`, optional): Price of product (to). Example: 100.
- `filter_min_price` (`integer`, optional): Price of product (from). Example: 10.
- `filter_name` (`string`, optional): Name/article of the product or article/barcode of the SKU. Example: Jane.
- `filter_since_updated_at` (`string`, optional): Lower limit on the date of product change (excluding the border). Example: 2026-10-01 00:00:00.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_segments_list`

List Customer Segments · Read-only

List the Simla customer segments.
Returns segments with ID, code, name, size and whether they are dynamic.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_shipments_list`

List Shipments · Read-only

List Simla shipments to delivery services.
Returns shipments with ID, delivery service, orders, status and dates.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_sites_list`

List Stores · Read-only

List the stores (sites) configured in Simla.
Returns each store's code, name, URL, currency and settings.
Use this to get the site codes other tools need.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_status_groups_list`

List Order Status Groups · Read-only

List the order status groups in Simla, such as new, approval, assembling, delivery and complete.
Returns groups with code, name and their statuses.
Use this to understand the order workflow.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_statuses_list`

List Order Statuses · Read-only

List the order statuses configured in Simla.
Returns each status's code, name, group and order.
Use this to get status codes for simla_order_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_task_comments_list`

List Task Comments · Read-only

List the comments on a Simla task.
Returns comments with text, author and date.
Use this to read the discussion on a task.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Task ID. Example: 1501.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{"id":1501}`

### `simla_task_get`

Get Task · Read-only

Get one Simla task.
Returns the task's text, commentary, due time, performer, status and linked order or customer.
Use this for a task's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Task ID. Example: 1501.

Example input: `{"id":1501}`

### `simla_tasks_list`

List Tasks · Read-only

List Simla tasks for managers, filtered by status, priority, text, linked order, ticket or customer, or dates.
Returns tasks with ID, text, commentary, due time, performer, status and links.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_customer_id` (`integer`, optional): Customer ID related to the task. Example: 2201.
- `filter_date_from` (`string`, optional): Task execution date (from). Example: 2026-10-01.
- `filter_date_to` (`string`, optional): Task execution date (to). Example: 2026-10-31.
- `filter_order_id` (`integer`, optional): Order ID related to the task. Example: 1501.
- `filter_order_number` (`string`, optional): Number of order, related to the task. Example: 1501A.
- `filter_priority` (`string`, optional): Task priority. Example: low. One of: `low`, `medium`, `high`.
- `filter_status` (`string`, optional): Task status. Example: expired. One of: `expired`, `completed`, `performing`.
- `filter_text` (`string`, optional): Task text. Example: call back.
- `filter_ticket_id` (`integer`, optional): Ticket ID related to the task. Example: 42.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_ticket_comments_list`

List Ticket Comments · Read-only

List Simla ticket comments, filtered by text or dates; paged with a cursor.
Returns comments with text, ticket, author and date, plus the next cursor.
Use this to read ticket discussions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): The cursor of the element from which the search starts. Example: eyJpZCI6MTAwfQ.
- `filter_created_at_from` (`string`, optional): Created at or after this date and time. Example: 2026-10-01 00:00:00.
- `filter_created_at_to` (`string`, optional): Created at or before this date and time. Example: 2026-10-31 23:59:59.
- `filter_text` (`string`, optional): Case-insensitive text substring. Example: call back.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.

Example input: `{}`

### `simla_ticket_get`

Get Ticket · Read-only

Get one Simla ticket by external ID (or internal ID with by=id).
Returns the ticket with description, customer, issues, status, topic and custom fields.
Use this for a ticket's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): External or internal ticket ID. Example: ext-1001.
- `by` (`string`, optional): Ticket identifier type. Defaults to externalId. Example: externalId. One of: `id`, `externalId`.
- `site` (`string`, optional): Symbolic code of store. Example: main-store.

Example input: `{"external_id":"<external_id>"}`

### `simla_tickets_list`

List Tickets · Read-only

List Simla support tickets, newest first, filtered by state, SLA, customer, email, text or dates; paged with a cursor.
Returns tickets with ID, number, state, customer, topic, issues and dates, plus the next cursor.
Use this to review support work. Pass the returned cursor to get the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): The cursor of the element from which the search starts. Example: eyJpZCI6MTAwfQ.
- `filter_comments` (`string`, optional): Comment text. Example: refund.
- `filter_created_at_from` (`string`, optional): Creation date from. Example: 2026-10-01 00:00:00.
- `filter_created_at_to` (`string`, optional): Creation date to. Example: 2026-10-31 23:59:59.
- `filter_customer` (`string`, optional): Customer search. Example: Jane Doe.
- `filter_description` (`string`, optional): Ticket description. Example: refund.
- `filter_email` (`string`, optional): Customer email. Example: jane@example.com.
- `filter_sla` (`string`, optional): SLA status. Example: normal. One of: `normal`, `warning`, `urgent`.
- `filter_ticket_state` (`string`, optional): Ticket state. Example: opened. One of: `opened`, `completed`.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.

Example input: `{}`

### `simla_user_get`

Get User · Read-only

Get one Simla user.
Returns the user's name, email, phone, groups, status and online state.
Use this for a user's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): User ID. Example: 1501.

Example input: `{"id":1501}`

### `simla_user_groups_list`

List User Groups · Read-only

List the Simla user groups.
Returns groups with code, name and permissions.
Use this to see how staff are organized.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_users_list`

List Users · Read-only

List Simla users (managers and staff), filtered by email, activity, online state or status.
Returns users with ID, name, email, groups, status and online state.
Use limit 20, 50 or 100 and page to move through results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_active` (`string`, optional): Active. Example: 0. One of: `0`, `1`.
- `filter_email` (`string`, optional): User email. Example: jane@example.com.
- `filter_is_manager` (`string`, optional): User is manager. Example: 1. One of: `1`.
- `filter_online` (`string`, optional): User online. Example: 0. One of: `0`, `1`.
- `filter_status` (`string`, optional): User status in the system. When using the filter[status] filter, only those users who have the true value in the online field are included in the selection. Example: free. One of: `free`, `busy`, `dinner`, `break`.
- `limit` (`integer`, optional): Quantity of elements in the answer (20 by default). Example: 20. One of: `20`, `50`, `100`.
- `page` (`integer`, optional): Number of page with the results (1 by default). Example: 1.

Example input: `{}`

### `simla_warehouses_list`

List Warehouses · Read-only

List the warehouses configured in Simla.
Returns warehouses with code, name, type and address.
Use this to get store codes for stock uploads.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `simla_corporate_customer_create`

Create Corporate Customer · Write

Create a Simla corporate customer (a company account).
Returns the new corporate customer's internal ID.
Use this for B2B accounts.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customerCorporate` (`string`, required): Corporate customer data as JSON text: nickName, externalId, managerId, tags, customFields, and optionally companies, addresses and customerContacts. Example: {"nickName": "Acme Ltd", "externalId": "corp-55"}

Example input: `{"customerCorporate":"<customerCorporate>"}`

### `simla_customer_create`

Create Customer · Write

Create a Simla customer (individual).
Returns the new customer's internal ID.
Use this to add a customer. Use simla_corporate_customer_create for a company.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer` (`string`, required): Customer data as JSON text: firstName, lastName, email, phones (list of {number}), address, externalId, managerId, tags, customFields and other customer fields from the API reference. Example: {"firstName": "Jane", "lastName": "Doe", "email": "jane@example.com", "phones": [{"number": "+359888123456"}]}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"customer":"<customer>"}`

### `simla_customer_note_create`

Create Customer Note · Write

Add a note to a Simla customer.
Returns the new note's ID.
Use this to log a call or remark about a customer.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `note` (`string`, required): Note as JSON text: text and customer ({id} or {externalId}), optionally managerId. Example: {"text": "Prefers delivery after 18:00", "customer": {"id": 2201}}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"note":"<note>"}`

### `simla_customer_update`

Update Customer · Write

Edit a Simla customer by external ID (or internal ID with by=id); only the fields you send change.
Returns the customer's internal ID.
Use this to change customer details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer` (`string`, required): Customer data as JSON text: firstName, lastName, email, phones (list of {number}), address, externalId, managerId, tags, customFields and other customer fields from the API reference. Example: {"email": "jane.doe@example.com", "vip": true}
- `external_id` (`string`, required): External ID. Example: ext-1001.
- `by` (`string`, optional): externalId (default) or id: what the externalId path value is. Example: externalId.
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"customer":"<customer>","external_id":"<external_id>"}`

### `simla_inventories_upload`

Upload Inventories · Write

Update stock balances and purchase prices of Simla offers, up to 250 offers per call.
Returns the number of processed offers and any not found.
Use this to sync stock from a warehouse system.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `offers` (`string`, required): Offers as JSON text: a list of {externalId or id, stores: [{code, available, purchasePrice}]}. Example: [{"externalId": "sku-77-m", "stores": [{"code": "main-warehouse", "available": 25}]}]
- `site` (`string`, optional): Store code; required when offers are identified by externalId. Example: main-store.

Example input: `{"offers":"<offers>"}`

### `simla_order_create`

Create Order · Write

Create a Simla order with customer, items, delivery and payment details.
Returns the new order's internal ID and the created order.
Use this to register an order from another channel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `order` (`string`, required): Order data as JSON text: number, externalId, firstName, lastName, phone, email, status, orderMethod, customer ({id} or {externalId}), items (list with offer {externalId} or productName, initialPrice and quantity), delivery and payments, as in the API reference. Example: {"firstName": "Jane", "phone": "+359888123456", "customer": {"id": 2201}, "items": [{"productName": "Hoodie", "initialPrice": 49.9, "quantity": 1}]}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"order":"<order>"}`

### `simla_order_update`

Update Order · Write

Edit a Simla order by external ID (or internal ID with by=id), such as its status, manager, comments or delivery; only the fields you send change.
Returns the order's internal ID and the updated order.
Use this to move an order through statuses. Use simla_statuses_list for status codes.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): External ID. Example: ext-1001.
- `order` (`string`, required): Order fields to change as JSON text, such as status, managerComment, managerId or delivery. Example: {"status": "assembling", "managerComment": "Packed"}
- `by` (`string`, optional): externalId (default) or id: what the externalId path value is. Example: id.
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"external_id":"<external_id>","order":"<order>"}`

### `simla_prices_upload`

Upload Prices · Write

Update prices of Simla offers, up to 250 prices per call.
Returns the number of processed prices and any not found.
Use this to sync prices from another system.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `prices` (`string`, required): Prices as JSON text: a list of {externalId or id, site, prices: [{code (price type), price}]}. Example: [{"externalId": "sku-77-m", "site": "main-store", "prices": [{"code": "base", "price": 49.9}]}]

Example input: `{"prices":"<prices>"}`

### `simla_task_create`

Create Task · Write

Create a Simla task for a manager, optionally linked to an order or customer.
Returns the new task's ID.
Use this to schedule a follow-up. Use simla_users_list for performer IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `task` (`string`, required): Task data as JSON text: text (required), commentary, datetime (Y-m-d H:i), performerId (user ID, required), order or customer link, complete (true/false). Example: {"text": "Call the customer about delivery", "performerId": 12, "datetime": "2026-11-18 10:00", "order": {"id": 1501}}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"task":"<task>"}`

### `simla_task_update`

Update Task · Write

Edit a Simla task, such as its text, due time, performer or completion.
Returns the task's ID.
Use this to reschedule or complete a task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Task ID. Example: 1501.
- `task` (`string`, required): Task fields to change as JSON text, such as text, datetime, performerId or complete. Example: {"complete": true}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"id":1501,"task":"<task>"}`

### `simla_ticket_comment_create`

Create Ticket Comment · Write

Add a comment to a Simla ticket.
Returns the new comment's ID.
Use this to log an update on a support case.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `comment` (`string`, required): Comment as JSON text: text and ticket ({id} or {externalId} or {number}). Example: {"text": "Refund sent to the card", "ticket": {"id": 42}}

Example input: `{"comment":"<comment>"}`

### `simla_ticket_create`

Create Ticket · Write

Create a Simla support ticket for a customer.
Returns the new ticket's ID.
Use this to open a support case.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `ticket` (`string`, required): Ticket data as JSON text: description, customer ({id} or {externalId}), type, channel, topic, status and other ticket fields from the API reference. Example: {"description": "Package arrived damaged", "customer": {"id": 2201}}
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"ticket":"<ticket>"}`

### `simla_ticket_update`

Update Ticket · Write

Edit a Simla ticket by external ID (or internal ID with by=id); omitted fields keep their values.
Returns the ticket's ID.
Use this to change a ticket's description, topic or status.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, required): External or internal ticket ID. Example: ext-1001.
- `ticket` (`string`, required): Ticket fields to change as JSON text, such as description or status. Example: {"description": "Package arrived damaged, refund issued"}
- `by` (`string`, optional): externalId (default) or id: what the externalId path value is. Example: id.
- `site` (`string`, optional): Symbolic code of the store (site) the record belongs to, from simla_sites_list. Example: main-store.

Example input: `{"external_id":"<external_id>","ticket":"<ticket>"}`

### `simla_customer_note_delete`

Delete Customer Note · Destructive

Delete a note from a Simla customer.
Returns success true.
Use this to remove a note.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Note ID. Example: 1501.

Example input: `{"id":1501}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
