Method list
Test your request
Changelog
The API enables the information exchange between an external system and BaseLinker.
Communication uses data in JSON format. To make a request to the API, send the proper POST request to:
https://api.baselinker.com/connector.php
To send a request for each method a
token is required. The token is assigned directly to the BaseLinker user account.
User can generate API token in BaseLinker panel in "Account & other -> My account -> API" section.
Authorization with http header (X-BLToken) is recommended.
3 values must be submitted to the connector.php file via POST:
token - unique user API key - DEPRECATED, please use X-BLToken header- method - the name of the requested API method
- parameters - arguments of the requested function in JSON format
Sample:
curl 'https://api.baselinker.com/connector.php' -H 'X-BLToken: 1-23-ABC' --data-raw 'method=getOrders¶meters=%7B%22date_from%22%3A+1407341754%7D'
The API request limit is
100 requests per minute.
The API was last updated
2026-04-20.
The API uses UTF-8.
The API expects base64 content in some endpoints and it is very important to replace "+" character with "%2B" sequence before sending it to our API to avoid an incorrect decoding.
Orders
| addOrder | The method allows adding a new order to the BaseLinker order manager. |
| addOrderBySplit | Creates a new order by splitting selected products from an existing order. The new order inherits all fields and information from the original one. |
| addOrderDuplicate | The method allows you to add a new order to the BaseLinker order manager by duplicating an existing order. The new order will have the same data as the original order, but with a different ID. |
| deleteOrders | The method allows you to delete multiple orders from the BaseLinker order manager. |
| getOrderTransactionData | The method allows you to retrieve transaction details for a selected order |
| getOrders | The method allows you to download orders from a specific date from the BaseLinker order manager. The order list can be limited using the filters described in the method parameters. A maximum of 100 orders are returned at a time.
It is recommended to download only confirmed orders (get_unconfirmed_orders = false). Unconfirmed orders may be incomplete. The user may be, for example, in the process of creating an order - it already exists in the database, but not all information is completed. Unconfirmed orders may contain only a partial list of products and may be changed soon. Confirmed orders usually do not change anymore and can be safely downloaded to an external system.
The best way to download the ongoing orders is:
Collecting new order identifiers using getJournalList.
Or, using this method:
1. Setting the starting date and specifying it in the date_confirmed_from field
2. Processing of all received orders. If 100 orders are received, there may be even more to download.
3. Downloading the next package of orders by entering the value of the date_confirmed field from last downloaded order in the date_confirmed_from field. In order to avoid downloading the same orders value of date_confirmed should be increased by 1 second. This operation is repeated until you receive a package with less than 100 orders (this means that there are no more orders left to download).
4. Saving the date_confirmed last processed order. You can download orders from this date onwards so that you do not download the same order twice. It is not possible for an order to 'jump' into the database with an earlier confirmation date. This way you can be sure that all confirmed orders have been downloaded. |
| getOrdersByEmail | The method allows to 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.). |
| getOrdersByPhone | The method allows you to search for orders related to the given phone number. This function is intended for use in caller recognition programs. |
| setOrderFields | The method allows you to edit selected fields (e.g. address data, notes, etc.) of a specific order. Only the fields that you want to edit should be given, other fields can be omitted in the request. |
| setOrdersMerge | Merges multiple orders into one, based on the selected merge mode. |
Order products
| addOrderProduct | The method allows you to add a new product to your order. |
| deleteOrderProduct | The method allows you to remove a specific product from the order. |
| setOrderProductFields | The method allows you to edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Only the fields that you want to edit should be given, the remaining fields can be omitted in the request. |
Payments
| getOrderPaymentsHistory | The method allows you to 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 |
| setOrderPayment | The method allows you to add a payment to the order. |
Statuses
| getOrderStatusList | The method allows you to retrieve order statuses created by the customer in the BaseLinker order manager. |
| setOrderStatus | The method allows you to change order status. |
| setOrderStatuses | The method allows you to batch set orders statuses |
Invoices
| addInvoice | The method allows to issue an order invoice. |
| addInvoiceCorrection | The method allows to issue an order invoice correction.
Either original_invoice_id or return_order_id must be provided.
If return_order_id is provided, all other fields will be ignored (except series_id) and invoice will be created with data from the return order.
If field is optional and not provided, it will be set according to the series settings or default values. |
| addOrderInvoiceFile | The method allows you to add an external file to an invoice previously issued from BaseLinker. It enables replacing a standard invoice from BaseLinker with an invoice issued e.g. in an ERP program. |
| getInvoiceFile | The method allows you to get the invoice file from BaseLinker. |
| getInvoices | The method allows you to download invoices issued from the BaseLinker order manager. The list of invoices can be limited using filters described in the method parameters. Maximum 100 invoices are returned at a time. |
| getSeries | The method allows to download a series of invoice/receipt numbering. |
Receipts
| addOrderReceiptFile | The method allows you to add an external file to a receipt previously issued from BaseLinker. It enables replacing a standard receipt from BaseLinker with a receipt issued e.g. in an ERP program. |
| addReceipt | The method allows you to issue a receipt for an order. |
| getNewReceipts | The method allows you to retrieve receipts waiting to be issued. This method should be used in creating integration with a fiscal printer. The method can be requested for new receipts every e.g. 10 seconds. If any receipts appear in response, they should be confirmed by the setOrderReceipt method after printing to disappear from the waiting list. |
| getReceipt | The method allows you to retrieve a single receipt from the BaseLinker order manager. To retrieve a list of new receipts (when integrating a fiscal printer), use the getNewReceipts method. |
| getReceipts | The method allows you to retrieve issued receipts. Max 100 receipts are returned at a time. To retrieve a list of new receipts (when integrating a fiscal printer), use the getNewReceipts method. |
| setOrderReceipt | The method allows you to mark orders with a receipt already issued. |
PickPack carts
| getPickPackCarts | The method allows you to retrieve a list of all PickPack carts belonging to the authenticated user. The method returns cart details including ID, name, color. |
Other
| getJournalList | The method allows you to 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. If you cannot enable it in the panel, please contact Base support. |
| getOrderExtraFields | The method returns extra fields defined for the orders. Values of those fields can be set with method **setOrderFields**. In order to retrieve values of those fields set parameter include_custom_extra_fields in method **getOrders** |
| getOrderPickPackHistory | The method allows you to retrieve pick pack history for a selected order. |
| getOrderPrintoutTemplates | Returns a list of all configured printout templates available for orders. The output includes technical identifiers used when executing a printout. |
| getOrderSources | The method returns 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. Available source types are "personal", "shop", "order_return" or "marketplace_code" e.g. "ebay", "amazon", "ceneo", "emag", "allegro", etc. |
| runOrderMacroTrigger | The method allows you to run personal trigger for orders automatic actions. |
Returns
| addOrderReturn | The method allows adding a new order return to BaseLinker. |
| getOrderReturnExtraFields | The method returns extra fields defined for order returns. Values of those fields can be set with method setOrderReturnFields. To retrieve values of those fields set parameter include_custom_extra_fields in method getOrderReturns |
| getOrderReturns | The method allows you to download order returns from a specific date from the BaseLinker return manager. The return list can be limited using the filters described in the method parameters. A maximum of 100 order returns are returned at a time. |
| setOrderReturnFields | The method allows you to edit selected fields of a specific order return. Only the fields that you want to edit should be given, other fields can be omitted in the request. |
Return products
| addOrderReturnProduct | Add new product to existing order return |
| deleteOrderReturnProduct | The method allows you to remove a specific product from the return. |
| setOrderReturnProductFields | The method allows you to edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Only the fields that you want to edit should be given, the remaining fields can be omitted in the request. |
Statuses
Payments
| getOrderReturnPaymentsHistory | The method allows you to 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 |
| setOrderReturnRefund | The method allows you to mark an order return as refunded. Note this method doesn't issue an actual money refund. |
Other
Packages
| createPackage | The method allows you to create a shipment in the system of the selected courier. |
| createPackageManual | The method allows you to enter the shipping number and the name of the courier to the order (function used only to add shipments created outside BaseLinker) |
| deleteCourierPackage | The method allows you to delete a previously created shipment. The method removes the shipment from the BaseLinker system and from the courier system if the courier API allows it |
| getCourierPackagesStatusHistory | The method allows you to retrieve the history of the status list of the given shipments. Maximum 100 shipments at a time |
| getOrderPackages | The method allows you to download shipments previously created for the selected order. |
| getPackageDetails | This method allows to get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response. |
Courier info
| getCourierAccounts | The method allows you to retrieve a list of accounts connected with a courier. |
| getCourierFields | The method allows you to retrieve the form fields for creating shipments for the selected courier. |
| getCourierServices | The method allows you to retrieve additional courier services, which depend on other shipment settings. Used only for X-press, BrokerSystem, Wysyłam z Allegro, ErliPRO couriers. Not applicable to other couriers whose forms have fixed options. The details of the package should be sent with the method (the format as in createPackage) in order to receive a list of additional services |
| getCouriersList | The method allows you to retrieve a list of available couriers. |
Label & protocol
| getCourierDocument | The method allows you to download a parcel document |
| getLabel | The method allows you to download a shipping label (consignment) for a selected shipment. |
| getProtocol | The method allows you to download a parcel protocol for selected shipments if the protocol is available for chosen courier |
Parcel pickups
| getRequestParcelPickupFields | The method allows you to retrieve additional fields for a parcel pickup request. |
| runRequestParcelPickup | The method allows you to request a parcel pickup for previously created shipments. The method sends a parcel pickup request to courier API if the courier API allows it |
Clients
| addCrmClient | The method allows you to 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). |
| deleteCrmClient | The method allows you to remove a CRM client. Orders previously associated with the deleted client are not affected. |
| getCrmClientData | The method allows you to retrieve detailed data of a specific CRM client, including notes. |
| getCrmClientExtraFields | The method returns extra fields defined for CRM clients. Values of those fields can be set with method addCrmClient. In order to retrieve values of those fields use method getCrmClientData or set parameter include_custom_extra_fields in method getCrmClients. |
| getCrmClients | The method allows you to retrieve a list of CRM clients. The client list can be limited using the filters described in the method parameters. A maximum of 100 clients are returned at a time. To retrieve full client details (including notes and custom extra fields), use the getCrmClientData method. |
Statuses
Inventories
| addInventory | The method allows you to add the BaseLinker catalogs. Adding a catalog with the same identifier again will cause updates of the previously saved catalog. |
| deleteInventory | The method allows you to delete a catalog from BaseLinker storage. |
| getInventories | The method allows you to retrieve a list of catalogs available in the BaseLinker storage. |
Price groups
| addInventoryPriceGroup | The method allows to create a price group in BaseLinker storage. Providing a price group ID will update the existing price group. Such price groups may be later assigned in addInventory method. |
| deleteInventoryPriceGroup | The method allows you to remove the price group from BaseLinker storage. |
| getInventoryPriceGroups | The method allows to retrieve price groups existing in BaseLinker storage |
Warehouses
| addInventoryWarehouse | The method allows you to add a new warehouse available in BaseLinker inventories. Adding a warehouse with the same identifier again will cause updates of the previously saved warehouse. The method does not allow editing warehouses created automatically for the purpose of keeping external stocks of shops, wholesalers etc. Such warehouse may be later used in addInventory method. |
| deleteInventoryWarehouse | The method allows you to remove the warehouse available in BaseLinker inventories. The method does not allow to remove warehouses created automatically for the purpose of keeping external stocks of shops, wholesalers etc. |
| getInventoryWarehouses | The method allows you to retrieve a list of warehouses available in BaseLinker inventories. The method also returns information about the warehouses created automatically for the purpose of keeping external stocks (shops, wholesalers etc.) |
Categories
| addInventoryCategory | The method allows you to add a category to the BaseLinker catalog. Adding a category with the same identifier again, updates the previously saved category |
| deleteInventoryCategory | The method allows you to remove categories from BaseLinker warehouse. Along with the category, the products contained therein are removed (however, this does not apply to products in subcategories). The subcategories will be changed to the highest level categories. |
| getInventoryCategories | The method allows you to retrieve a list of categories for a BaseLinker catalog. |
Manufacturers
| addInventoryManufacturer | The method allows you to add a manufacturer to the BaseLinker catalog. Adding a manufacturer with the same identifier again, updates the previously saved manufacturer |
| deleteInventoryManufacturer | The method allows you to remove manufacturer from BaseLinker catalog |
| getInventoryManufacturers | The method allows you to retrieve a list of manufacturers for a BaseLinker catalog. Results can be paginated by providing the page parameter (1000 manufacturers per page). Without the page parameter, all manufacturers are returned. |
Products
| addInventoryProduct | The method allows you to add a new product to BaseLinker catalog. Entering the product with the ID updates previously saved product. |
| deleteInventoryProduct | The method allows you to remove the product from BaseLinker catalog. |
| getInventoryProductLogs | The method allows to retrieve a list of events related to product change (or their variants) in the BaseLinker catalog. |
| getInventoryProductsData | The method allows you to retrieve detailed data for selected products from the BaseLinker inventory. |
| getInventoryProductsList | The method allows to retrieve a basic data of chosen products from BaseLinker catalogs. |
| getInventoryProductsPrices | The method allows to retrieve the gross prices of products from BaseLinker inventories. |
| getInventoryProductsStock | The method allows you to retrieve stock data of products from BaseLinker catalogs. |
| runProductMacroTrigger | The method allows you to run personal trigger for products automatic actions. |
| updateInventoryProductsPrices | The method allows bulk update of gross prices of products (and/or their variants) in the BaseLinker catalog. Maximum 1000 products at a time. |
| updateInventoryProductsStock | The method allows to update stocks of products (and/or their variants) in BaseLinker catalog. Maximum 1000 products at a time. |
Documents
| addInventoryDocument | The method allows you to create a new inventory document in BaseLinker storage. Documents are created as draft and need to be confirmed by the user or setInventoryDocumentStatusConfirmed API method. |
| addInventoryDocumentFile | The method allows you to add an external PDF file to a warehouse document. It enables attaching a document issued in an external ERP system to the corresponding warehouse document in Base. |
| addInventoryDocumentItems | The method allows you to add items to an existing inventory document. |
| getInventoryDocumentFile | The method allows you to download a warehouse document PDF file. |
| getInventoryDocumentItems | This method allows you to retrieve document items for a specific inventory document in BaseLinker. In case of a large number of items, pagination is possible. |
| getInventoryDocumentSeries | This method allows you to retrieve information about available inventory document series in BaseLinker. Each series can be linked to a specific warehouse and can have its own numbering format settings. |
| getInventoryDocuments | This method allows you to retrieve a list of inventory documents from BaseLinker. It supports pagination and optional filtering by document type, date range, etc. |
| setInventoryDocumentStatusConfirmed | The method allows you to confirm an inventory document, which will affect the stock levels in the warehouse. |
Purchase orders
Fulfillment deliveries
| addInventoryFulfillmentDelivery | The method allows you to create a new fulfillment delivery in draft status. A fulfillment delivery represents a shipment of products from a source warehouse to a fulfillment center. |
| addInventoryFulfillmentDeliveryItems | The method allows you to add products to a fulfillment delivery. Items can only be added to deliveries in draft status. Products must exist in inventory and must not be bundles, drafts, or main products with variants. |
| getInventoryFulfillmentDeliveries | The method allows you to retrieve a list of fulfillment deliveries with optional filtering. Results are paginated with 100 results per page. |
| getInventoryFulfillmentDeliveryItems | The method allows you to retrieve items from a specific fulfillment delivery. Results are paginated with 100 results per page. |
Suppliers
Payers
| addInventoryPayer | The method allows you to add a new payer or update an existing one in BaseLinker storage. |
| deleteInventoryPayer | The method allows you to remove a payer from BaseLinker storage. |
| getInventoryPayers | The method allows you to retrieve a list of payers available in BaseLinker storage. |
Other
| getInventoryAvailableTextFieldKeys | The method returns a list of product text fields that can be overwritten for specific integration. |
| getInventoryExtraFields | The method allows you to retrieve a list of extra fields for a BaseLinker catalog. |
| getInventoryIntegrations | The method returns a list of integrations where text values in the catalog can be overwritten. The returned data contains a list of accounts for each integration and a list of languages supported by the integration |
| getInventoryPrintoutTemplates | Returns a list of all configured printout templates available for inventory (products). |
| getInventoryTags | The method allows you to retrieve a list of tags for a BaseLinker catalog. |
Integrations
Contractor credit
| addConnectContractorCreditSettlement | The method allows you to add a manual credit settlement (repayment) for a chosen contractor in Base Connect. A settlement reduces the blocked credit amount for the contractor, effectively recording a payment received for previously charged orders. The settlement amount cannot exceed the contractor's currently blocked credit amount (credit_to_pay). |
| getConnectContractorCreditHistory | The method allows you to retrieve an information about chosen contractor trade credit history |
| setConnectContractorCreditLimit | The method allows you to set new trade credit limit for chosen contractor |
External connections
| getExternalStorageCategories | The method allows you to retrieve a category list from an external storage (shop/wholesale) connected to BaseLinker. |
| getExternalStorageProductsData | The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker. |
| getExternalStorageProductsList | The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker. |
| getExternalStorageProductsPrices | The method allows to retrieve product prices from an external storage (shop/wholesaler) connected to BaseLinker. |
| getExternalStorageProductsQuantity | The method allows to retrieve stock from an external storage (shop/wholesaler) connected to BaseLinker. |
| getExternalStoragesList | The method allows you to retrieve a list of available external storages (shops, wholesalers) that can be referenced via API. |
| updateExternalStorageProductsQuantity | The method allows to bulk update the product stock (and/or variants) in an external storage (shop/wholesaler) connected to BaseLinker. Maximum 1000 products at a time. |
API documentation