Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to BaseLinker

Scalekit connector
Open markdown

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

Tools
60
What they doRead · write · destructive
42 · 15 · 342 read15 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the BaseLinker connection

    In AgentKit > Connections, create a BaseLinker connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    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 = 'baselinker'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize BaseLinker:', 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: 'baselinker_catalog_extra_fields_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their BaseLinker credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • baselinker_catalog_extra_fields_listRetrieve a list of extra fields for a BaseLinker catalog.Read-only

    List Catalog Extra Fields

    Retrieve a list of extra fields for a BaseLinker catalog. Returns extra_fields with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryExtraFields.

    Inputs

    parametersstring
    getInventoryExtraFields takes no parameters; leave this empty or send {}. Example: {}default {}
  • baselinker_categories_listRetrieve a list of categories for a Base catalog.Read-only

    List Catalog Categories

    Retrieve a list of categories for a Base catalog. Returns categories with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryCategories.

    Inputs

    parametersstringrequired
    Input parameters of getInventoryCategories as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: inventory_id (int): Catalog ID. The list of identifiers can be retrieved by the getInventories method (inventory_id field). To retrieve categories available for all catalogs created in Base, this field should be omitted. Example: {}
  • baselinker_courier_accounts_listRetrieve a list of accounts connected with a courier.Read-only

    List Courier Accounts

    Retrieve a list of accounts connected with a courier. Returns accounts with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getCourierAccounts.

    Inputs

    parametersstringrequired
    Input parameters of getCourierAccounts as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: courier_code (varchar(20)): Courier code Example: {"courier_code": "dpd"}
  • baselinker_courier_services_listRetrieve additional courier services, which depend on other shipment settings.Read-only

    List Courier Services

    Retrieve additional courier services, which depend on other shipment settings. Used only for BrokerSystem, Wysyłam z Allegro, ErliPRO couriers. Returns services with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getCourierServices.

    Inputs

    parametersstringrequired
    Input parameters of getCourierServices as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: courier_code (varchar(20)): Courier code | order_id (int): Order identifier | account_id (int): Courier API account identifier. If blank, the first account will be used. | fields (array): Form fields (the same as in createPackage method). The field_id should be used as a key. | packages (array): Package information (the same as in createPackage method) Example: {"courier_code": "brokersystem", "order_id": 6911000, "account_id": 294, "fields": [{"id": "package_type", "value": "package"}, {"id": "cod", "value": 0}], "packages": [{"length": 11, "height": 12, "width": 13, "weight": 4}]}
  • baselinker_couriers_listRetrieve a list of available couriers.Read-only

    List Couriers

    Retrieve a list of available couriers. Returns couriers with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getCouriersList.

    Inputs

    parametersstring
    getCouriersList takes no parameters; leave this empty or send {}. Example: {}default {}
  • baselinker_crm_client_getRetrieve detailed data of a specific CRM client, including notes.Read-only

    Get CRM Client

    Retrieve detailed data of a specific CRM client, including notes. Returns crm_client_id, status_id, star, login, phone, email, notes, contractor_id, and more with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getCrmClientData.

    Inputs

    parametersstringrequired
    Input parameters of getCrmClientData as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: crm_client_id (int): ID of the CRM client to retrieve. | include_custom_extra_fields (bool): (optional, false by default) Download values of custom additional fields. Example: {"crm_client_id": 42}
  • baselinker_crm_clients_listRetrieve a list of CRM clients.Read-only

    List CRM Clients

    Retrieve a list of CRM clients. The client list can be limited using the filters described in the method parameters. Returns clients with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_crm_client_get for one client. Calls the BaseLinker API method getCrmClients.

    Inputs

    parametersstringrequired
    Input parameters of getCrmClients as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: page (int): Results page number (100 results per page, numbered from 1). | filter_crm_client_id (int): Filter by exact CRM client ID. | filter_email (varchar(220)): Filter by email (partial match). | filter_phone (varchar(156)): Filter by phone (partial match). | filter_login (varchar(156)): Filter by login (partial match). | filter_invoice_company (varchar(500)): Filter by invoice company name (partial match). | filter_invoice_tax_id (varchar(50)): Filter by invoice tax ID (partial match). | filter_invoice_fullname (varchar(500)): Filter by invoice full name (partial match). | filter_status_id (int): Filter by exact status ID. Example: {"filter_invoice_company": "Example", "page": 1}
  • baselinker_external_storage_products_listRetrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker.Read-only

    List External Storage Products

    Retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker. Returns storage_id, products with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getExternalStorageProductsList.

    Inputs

    parametersstringrequired
    Input parameters of getExternalStorageProductsList as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: storage_id (varchar(30)): Storage ID in format "[type:shop|warehouse]_[id:int]" (e.g. "shop_2445"). | filter_category_id (varchar(30)): (optional) Retrieving products from a specific category | filter_sort (varchar(30)): (optional) the value for sorting the product list. Possible values: "id [ASC|DESC]", "name [ASC|DESC]", "quantity [ASC|DESC]", "price [ASC|DESC]" | filter_id (varchar(30)): (optional) limiting results to a specific product id | filter_sku (varchar(50)): (optional) limiting the results to a specific SKU (stock keeping number) | filter_ean (varchar(320)): (optional) limiting results to a specific ean | filter_asin (varchar(50)): (optional) limiting results to a specific asin | filter_name (varchar(255)): (optional) item name filter (part of the searched name or an empty field) | filter_price_from (float): (optional) minimum price limit (not displaying products with lower price) | filter_price_to (float): (optional) maximum price limit | filter_quantity_from (int): (optional) minimum quantity limit | filter_quantity_to (int): (optional) maximum quantity limit | filter_available (int): (optional) displaying only products marked as available (value 1) or not available (0) or all (empty value) | page (int): (optional) Results paging Example: {"storage_id": "shop_2445", "filter_category_id": 543}