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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the BaseLinker connection
In AgentKit > Connections, create a BaseLinker connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'baselinker'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'baselinker_catalog_extra_fields_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "baselinker"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize BaseLinker:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="baselinker_catalog_extra_fields_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolbaselinker_catalog_extra_fields_listRetrieve a list of extra fields for a BaseLinker catalog.Read-onlyList 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-onlyList 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-onlyList 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-onlyList 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-onlyList 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-onlyGet 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-onlyList 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-onlyList 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}
baselinker_external_storage_products_quantity_getRetrieve stock from an external storage (shop/wholesaler) connected to BaseLinker.Read-onlyGet External Storage Stock
Retrieve stock 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 getExternalStorageProductsQuantity.
Inputs
parametersstringrequired- Input parameters of getExternalStorageProductsQuantity 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"). | page (int): (optional) Results paging Example: {"storage_id": "shop_2445"}
baselinker_external_storages_listRetrieve a list of available external storages (shops, wholesalers) that can be referenced via API.Read-onlyList External Storages
Retrieve a list of available external storages (shops, wholesalers) that can be referenced via API. Returns storages with status SUCCESS, or status ERROR with error_code and error_message. Use the storage_id with the other external storage tools. Calls the BaseLinker API method getExternalStoragesList.
Inputs
parametersstring- getExternalStoragesList takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_inventories_listRetrieve a list of catalogs available in the Base storage.Read-onlyList Catalogs
Retrieve a list of catalogs available in the Base storage. Returns inventories with status SUCCESS, or status ERROR with error_code and error_message. Use the inventory_id with the other catalog tools. Calls the BaseLinker API method getInventories.
Inputs
parametersstring- getInventories takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_inventory_documents_listRetrieve a list of inventory documents from Base.Read-onlyList Inventory Documents
Retrieve a list of inventory documents from Base. It supports pagination and optional filtering by document type, date range, etc. Returns documents with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryDocuments.
Inputs
parametersstring- Input parameters of getInventoryDocuments as a JSON object encoded in a string. Every key is optional. Keys: filter_source_object_type (int): (optional) The source object type to filter by: 1 - order, 2 - purchase order, 3 - stock take, 4 - order return, 7 - fulfillment delivery, 8 - transfer | filter_source_object_id (int): (optional) The source object ID to filter by | filter_document_id (int): (optional) A specific inventory document ID | filter_document_type (int): (optional) The document type: 0 - GR (Goods Received), 1 - IGR (Internal Goods Received), 2 - GI (Goods Issue), 3 - IGI (Internal Goods Issue), 4 - IT (Internal Transfer), 5 - OB (Opening Balance) | filter_document_status (int): (optional) The document status: 0 - Draft, 1 - Confirmed | filter_date_from (int): (optional) The minimum creation date (unix timestamp) to filter by | filter_date_to (int): (optional) The maximum creation date (unix timestamp) to filter by | filter_warehouse_id (int): (optional) The warehouse ID | page (int): (optional) Results page number (100 documents per page, numbered from 1) Example: {"filter_source_object_type": 1, "filter_source_object_id": 123456, "filter_document_type": 1, "filter_date_from": 1693459200, "page": 1}default
{}
baselinker_invoices_listDownload invoices issued from the Base order manager.Read-onlyList Invoices
Download invoices issued from the Base order manager. The list of invoices can be limited using filters described in the method parameters. Returns invoices with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInvoices.
Inputs
parametersstring- Input parameters of getInvoices as a JSON object encoded in a string. Every key is optional. Keys: invoice_id (int): (optional) Invoice identifier. Completing this field will result in downloading information about only one specific invoice. | order_id (int): (optional) Order identifier. Completing this field will result in downloading information only about the invoice associated with this order (if the order has an invoice created). | date_from (int): (optional) Date from which invoices are to be collected. Unix time stamp format. | id_from (int): (optional) The invoice ID number from which subsequent invoices are to be retrieved. | series_id (int): (optional) numbering series ID that allows filtering after the invoice numbering series. | get_external_invoices (bool): (optional) If set to 'false' then omits from the results invoices that already have an external invoice file uploaded by addOrderInvoiceFile method (useful for ERP integrations uploading invoice files to Base) | get_government_data (bool): (optional) If set to 'true' then includes government data fields in the response: - gov_id (varchar) - government invoice identifier - gov_date (int) - government invoice date (unix time format) - gov_status (int) - government invoice status ( 1 => Sent, 2 => Accepted, 3 => Rejected, 5 => Offline mode) Example: {"date_from": 1407341754}default
{}
baselinker_journal_listDownload a list of order events from the last 3 days.Read-onlyList Order Events
Download a list of order events from the last 3 days. If this method is not enabled for your account, it may return an empty response - in such case, make sure it is enabled in your account API settings. Returns logs with status SUCCESS, or status ERROR with error_code and error_message. Use it to poll for changes. Use baselinker_orders_list for order details. Calls the BaseLinker API method getJournalList.
Inputs
parametersstringrequired- Input parameters of getJournalList as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: last_log_id (int): Log ID number from which the logs are to be retrieved | logs_types (array): Event ID List | order_id (int): Order ID number Example: {"last_log_id": 654258, "logs_types": [7, 13]}
baselinker_manufacturers_listRetrieve a list of manufacturers for a Base catalog.Read-onlyList Manufacturers
Retrieve a list of manufacturers for a Base catalog. Results can be paginated by providing the page parameter (1000 manufacturers per page). Returns manufacturers with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryManufacturers.
Inputs
parametersstring- Input parameters of getInventoryManufacturers as a JSON object encoded in a string. Every key is optional. Keys: page (int): (optional) Results paging (1000 manufacturers per page) Example: {}default
{}
baselinker_order_extra_fields_listExtra fields defined for the orders.Read-onlyList Order Extra Fields
Extra fields defined for the orders. Values of those fields can be set with method **setOrderFields**. Returns extra_fields with status SUCCESS, or status ERROR with error_code and error_message. Use the IDs in custom_extra_fields of baselinker_order_add and baselinker_order_fields_set. Calls the BaseLinker API method getOrderExtraFields.
Inputs
parametersstring- getOrderExtraFields takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_packages_listDownload shipments previously created for the selected order.Read-onlyList Order Packages
Download shipments previously created for the selected order. Returns packages with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_package_details_get for one package. Calls the BaseLinker API method getOrderPackages.
Inputs
parametersstringrequired- Input parameters of getOrderPackages as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order identifier Example: {"order_id": 6910995}
baselinker_order_payments_history_getRetrieve payment history for a selected order, including an external payment identifier from the payment gateway.Read-onlyGet Order Payment History
Retrieve payment history for a selected order, including an external payment identifier from the payment gateway. One order can have multiple payment history entries, caused by surcharges, order value changes, manual payment editing. Returns payments with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderPaymentsHistory.
Inputs
parametersstringrequired- Input parameters of getOrderPaymentsHistory as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order Identifier from Base order manager | show_full_history (bool): (optional, false by default) Download full payment history, including order value change entries, manual order payment edits. False by default - only returns entries containing an external payment identifier (most commonly used) Example: {"order_id": 3754894}
baselinker_order_return_reasons_listA list of order return reasons.Read-onlyList Order Return Reasons
A list of order return reasons. Values of those fields can be set with method setOrderReturnFields. Returns return_reasons with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderReturnReasonsList.
Inputs
parametersstring- getOrderReturnReasonsList takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_return_status_listReturns order return statuses created by the user in the order manager.Read-onlyList Order Return Statuses
Returns order return statuses created by the user in the order manager. Returns statuses with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderReturnStatusList.
Inputs
parametersstring- getOrderReturnStatusList takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_returns_listDownload order returns from a specific date from the Base return manager.Read-onlyList Order Returns
Download order returns from a specific date from the Base return manager. The return list can be limited using the filters described in the method parameters. Returns returns with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderReturns.
Inputs
parametersstringrequired- Input parameters of getOrderReturns as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Identifier of an order the return was created from. | return_id (int): Order return identifier. Completing this field will download information about only one specific order return. | date_from (int): The return creation date from which order return are to be collected. Format unix time stamp. | id_from (int): The order return ID number from which subsequent order returns are to be collected | status_id (int): (optional) The status identifier from which order returns are to be collected. Leave blank to download order returns from all statuses. | filter_order_return_source (varchar(20)): (optional) Filtering of order return lists by order return source, for instance "ebay", "amazon" (displays only orders come from given source). The list of order return sources can be retrieved with getOrderSources method. | filter_order_return_source_id (int): (optional) Filtering of order return lists by order return source identifier, for instance "2523" (displays only order returns come from order return source defined in "filter_order_return_source" identified by given order return source identifier). Filtering by order return source identifier requires "filter_order_return_source" to be set prior. The list of order source identifiers can be retrieved with getOrderSources method. | include_custom_extra_fields (bool): (optional, false by default) Download values of custom additional fields. | include_connect_data (bool): (optional, false by default) Base Connect and contractor data. Example: {"date_from": 1407341754}
baselinker_order_sources_listTypes of order sources along with their IDs.Read-onlyList Order Sources
Types of order sources along with their IDs. Order sources are grouped by their type that corresponds to a field order_source from the getOrders method. Returns sources with status SUCCESS, or status ERROR with error_code and error_message. Use the values to filter baselinker_orders_list. Calls the BaseLinker API method getOrderSources.
Inputs
parametersstring- getOrderSources takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_status_groups_listReturns the list of order status groups.Read-onlyList Order Status Groups
Returns the list of order status groups. Status groups are used to visually organize statuses in the panel sidebar. Returns status_groups with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderStatusGroups.
Inputs
parametersstring- getOrderStatusGroups takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_status_listReturns order statuses created by the user in the order manager.Read-onlyList Order Statuses
Returns order statuses created by the user in the order manager. Returns statuses with status SUCCESS, or status ERROR with error_code and error_message. Use the IDs with baselinker_order_status_set and baselinker_orders_list. Calls the BaseLinker API method getOrderStatusList.
Inputs
parametersstring- getOrderStatusList takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_order_transaction_getRetrieve transaction details for a selected order.Read-onlyGet Order Transaction Data
Retrieve transaction details for a selected order. Returns currency, fulfillment_shipments, fulfillment_center_id, ship_date_from, ship_date_to, delivery_date_from, delivery_date_to, marketplace_transaction_id, and more with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getOrderTransactionData.
Inputs
parametersstringrequired- Input parameters of getOrderTransactionData as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order Identifier from Base order manager | include_complex_taxes (bool): (optional, false by default) Whether to include detailed tax breakdown with order_lines structure. | include_amazon_data (bool): (optional, true by default) Whether to include legacy Amazon fulfillment data for backward compatibility. Example: {"order_id": 143477867, "include_complex_taxes": true, "include_amazon_data": false}
baselinker_orders_by_email_searchSearch for orders related to the given e-mail address.Read-onlySearch Orders by Email
Search for orders related to the given e-mail address. This function is designed to be used in plugins for mail clients (Thunderbird, Outlook, etc.). Returns orders with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_orders_list with order_id for full order data. Calls the BaseLinker API method getOrdersByEmail.
Inputs
parametersstringrequired- Input parameters of getOrdersByEmail as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: email (varchar(50)): The e-mail address we search for in orders. Example: {"email": "test@test.com"}
baselinker_orders_by_phone_searchSearch for orders related to the given phone number.Read-onlySearch Orders by Phone
Search for orders related to the given phone number. This function is intended for use in caller recognition programs. Returns orders with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_orders_list with order_id for full order data. Calls the BaseLinker API method getOrdersByPhone.
Inputs
parametersstringrequired- Input parameters of getOrdersByPhone as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: phone (varchar(50)): The phone number we search for in orders. Example: {"phone": "+48123456789"}
baselinker_orders_listDownload orders from a specific date from the Base order manager.Read-onlyList Orders
Download orders from a specific date from the Base order manager. The order list can be limited using the filters described in the method parameters. Returns orders with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_journal_list to poll for new order events. Use baselinker_orders_by_email_search or baselinker_orders_by_phone_search to find a buyer's orders. Calls the BaseLinker API method getOrders.
Inputs
parametersstring- Input parameters of getOrders as a JSON object encoded in a string. Every key is optional. Keys: order_id (int): (optional) Order identifier. Completing this field will download information about only one specific order. | date_confirmed_from (int): (optional) Date of order confirmation from which orders are to be collected. Format unix time stamp. | date_from (int): (optional) The order date from which orders are to be collected. Format unix time stamp. | id_from (int): (optional) The order ID number from which subsequent orders are to be collected. | get_unconfirmed_orders (bool): (optional, false by default) Download unconfirmed orders as well (this is e.g. an order from Allegro to which the customer has not yet completed the delivery form). Default is false. Unconfirmed orders may not be complete yet, the shipping method and price is also unknown. | status_id (int): (optional) The status identifier from which orders are to be collected. Leave blank to download orders from all statuses. | filter_email (varchar(50)): (optional) Filtering of order lists by e-mail address (displays only orders with the given e-mail address). | filter_order_source (varchar(20)): (optional) Filtering of order lists by order source, for instance "ebay", "amazon" (displays only orders come from given source). The list of order sources can be retrieved with getOrderSources method. | filter_order_source_id (int): (optional) Filtering of order lists by order source identifier, for instance "2523" (displays only orders come from order source defined in "filter_order_source" identified by given order source identifier). Filtering by order source indentifier requires "filter_order_source" to be set prior. The list of order source identifiers can be retrieved with getOrderSources method. | filter_shop_order_id (int): (optional) Shop Order identifier. Completing this field will download information about specific orders. | filter_external_order_id (varchar(50)): (optional) External order identifier. Allows filtering orders by the original order ID assigned by the marketplace or online store (e.g. Allegro transaction number, Amazon order number). This is the same value as the "external_order_id" field in the response. This filter should not be used together with filter_shop_order_id. | include_custom_extra_fields (bool): (optional, false by default) Download values of custom additional fields. | include_commissions (bool): (optional, false by default) Download orders with commissions information. If set to true, the response will contain additional "commissions" field. | include_connect_data (bool): (optional, false by default) Base Connect and contractor data. | include_discounts_data (bool): (optional, false by default) Download orders with discount log data. If set to true, the response will contain additional "discounts" field with a list of applied discounts. Example: {"date_confirmed_from": 1407341754, "get_unconfirmed_orders": false}default
{}
baselinker_package_details_getGet detailed information about a package.Read-onlyGet Package Details
Get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response. Returns package_details, additional_fields with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getPackageDetails.
Inputs
parametersstringrequired- Input parameters of getPackageDetails as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: package_id (int): Shipment ID Example: {"package_id": 7323859}
baselinker_packages_status_history_getRetrieve the history of the status list of the given shipments.Read-onlyGet Package Status History
Retrieve the history of the status list of the given shipments. Maximum 100 shipments at a time. Returns packages_history with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getCourierPackagesStatusHistory.
Inputs
parametersstringrequired- Input parameters of getCourierPackagesStatusHistory as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: package_ids (array): An array with a list of parcel IDs. Example: {"package_ids": [7323859]}
baselinker_price_groups_listRetrieve price groups existing in Base storage.Read-onlyList Price Groups
Retrieve price groups existing in Base storage. Returns price_groups with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryPriceGroups.
Inputs
parametersstring- getInventoryPriceGroups takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_product_logs_listRetrieve a list of events related to product change (or their variants) in the Base catalog.Read-onlyList Product Change Logs
Retrieve a list of events related to product change (or their variants) in the Base catalog. Returns logs with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryProductLogs.
Inputs
parametersstringrequired- Input parameters of getInventoryProductLogs as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: product_id (int): Product identifier. In case of retrieving logs for a variant, the variant identifier must be provided as the product identifier. | date_from (int): (optional) Date from which logs are to be retrieved. Unix time stamp format. | date_to (int): (optional) Date up to which logs are to be retrieved. Unix time stamp format. | log_type (int): (optional) List of event types you want to retrieve. Available values: 1 - Change in stock 2 - Price change 3 - Product creation 4 - Product deletion 5 - Text fields modifications 6 - Locations modifications 7 - Modifications of links 8 - Gallery modifications 9 - Variant modifications 10 - Modifications of bundle products | sort (varchar(4)): (optional) Type of log sorting. Possible "ASC" values (ascending from date), "DESC" (descending after the date). By default the sorting is done in ascending order. | page (int): (optional) Results paging (100 product editions per page). Example: {"product_id": 2685, "date_from": 1609459200, "log_type": [1, 2]}
baselinker_products_data_getRetrieve detailed data for selected products from the Base inventory.Read-onlyGet Catalog Products Data
Retrieve detailed data for selected products from the Base inventory. Returns products with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_products_list to find product IDs. Calls the BaseLinker API method getInventoryProductsData.
Inputs
parametersstringrequired- Input parameters of getInventoryProductsData 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 using the method getInventories. | products (array): An array of product ID numbers to download | include_erp_units (bool): (optional) Include ERP units in the response. Only available for inventories with purchase cost calculations system different than AVCO. | include_wms_units (bool): (optional) Include WMS units in the response. Only available for inventories with enabled advanced warehouse management system. | include_additional_eans (bool): (optional) Include additional EANs in response. User can set additional EANs for product, to work with products cases (4-pack etc.) or different regional codes for the same product. | include_suppliers (bool): (optional) Include suppliers data in the response. | include_relations (bool): (optional) Include product relationships in the response (related, substitution, upsell, downsell, crosssell). | include_marketplace_categories (bool): (optional) Include marketplace category assignments in the text_fields output. When set to true, the response will include marketplace_category_id|[source_id] entries showing the marketplace category set for each integration channel. | include_shipping_templates (bool): (optional) Include shipping template assignments per integration channel in the response. When set to true, each product in the response will include a shipping_template field containing the assigned shipping template IDs per channel. Template IDs can be resolved to names using the getInventoryShippingTemplates method. | include_channels_media (bool): (optional) Include channel-specific media in the response. When true, the 'images' and 'videos' objects additionally contain keys with the format "[position]|[source_id]" for channel overrides (e.g. "3|amazon_0", "3|allegro_123"; an empty string value means the channel blanks the inherited media at that position) and a top-level 'media_options' object is returned describing how each channel resolves its media gallery (0 - use default, 1 - separate, 2 - overwrite). Example: {"inventory_id": 307, "products": [2685], "include_relations": true, "include_marketplace_categories": true, "include_shipping_templates": true, "include_channels_media": true}
baselinker_products_listRetrieve a basic data of chosen products from Base catalogs.Read-onlyList Catalog Products
Retrieve a basic data of chosen products from Base catalogs. Returns products with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_products_data_get for full product details. Calls the BaseLinker API method getInventoryProductsList.
Inputs
parametersstringrequired- Input parameters of getInventoryProductsList 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 using the method getInventories. | filter_id (int): (optional) limiting results to a specific product id | filter_category_id (int): (optional) Retrieving products from a specific category (optional) | filter_tag (int): (optional) limits results to products assigned to the specified inventory tag ID. The list of tag IDs can be retrieved using getInventoryTags. | filter_ean (varchar(32)): (optional) limiting results to a specific ean (including additional product EANs) | filter_sku (varchar(50)): (optional) limiting the results to a specific SKU (stock keeping number) | filter_name (varchar(200)): (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_stock_from (int): (optional) minimum quantity limit | filter_stock_to (int): (optional) maximum quantity limit | page (int): (optional) Results paging (1000 products per page for Base warehouse) | filter_sort (varchar(30)): (optional) the value for sorting the product list. Possible values: "id [ASC|DESC]" | filter_locations (varchar(20)): (optional) filtering results by location name | include_variants (bool): (optional) Include product variants additonally to products Example: {"inventory_id": 307, "filter_id": 2685}
baselinker_products_prices_getRetrieve the gross prices of products from Base inventories.Read-onlyGet Product Prices
Retrieve the gross prices of products from Base inventories. Returns products with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_products_prices_update to change prices. Calls the BaseLinker API method getInventoryProductsPrices.
Inputs
parametersstringrequired- Input parameters of getInventoryProductsPrices 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 using the method getInventories. | page (int): (optional) Results paging (1000 products per page for Base warehouse) Example: {"inventory_id": 307}
baselinker_products_stock_getRetrieve stock and reservations data of products from Base catalogs, optionally narrowed down with product filters.Read-onlyGet Product Stock
Retrieve stock and reservations data of products from Base catalogs, optionally narrowed down with product filters. Returns products with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_products_stock_update to change stock. Calls the BaseLinker API method getInventoryProductsStock.
Inputs
parametersstringrequired- Input parameters of getInventoryProductsStock 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 using the method getInventories. | filter_id (int): (optional) limits results to a specific product ID | filter_category_id (int): (optional) limits results to products from a specific category | filter_ean (varchar(32)): (optional) limits results to a specific EAN (including additional product EANs) | filter_sku (varchar(50)): (optional) limits results to a specific SKU (stock keeping unit) | filter_name (varchar(200)): (optional) product name filter (part of the searched name or an empty field) | filter_asin (varchar(50)): (optional) limits results to a specific ASIN | filter_stock_from (int): (optional) minimum stock quantity | filter_stock_to (int): (optional) maximum stock quantity | page (int): (optional) Results paging (1000 products per page for Base warehouse) | filter_sort (varchar(30)): (optional) sorts the returned products. Possible values: "id [ASC|DESC]". | filter_locations (varchar(20)): (optional) filters results by location name Example: {"inventory_id": 307, "filter_id": 2685}
baselinker_purchase_orders_listRetrieve a list of purchase orders from Base storage.Read-onlyList Purchase Orders
Retrieve a list of purchase orders from Base storage. Returns purchase_orders with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryPurchaseOrders.
Inputs
parametersstring- Input parameters of getInventoryPurchaseOrders as a JSON object encoded in a string. Every key is optional. Keys: warehouse_id (int): (optional) Warehouse ID. The list of identifiers can be retrieved using the method getInventoryWarehouses. | supplier_id (int): (optional) Limiting results to a specific supplier ID | series_id (int): (optional) Limiting results to a specific document series ID | date_from (int): (optional) Date from which documents should be retrieved (Unix timestamp) | date_to (int): (optional) Date up to which documents should be retrieved (Unix timestamp) | filter_document_number (varchar(50)): (optional) Filtering by document number (full or partial match) | filter_product_id (int): (optional) Limiting results to purchase orders containing a product with the given ID | page (int): (optional) Results paging (100 documents per page) Example: {"date_from": 1609459200, "date_to": 1640995199, "page": 1}default
{}
baselinker_receipts_listRetrieve issued receipts.Read-onlyList Receipts
Retrieve issued receipts. Max 100 receipts are returned at a time. Returns receipts with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getReceipts.
Inputs
parametersstring- Input parameters of getReceipts as a JSON object encoded in a string. Every key is optional. Keys: series_id (int): (optional) The numbering series ID allows filtering by the receipt numbering series. | id_from (int): (optional) The ID of the receipt from which subsequent receipts will be retrieved (inclusive). | date_from (int): (optional) Date from which receipts are to be collected. Unix timestamp format. | date_to (int): (optional) Date to which receipts are to be collected. Unix timestamp format. Example: {"series_id": 0, "id_from": 1}default
{}
baselinker_series_listDownload a series of invoice/receipt numbering.Read-onlyList Numbering Series
Download a series of invoice/receipt numbering. Returns series with status SUCCESS, or status ERROR with error_code and error_message. Use the IDs with baselinker_invoice_add. Calls the BaseLinker API method getSeries.
Inputs
parametersstring- getSeries takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_suppliers_listRetrieve a list of suppliers available in BaseLinker storage.Read-onlyList Suppliers
Retrieve a list of suppliers available in BaseLinker storage. Returns suppliers with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventorySuppliers.
Inputs
parametersstring- Input parameters of getInventorySuppliers as a JSON object encoded in a string. Every key is optional. Keys: filter_id (int): (optional) Limiting results to a specific supplier ID | filter_name (varchar(40)): (optional) Filtering by supplier name (full or partial match) Example: {"filter_id": 1, "filter_name": "Example Supplier"}default
{}
baselinker_warehouses_listRetrieve a list of warehouses available in Base inventories.Read-onlyList Warehouses
Retrieve a list of warehouses available in Base inventories. The method also returns information about the warehouses created automatically for the purpose of keeping external stocks (shops, wholesalers etc.). Returns warehouses with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method getInventoryWarehouses.
Inputs
parametersstring- getInventoryWarehouses takes no parameters; leave this empty or send {}. Example: {}default
{}
baselinker_category_addAdd a category to the Base catalog.WriteAdd or Update Category
Add a category to the Base catalog. Adding a category with the same identifier again, updates the previously saved category. Returns category_id with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method addInventoryCategory.
Inputs
parametersstringrequired- Input parameters of addInventoryCategory 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 add a category available for all catalogs created in Base, this field should be omitted. | category_id (int): The category identifier to be provided for updates. Should be left blank when creating a new category. | name (varchar(200)): Category name. The name must be unique among categories with the same parent category within the same inventory. | parent_id (int): The parent category identifier obtained previously at the output of the addCategory method. Categories should be added starting from the hierarchy root so that the child is always added after the parent (you need to know the parent ID to add the child). For the top level category, 0 should be given as parent_id. Example: {"name": "Textiles", "parent_id": 5}
baselinker_crm_client_addAdd a new CRM client.WriteAdd CRM Client
Add a new CRM client. Adding a client with the same crm_client_id again will update the previously saved client (only the provided fields will be changed). Returns crm_client_id with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method addCrmClient.
Inputs
parametersstringrequired- Input parameters of addCrmClient 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): CRM client ID. If provided and greater than 0, the existing client will be updated. If 0 or omitted, a new client will be created. | status_id (int): CRM client status ID. | star (int): Star type. Values from 0 to 5. 0 means no star. | contractor_id (int): Base Connect contractor ID associated with the client (the list can be retrieved with getConnectIntegrationContractors method). | login (varchar(156)): Client login name. | phone (varchar(156)): Client phone number. | email (varchar(220)): Client email address. | notes (text): Client notes. | invoice_company (varchar(500)): Invoice company name. | invoice_fullname (varchar(500)): Invoice full name. | invoice_address (varchar(500)): Invoice address. | invoice_postcode (varchar(20)): Invoice postcode. | invoice_city (varchar(100)): Invoice city. | invoice_state (varchar(35)): Invoice state/province. | invoice_country_code (varchar(2)): Invoice country code (ISO 3166-1 alpha-2). | invoice_tax_id (varchar(50)): Invoice tax ID (NIP). Whitespace and dashes are automatically removed. | delivery_company (varchar(500)): Delivery company name. | delivery_fullname (varchar(500)): Delivery full name. | delivery_address (varchar(500)): Delivery address. | delivery_postcode (varchar(20)): Delivery postcode. | delivery_city (varchar(100)): Delivery city. | delivery_state (varchar(35)): Delivery state/province. | delivery_country_code (varchar(2)): Delivery country code (ISO 3166-1 alpha-2). | custom_extra_fields (array): A list containing CRM client custom extra fields, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getCrmClientExtraFields method. In case of removing a field the empty string is expected. In case of file the following format is expected: { "title": "file.pdf" (varchar(40) - the file name) "file": "data:4AAQSkZJRgABA[...]" (base64 - the file body limited to 2MB) } Example: {"invoice_company": "Example Company Ltd.", "invoice_tax_id": "123-456-78-90", "email": "contact@example.com", "phone": "+48123456789", "custom_extra_fields": {"135": "B2B", "149": "1646913115", "196": {"title": "agreement.pdf", "file": "data:JVBERi0xLjQKJ[...]"}}}
baselinker_invoice_addIssue an order invoice.WriteIssue Invoice
Issue an order invoice. Returns invoice_id with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_series_list for the numbering series ID. Calls the BaseLinker API method addInvoice.
Inputs
parametersstringrequired- Input parameters of addInvoice as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order Identifier from Base order manager | series_id (int): Series numbering identifier | vat_rate (text): (optional) VAT rate - parameter accepts values: - "DEFAULT": according to the numbering series (is set as default value) - "ITEM": use the rate assigned to the item of the order - "EXPT" / "ZW": exempt from VAT - "NP": annotation NP - "OO": VAT reverse charge - value: number from range 0-100 Example: {"order_id": 4553562, "series_id": 1}
baselinker_order_addThe method allows adding a new order to the Base order manager.WriteAdd Order
The method allows adding a new order to the Base order manager. Returns order_id with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_status_list for status IDs and baselinker_order_extra_fields_list for custom field IDs. Calls the BaseLinker API method addOrder.
Inputs
parametersstringrequired- Input parameters of addOrder as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_status_id (int): Order status (the list available to retrieve with getOrderStatusList) | custom_source_id (int): (optional) Identifier of custom order source defined in Base panel. If not provided, default order source is assigned. | date_add (int): Date of order creation (in unix time format) | currency (char(3)): 3-letter currency symbol (e.g. EUR, PLN) | payment_method (varchar(30)): Payment method | payment_method_cod (bool): Flag indicating whether the type of payment is COD (cash on delivery) | paid (bool): Information whether the order is already paid. The value "1" automatically adds a full payment to the order. | user_comments (varchar(510)): Buyer comments | admin_comments (varchar(200)): Seller comments | email (varchar(150)): Buyer e-mail address | phone (varchar(100)): Buyer phone number | user_login (varchar(30)): Allegro or eBay user login | delivery_method (varchar(30)): Delivery method name | delivery_price (float): Gross delivery price | delivery_fullname (varchar(156)): Delivery address - name and surname | delivery_company (varchar(156)): Delivery address - company | delivery_address (varchar(156)): Delivery address - street and number | delivery_postcode (varchar(100)): Delivery address - postcode | delivery_city (varchar(100)): Delivery address - city | delivery_state (varchar(35)): Delivery address - state/province | delivery_country_code (char(2)): Delivery address - country code (two-letter, e.g. EN) | delivery_point_id (varchar(40)): Pick-up point delivery - pick-up point identifier | delivery_point_name (varchar(100)): Pick-up point delivery - pick-up point name | delivery_point_address (varchar(100)): Pick-up point delivery - pick-up point address | delivery_point_postcode (varchar(100)): Pick-up point delivery - pick-up point postcode | delivery_point_city (varchar(100)): Pick-up point delivery - pick-up point city | invoice_fullname (varchar(500)): Billing details - name and surname | invoice_company (varchar(500)): Billing details - company | invoice_nip (varchar(100)): Billing details - Vat Reg. no./tax number | invoice_address (varchar(500)): Billing details - street and house number | invoice_postcode (varchar(20)): Billing details - postcode | invoice_city (varchar(100)): Billing details - city | invoice_state (varchar(35)): Billing details - state/province | invoice_country_code (char(2)): Billing details - country code (two-letter, e.g. EN) | want_invoice (bool): Flag indicating whether the customer wants an invoice (1 - yes, 0 - no) | extra_field_1 (varchar(50)): Value of the "additional field 1". - the seller can store any information there | extra_field_2 (varchar(50)): Value of the "additional field 2". - the seller can store any information there | custom_extra_fields (array): A list containing order custom extra fields, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getOrderExtraFields method. In case of removing a field the empty string is expected. In case of file the following format is expected: { "title": "file.pdf" (varchar(40) - the file name) "file": "data:4AAQSkZJRgABA[...]" (base64 - the file body limited to 2MB) } | products (array): Order product array. Each element of the array is also an array containing fields: storage (varchar) - type of warehouse from which the product comes (available values: "db" - Base internal inventory, "shop" - the online store warehouse, "warehouse" - a connected wholesaler). storage_id (int) - the identifier of the warehouse from which the product comes (one of the shops connected to the account). Value Example: {"order_status_id": 6624, "date_add": 1774597845, "user_comments": "User comment", "admin_comments": "Seller test comments", "phone": "693123123", "email": "test@test.com", "user_login": "nick1", "currency": "GBP", "payment_method": "PayPal", "payment_method_cod": "0", "paid": "1", "delivery_method": "Expedited shipping", "delivery_price": 10, "delivery_fullname": "John Doe", "delivery_company": "Company", "delivery_address": "Long Str 12", "delivery_city": "London", "delivery_state": "", "delivery_postcode": "E2 8HQ", "delivery_country_code": "GB", "delivery_point_id": "", "delivery_point_name": "", "delivery_point_address": "", "delivery_point_postcode": "", "delivery_point_city": "", "invoice_fullname": "John Doe", "invoice_company": "Company", "invoice_nip": "GB8943245", "invoice_address": "Long Str 12", "invoice_city": "London", "invoice_state": "", "invoice_postcode": "E2 8HQ", "invoice_country_code": "GB", "want_invoice": 0, "extra_field_1": "field test 1", "extra_field_2": "", "custom_extra_fields": {"135": "B2B", "172": "1646913115"}, "products": [{"storage": "db", "storage_id": 0, "product_id": "5434", "variant_id": 52124, "location": "A1-13-7", "name": "Harry Potter and the Chamber of Secrets", "sku": "LU4235", "ean": "1597368451236", "price_brutto": 20, "tax_rate": 23, "quantity": 2, "weight": 1}]}
baselinker_order_fields_setEdit selected fields (e.g.WriteUpdate Order Fields
Edit selected fields (e.g. address data, notes, etc.) of a specific order. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_status_set to change only the status. Calls the BaseLinker API method setOrderFields.
- Idempotent
Inputs
parametersstringrequired- Input parameters of setOrderFields as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order identifier from the Base order manager. Field required. Other fields are optional. | currency (char(3)): Order currency code | admin_comments (varchar(200)): Seller comments | user_comments (varchar(510)): Buyer comments | payment_method (varchar(30)): Payment method | payment_method_cod (bool): Flag indicating whether the type of payment is COD (cash on delivery) | email (varchar(150)): Buyer e-mail address | phone (varchar(100)): Buyer phone number | user_login (varchar(30)): Buyer login | delivery_method (varchar(30)): Delivery method name | delivery_price (float): Gross delivery price | delivery_fullname (varchar(156)): Delivery address - name and surname | delivery_company (varchar(156)): Delivery address - company | delivery_address (varchar(156)): Delivery address - street and number | delivery_postcode (varchar(100)): Delivery address - postcode | delivery_city (varchar(100)): Delivery address - city | delivery_state (varchar(35)): Delivery address - state/province | delivery_country_code (char(2)): Delivery address - country code (two-letter, e.g. EN) | delivery_point_id (varchar(40)): Pick-up point delivery - pick-up point identifier | delivery_point_name (varchar(100)): Pick-up point delivery - pick-up point name | delivery_point_address (varchar(100)): Pick-up point delivery - pick-up point address | delivery_point_postcode (varchar(100)): Pick-up point delivery - pick-up point postcode | delivery_point_city (varchar(100)): Pick-up point delivery - pick-up point city | invoice_fullname (varchar(500)): Billing details - name and surname | invoice_company (varchar(500)): Billing details - company | invoice_nip (varchar(100)): Billing details - Vat Reg. no./tax number | invoice_address (varchar(500)): Billing details - street and house number | invoice_postcode (varchar(20)): Billing details - postcode | invoice_city (varchar(100)): Billing details - city | invoice_state (varchar(35)): Billing details - state/province | invoice_country_code (char(2)): Billing details - country code (two-letter, e.g. EN) | want_invoice (bool): Flag indicating whether the customer wants an invoice (1 - yes, 0 - no) | extra_field_1 (varchar(50)): Value of the "extra field 1" - the seller can store any information there | extra_field_2 (varchar(50)): Value of the "extra field 2" - the seller can store any information there | custom_extra_fields (array): A list containing order custom extra fields, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getOrderExtraFields method. In case of removing a field the empty string is expected. In case of file the following format is expected: { "title": "file.pdf" (varchar(40) - the file name) "file": "data:4AAQSkZJRgABA[...]" (base64 - the file body limited to 2MB) } | pick_state (int): Flag indicating the status of the order products collection (1 - all products have been collected, 0 - not all products have been collected) | pack_state (int): Flag indicating the status of the order products packing (1 - all products have been packed, 0 - not all products have been packed) | star (int): Order star type. Values from 0 to 5. 0 means no star. Example: {"order_id": 3754894, "currency": "EUR", "admin_comments": "New seller comments", "delivery_method": "New delivery method name"}
baselinker_order_payment_setAdd a payment to the order.WriteAdd Order Payment
Add a payment to the order. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_payments_history_get to read past payments. Calls the BaseLinker API method setOrderPayment.
- Idempotent
Inputs
parametersstringrequired- Input parameters of setOrderPayment as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order ID number | payment_done (float): The amount of the payment. The value changes the current payment in the order (not added to the previous value). If the amount matches the order value, the order will be marked as paid. | payment_date (int): Payment date unixtime. | payment_comment (varchar(30)): Payments commentary. | external_payment_id (varchar(30)): (optional) External payment identifier Example: {"order_id": 3754894, "payment_done": 120.57, "payment_date": 1444736731, "payment_comment": "bank transfer mBank 12.10.2015"}
baselinker_order_product_addAdd a new product to your order.WriteAdd Product to Order
Add a new product to your order. Returns order_product_id with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_product_fields_set to change an existing item. Calls the BaseLinker API method addOrderProduct.
Inputs
parametersstringrequired- Input parameters of addOrderProduct as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order Identifier from Base order manager | storage (varchar(9)): Type of product source storage (available values: "db" - Base internal inventory, "shop" - online shop storage, "warehouse" - the connected wholesaler) | storage_id (varchar(50)): The identifier of the storage (inventory/shop/warehouse) from which the product comes. | product_id (varchar(50)): Product identifier in Base or shop storage. Blank if the product number is not known | variant_id (varchar(30)): Product variant ID. Blank if the variant number is unknown | auction_id (varchar(20)): Listing ID number (if the order comes from ebay/allegro) | name (varchar(200)): Product name | sku (varchar(50)): Product SKU number | ean (varchar(32)): Product EAN number | location (varchar(50)): Product location. To assign multiple locations, separate them with a semicolon. | warehouse_id (int): Internal warehouse ID from getInventoryWarehouses (internal_warehouse_id). Only applies to Base inventory products. Omit it to inherit an existing compatible source or the order-source default; pass 0 to leave no concrete warehouse selected. | attributes (varchar(350)): The detailed product attributes, e.g. "Colour: blue" (Variant name) | price_brutto (float): Single item gross price | tax_rate (float): VAT tax rate e.g. "23", (value from range 0-100, EXCEPTION values: "-1" for "EXPT"/"ZW" exempt from VAT, "-0.02" for "NP" annotation, "-0.03" for "OO" VAT reverse charge) | quantity (int): Number of pieces | weight (decimal(10,2)): Single piece weight Example: {"order_id": 3754894, "storage": "db", "storage_id": 0, "product_id": "5434", "variant_id": 52124, "name": "Harry Potter and the Chamber of Secrets", "sku": "LU4235", "ean": "1597368451236", "location": "A1-13-7", "attributes": "colour red", "price_brutto": 20, "tax_rate": 23, "quantity": 2, "weight": 1}
baselinker_order_product_fields_setEdit the data of selected items (e.g.WriteUpdate Order Product
Edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_orders_list with order_id to get order_product_id values. Calls the BaseLinker API method setOrderProductFields.
- Idempotent
Inputs
parametersstringrequired- Input parameters of setOrderProductFields as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order identifier from the Base order manager. Field required. | order_product_id (int): Order item ID from Base order manager. Field required. | storage (varchar(9)): Type of product source storage (available values: "db" - Base internal inventory, "shop" - online shop storage, "warehouse" - the connected wholesaler) | storage_id (varchar(50)): The identifier of the storage (inventory/shop/warehouse) from which the product comes. | product_id (varchar(50)): Product identifier in Base or shop storage. Blank if the product number is not known | variant_id (varchar(30)): Product variant ID. Blank if the variant number is unknown | auction_id (varchar(20)): Listing ID number (if the order comes from ebay/allegro) | name (varchar(200)): Product name | sku (varchar(50)): Product SKU number | ean (varchar(32)): Product EAN number | location (varchar(50)): Product location | warehouse_id (int): Internal warehouse ID from getInventoryWarehouses (internal_warehouse_id). Only applies to Base inventory products. Pass 0 to leave no concrete warehouse selected. | attributes (varchar(350)): The detailed product attributes, e.g. "Colour: blue" (Variant name) | price_brutto (float): Single item gross price | tax_rate (float): VAT tax rate e.g. "23", (value from range 0-100, EXCEPTION values: "-1" for "EXPT"/"ZW" exempt from VAT, "-0.02" for "NP" annotation, "-0.03" for "OO" VAT reverse charge) | quantity (int): Number of pieces | weight (float): Single piece weight Example: {"order_id": 3754894, "order_product_id": 59157160, "attributes": "new product attribute", "quantity": 5}
baselinker_order_return_addThe method allows adding a new order return to Base.WriteAdd Order Return
The method allows adding a new order return to Base. Returns return_id with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_return_reasons_list for reason IDs. Calls the BaseLinker API method addOrderReturn.
Inputs
parametersstringrequired- Input parameters of addOrderReturn as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): (optional) Order ID in Base panel | status_id (int): Order return status (the list available to retrieve with getOrderReturnStatusList) | custom_source_id (int): (optional) Identifier of custom order source defined in Base panel. If not provided, default order return source is assigned. | reference_number (varchar(100)): (optional) Reference number from external source. | date_add (int): Date of order return creation (in unix time format) | currency (char(3)): 3-letter currency symbol (e.g. EUR, PLN) | refunded (bool): Information whether the order return is already refunded. The value "1" automatically marks order return as refunded. | admin_comments (varchar(200)): Seller comments | email (varchar(150)): Buyer e-mail address | phone (varchar(100)): Buyer phone number | user_login (varchar(30)): Marketplace user login | delivery_price (float): Gross delivery price | delivery_fullname (varchar(100)): Delivery address - name and surname | delivery_company (varchar(100)): Delivery address - company | delivery_address (varchar(100)): Delivery address - street and number | delivery_postcode (varchar(100)): Delivery address - postcode | delivery_city (varchar(100)): Delivery address - city | delivery_state (varchar(20)): Delivery address - state/province | delivery_country_code (char(2)): Delivery address - country code (two-letter, e.g. EN) | extra_field_1 (varchar(50)): Value of the "additional field 1" | extra_field_2 (varchar(50)): Value of the "additional field 2" | custom_extra_fields (array): A list containing order return custom extra fields, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getOrderReturnExtraFields method. In case of removing a field the empty string is expected. In case of file the following format is expected: { "title": "file.pdf" (varchar(40) - the file name) "file": "data:4AAQSkZJRgABA[...]" (binary - the file body limited to 2MB) } | products (array): Return product array. Each element of the array is also an array containing fields: order_product_id (int) - (optional) ID of connected order item from Base order manager storage (varchar) - type of warehouse from which the product comes (available values: "db" - Base internal inventory, "shop" - the online store warehouse, "warehouse" - a connected wholesaler). storage_id (int) - the identifier of the warehouse from which the product comes (one of the shops connected to the account). Value "0" for a product from the Base internal inventory. product_id (varchar) - Product identifier in Base or store warehouse. Blank if the product number is unknown variant_id (int) - Product variant ID. Blank if the variant number is unknown name (varchar) - Product name sku (varchar) - Product sku ean (varchar) - Product ean location (varchar) - Product location warehouse_id (int) - Product source warehouse identifier. Only applies to products from Base inventory. By default warehouse_id is determined based on the source of the order. attributes (varchar) - Specific product attributes (e.g. "Color: blue") price_brutto (float) - Single item gross price tax_rate (float) - VAT tax rate e.g. "23", (value from range 0-100, EXCEPTION values: "-1" for "EXPT"/"ZW" exempt from VAT, "-0.02" for "NP" annotation, "-0.03" for "OO" VAT reverse charge) quantity (int) - Quantity of pieces weight (float) - Single item weight status_id (int) - Identifier of return item status. If omitted, the user's default return-item status is used return_reason_id (int) - Identifier of return reason | refund_account_number (varchar(50)): Bank acco Example: {"status_id": 1009, "date_add": 1794849820, "currency": "GBP", "refunded": 0, "admin_comments": "Seller test comments", "email": "test@test.com", "phone": "693123123", "user_login": "nick1", "delivery_price": 10, "delivery_fullname": "John Doe", "delivery_company": "Company", "delivery_address": "Long Str 12", "delivery_postcode": "E2 8HQ", "delivery_city": "London", "delivery_state": "", "delivery_country_code": "GB", "extra_field_1": "field test 1", "extra_field_2": "", "custom_extra_fields": {"125": "888579", "126": "return info"}, "products": [{"order_product_id": 59157160, "storage": "db", "storage_id": 0, "product_id": "5434", "variant_id": 52124, "name": "Harry Potter and the Chamber of Secrets", "sku": "LU4235", "ean": "1597368451236", "location": "A1-13-7", "price_brutto": 20, "tax_rate": 23, "quantity": 2, "weight": 1, "status_id": 1003, "return_reason_id": 1006}], "refund_account_number": "12345678901234567890123456", "refund_iban": "PL61109010140000071219812874", "refund_swift": "WBKPPLPP"}
baselinker_order_return_status_setChange order return status.WriteSet Order Return Status
Change order return status. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_return_status_list for status IDs. Calls the BaseLinker API method setOrderReturnStatus.
- Idempotent
Inputs
parametersstringrequired- Input parameters of setOrderReturnStatus as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: return_id (int): Order return ID number. | status_id (int): Status ID number. The status list can be retrieved using getOrderReturnStatusList. Example: {"return_id": 1102, "status_id": 10224}
baselinker_order_status_setChange order status.WriteSet Order Status
Change order status. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_order_status_list for status IDs. Calls the BaseLinker API method setOrderStatus.
- Idempotent
Inputs
parametersstringrequired- Input parameters of setOrderStatus as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order ID number. | status_id (int): Status ID number. The status list can be retrieved using getOrderStatusList. Example: {"order_id": 3754894, "status_id": 34562}
baselinker_package_manual_createEnter the shipping number and the name of the courier to the order (function used only to add shipments created outside Base).WriteAdd Shipment Number
Enter the shipping number and the name of the courier to the order (function used only to add shipments created outside Base). Returns package_id, package_number with status SUCCESS, or status ERROR with error_code and error_message. Use it for shipments created outside BaseLinker. Calls the BaseLinker API method createPackageManual.
Inputs
parametersstringrequired- Input parameters of createPackageManual as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order identifier | courier_code (varchar(20)): Courier code (courier code retrieved with getCouriersList or custom courier name) | package_number (varchar(40)): Shipping number (consignment number) | pickup_date (int): Date of dispatch (unix time format) | return_shipment (bool): (optional, false by default) Marks package as return shipment Example: {"order_id": 6910995, "courier_code": "dhl", "package_number": "622222044730624327700197", "pickup_date": 1487006161, "return_shipment": true}
baselinker_product_addAdd a new product to Base catalog.WriteAdd or Update Product
Add a new product to Base catalog. Entering the product with the ID updates previously saved product. Returns product_id, warnings with status SUCCESS, or status ERROR with error_code and error_message. Pass product_id to update an existing product instead of adding one. Calls the BaseLinker API method addInventoryProduct.
Inputs
parametersstringrequired- Input parameters of addInventoryProduct 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 using the method getInventories. (inventory_id field). | product_id (int): Main product identifier, given only during the update. Should be left blank when creating a new product. The new product identifier is returned as a response to this method. | parent_id (int): Product parent ID. To be provided only if the added/edited product is a variant of another product. | is_bundle (bool): Is the given product a part of a bundle | sku (varchar(50)): Product SKU number. | ean (varchar(32)): Product EAN number. | ean_additional (array): A list containing EAN numbers. Each EAN data should be an array containing the fields listed below:ean (string) - EAN numberquantity (int) - quantity of product with given EAN number | asin (varchar(50)): Product ASIN number. | tags (array): A list containing tag names. If:No tags are provided in the API request, the product retains its existing tags (e.g., A, B, C).Tags A, B, and C are provided in the API request, the product retains its existing tags (A, B, C).Tags B and C are provided in the API request, tag A is removed from the product, leaving tags B and C.An empty list of tags is provided in the API request, all existing tags (A, B, C) are removed from the product. | tax_rate (float): VAT tax rate e.g. "23", (value from range 0-100, EXCEPTION values: "-1" for "EXPT"/"ZW" exempt from VAT, "-0.02" for "NP" annotation, "-0.03" for "OO" VAT reverse charge) | weight (decimal(10,2)): Weight in kilograms. | height (decimal(10,2)): Product height | width (decimal(10,2)): Product width | length (decimal(10,2)): Product length | average_cost (decimal(10,2)): Product average cost. If storage documents are turned off, this field sets product average cost. If storage documents are turned on, a value in this field can be set in two cases: while creating a new product or when a current average cost is set to 0. | star (int): Product star type. It takes from 0 to 5 values. 0 means no starring. | manufacturer_id (int): Product manufacturer ID. IDs can be retrieved with getInventoryManufacturers method. | category_id (int): Product category ID (category must be previously created with addInventoryCategory method). | prices (array): A list containing product prices, where the key is the price group ID and value is a product gross price for a given price group. The list of price groups can be retrieved with getInventoryPriceGroups method. | stock (array): A list containing product stocks, where the key is the warehouse ID and value is a product stock for a given warehouse. Warehouse ID should have the following format: "bl_[id:int]" (eg. "bl_123"). The list of warehouse IDs can be retrieved with getInventoryWarehouses method. Stocks cannot be assigned to the warehouses created automatically for purposes of keeping external stocks (shops, wholesalers, etc.). | thresholds (array): A list containing product stock thresholds (reorder points), where the key is the warehouse ID and value is a threshold for a given warehouse. Warehouse ID should have the following format: "bl_[id:int]" (eg. "bl_123"). The list of warehouse IDs can be retrieved with getInventoryWarehouses method. Thresholds cannot be assigned to the warehouses created automatically for purposes of keeping external stocks (shops, wholesalers, etc.). Only supplied entries are changed. An empty map makes no change. Value 0 clears the threshold. | locations (array): A list containing product locations where the key is the warehouse ID and value is a product location for a given warehouse, eg. "A-5-2". Warehouse ID should have the follow Example: {"inventory_id": 307, "product_id": 2685, "is_bundle": false, "sku": "EPL-432", "ean": "983628103943", "ean_additional": [{"ean": "983628103944", "quantity": 4}, {"ean": "983628103945", "quantity": 8}], "asin": "B07EXAMPLE1", "tags": ["Summer", "Winter"], "tax_rate": 23, "weight": 0.25, "height": 0.3, "width": 0.2, "length": 0.05, "average_cost": 120.98, "star": 2, "manufacturer_id": 5, "category_id": 3, "prices": {"105": 20.99, "106": 23.99}, "stock": {"bl_206": 5, "bl_207": 7}, "thresholds": {"bl_206": 10, "bl_207": 5}, "locations": {"bl_206": "A-5-2", "bl_207": "B-1-5"}, "text_fields": {"name": "Harry Potter and the Chamber of Secrets", "description": "Basic book description", "description_extra1": "Additional description, e.g. of the entire product category", "description_extra2": "Second additional description - e.g. IMG tags with photos from an external server", "features": {"Cover": "Hardcover", "Pages": "300", "Language": "English"}, "name|de": "Harry Potter und die Kammer des Schreckens", "marketplace_category_id|allegro_123": "258033", "marketplace_category_id|amazon_0|us": "B08XYZ", "marketplace_category_id|ebay_456|us": "123456"}, "images": {"0": "url:https://example.com/image.jpg", "3": "url:https://example.com/image2.jpg", "5": "url:https://example.com/image34.jpg", "0|amazon_0": "url:https://example.com/amazon.jpg", "3|allegro_123": "", "ai_generated": {"0": 1, "3": 0}}, "videos": {"0": "url:https://example.com/product_video.mp4", "2": "url:https://example.com/product_video2.mp4", "0|amazon_0": "url:https://example.com/amazon_product_video.mp4", "2|allegro_123": "", "ai_generated": [1]}, "media_options": {"amazon_0": 1, "allegro_123": 2}, "links": {"shop_23": {"product_id": 8, "variant_id": 3}}, "suppliers": [{"id": 10, "product_code": "SUP-EPL-432", "cost": 15.5}], "relations": [{"product_id": 2690, "relation_type": "related"}, {"product_id": 2691, "relation_type": "upsell"}, {"product_id": 2692, "relation_type": "crosssell"}], "shipping_template": {"allegro_123": "456", "ebay_456|us": "112", "amazon_0|de": "78"}}
baselinker_products_prices_updateThe method allows bulk update of gross prices of products (and/or their variants) in the Base catalog.WriteUpdate Product Prices
The method allows bulk update of gross prices of products (and/or their variants) in the Base catalog. Maximum 1000 products at a time. Returns counter, warnings with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_price_groups_list for price group IDs. Calls the BaseLinker API method updateInventoryProductsPrices.
- Idempotent
Inputs
parametersstringrequired- Input parameters of updateInventoryProductsPrices 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 using the method getInventories. | products (array): An array of products, where the key is a product ID and the value is a list of prices. When determining the variant price, provide variant ID as a product ID. In the prices array the key should be the price group ID and the value - price for that price group. The list of price groups can be retrieved using the getInventoryPriceGroups method. Example: {"inventory_id": 307, "products": {"2685": {"105": 21.99, "106": 24.99}, "2687": {"105": 21.99, "106": 23.99}}}
baselinker_products_stock_updateUpdate stocks of products (and/or their variants) in Base catalog.WriteUpdate Product Stock
Update stocks of products (and/or their variants) in Base catalog. Maximum 1000 products at a time. Returns counter, warnings with status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_warehouses_list for warehouse IDs. Calls the BaseLinker API method updateInventoryProductsStock.
- Idempotent
Inputs
parametersstringrequired- Input parameters of updateInventoryProductsStock 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 using the method getInventories. | products (array): An array of products, where the key is a product ID and the value is a list of stocks. When determining the variant stock, provide variant ID as a product ID. In the stocks array the key should be the warehouse ID and the value - stock for that warehouse. The format of the warehouse identifier should be as follows: "[type:bl|shop|warehouse]_[id:int]". (e.g. "bl_123"). The list of warehouse identifiers can be retrieved using the getInventoryWarehouses method. Stocks cannot be assigned to the warehouses created automatically for purposes of keeping external stocks (shops, wholesalers, etc.). Example: {"inventory_id": 307, "products": {"2685": {"bl_206": 5, "bl_207": 7}, "2687": {"bl_206": 2, "bl_207": 4}}}
baselinker_order_product_deleteRemove a specific product from the order.DestructiveRemove Product from Order
Remove a specific product from the order. Returns status SUCCESS, or status ERROR with error_code and error_message. Use baselinker_orders_list with order_id to get order_product_id values. Calls the BaseLinker API method deleteOrderProduct.
- Idempotent
Inputs
parametersstringrequired- Input parameters of deleteOrderProduct as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_id (int): Order ID from Base order manager. | order_product_id (int): Order item ID from Base order manager. Example: {"order_id": 3754894, "order_product_id": 59157160}
baselinker_orders_deleteDelete multiple orders from the Base order manager.DestructiveDelete Orders
Delete multiple orders from the Base order manager. Returns deleted_order_ids with status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method deleteOrders.
- Idempotent
Inputs
parametersstringrequired- Input parameters of deleteOrders as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: order_ids (array): Array of order identifiers from Base order manager (max 1000 at a time) Example: {"order_ids": [12345, 123456, 1234567]}
baselinker_product_deleteRemove the product from Base catalog.DestructiveDelete Product
Remove the product from Base catalog. Returns status SUCCESS, or status ERROR with error_code and error_message. Calls the BaseLinker API method deleteInventoryProduct.
- Idempotent
Inputs
parametersstringrequired- Input parameters of deleteInventoryProduct as a JSON object encoded in a string. Keys marked (optional) can be left out; send the others the method needs. Keys: product_id (int): Base inventory product identifier Example: {"product_id": 8}
No tools match.