Add Inventory
Tool to add or update a BaseLinker catalog (inventory). Use when you need to create a new catalog or update an existing one with the same identifier.
ActionTry it
Integrate Baselinker
with your AI workspace
BaseLinker is a comprehensive e-commerce management platform that integrates with various marketplaces, online stores, carriers, and accounting systems to streamline order processing, inventory management, and sales automation.
Explore Triggers and Actions
Add Inventory Category
Tool to add or update a category in the BaseLinker catalog. Use when you need to create a new category or update an existing one. Adding a category with the same identifier again updates the previously saved category.
ActionTry it
Add Inventory Document
Tool to create a new inventory document in BaseLinker storage. Use when you need to create goods receipts, issues, or transfers. Documents are created as drafts and require confirmation via user action or setInventoryDocumentStatusConfirmed API method.
ActionTry it
Add Inventory Manufacturer
Tool to add or update a manufacturer in the BaseLinker catalog. Use when you need to create a new manufacturer or update an existing one. Adding a manufacturer with the same identifier again updates the previously saved manufacturer.
ActionTry it
Add Inventory Payer
Tool to add a new payer or update an existing one in BaseLinker storage. Use when you need to create a new payer with contact details or update an existing payer's information.
ActionTry it
Add Inventory Price Group
Tool to create or update a price group in BaseLinker storage. Use when you need to define pricing tiers (e.g., wholesale, retail, VIP) that can be later assigned to inventory items via addInventory method.
ActionTry it
Add Inventory Product
Add a new product to BaseLinker catalog or update an existing product. Use when creating inventory items or modifying product details like SKU, price, stock, dimensions, and text fields. Provide product_id to update existing products, omit it to create new ones.
ActionTry it
Add Inventory Purchase Order
Tool to create a new purchase order in BaseLinker storage. Orders are created as drafts by default. Use when you need to create a new purchase order for inventory management.
ActionTry it
Add Inventory Purchase Order Items
Tool to add items to an existing purchase order in BaseLinker. Use when you need to add products to a purchase order that has already been created.
ActionTry it
Add Inventory Supplier
Tool to add a new supplier or update an existing one in BaseLinker storage. Use when you need to manage supplier information for inventory management. If supplier_id is provided, the existing supplier will be updated; otherwise, a new supplier will be created.
ActionTry it
Add Inventory Warehouse
Tool to add a new warehouse or update an existing warehouse in BaseLinker inventories. Use when you need to create new warehouse locations for inventory management or update warehouse details. Adding a warehouse with the same identifier again will update the previously saved warehouse. The method does not allow editing warehouses created automatically for external stocks.
ActionTry it
Add Invoice
Tool to issue an order invoice in BaseLinker. Use when you need to generate an invoice for an existing order using a specific numbering series.
ActionTry it
Add Invoice Correction
Tool to issue an order invoice correction. Use when correcting pricing errors, handling returns, or updating invoice data. Either original_invoice_id or return_order_id must be provided.
ActionTry it
Add Order
Tool to add a new order to the BaseLinker order manager. Use when you need to create a new order with customer details, products, and delivery information.
ActionTry it
Add Order By Split
Tool to create a new order by splitting selected products from an existing order. Use when you need to split an order into multiple shipments or separate deliveries. The new order inherits all customer details, addresses, and settings from the original order, with only the specified products and optional delivery costs moved to it.
ActionTry it
Add Order Duplicate
Tool to add a new order by duplicating an existing order in BaseLinker. The new order will have the same data as the original order but with a different ID.
ActionTry it
Add Order Return
Tool to add a new order return to BaseLinker. Use when creating a return for an order. Requires status_id (get from getOrderReturnStatusList), date_add (Unix timestamp), currency (3-letter code), and refunded status.
ActionTry it
Add Order Return Product
Tool to add a new product to an existing order return in BaseLinker. Use when a customer is returning items and you need to register the returned products.
ActionTry it
Add Shop Category
Tool to add a new category to BaseLinker storage (shops, warehouses, or BaseLinker inventory). Use when you need to create a new category in a connected storage's category structure. Requires a storage_id which can be obtained from GetExternalStoragesList or use 'bl_1' for BaseLinker inventory.
ActionTry it
Create Package Manual
Tool to register shipping details for orders when shipments are created outside BaseLinker. Use when you need to add tracking numbers and courier information for manually created shipments. Supports marking packages as return shipments.
ActionTry it
Delete Inventory
Tool to delete a catalog from BaseLinker storage. Use when you need to permanently remove an inventory/catalog.
ActionTry it
Delete Inventory Category
Tool 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.
ActionTry it
Delete Inventory Manufacturer
Tool to remove a manufacturer from the BaseLinker catalog. Use when you need to delete a manufacturer that is no longer needed or was added by mistake.
ActionTry it
Delete Inventory Payer
Tool to remove a payer from BaseLinker storage. Use when you need to delete an existing payer entry by its ID.
ActionTry it
Delete Inventory Price Group
Tool to remove a price group from BaseLinker storage. Use when you need to delete an existing price group by its identifier.
ActionTry it
Delete Inventory Product
Tool to remove a product from the BaseLinker catalog. Use when you need to permanently delete an inventory product by its ID.
ActionTry it
Delete Inventory Warehouse
Tool to remove a warehouse from BaseLinker inventories. Use when you need to delete a warehouse that is no longer needed. Note: This method does not allow removal of warehouses created automatically for external stock management (shops, wholesalers, etc.).
ActionTry it
Delete Order Product
Tool to remove a specific product from an order in BaseLinker. Use when you need to delete an order item without canceling the entire order.
ActionTry it
Delete Order Return Product
Tool to remove a specific product from an order return in BaseLinker. Use when you need to delete a product item from an existing return request.
ActionTry it
Delete Orders
Tool to delete multiple orders from BaseLinker order manager. Use when you need to permanently remove orders from the system.
ActionTry it
Get Connect Integration Contractors
Tool to retrieve a list of contractors connected to a selected Base Connect integration. Use when you need to discover available contractors for a specific integration before performing contractor-specific operations.
ActionTry it
Get Connect Integrations
Tool to retrieve a list of all Base Connect integrations on this account. Returns both integrations created on the account and integrations to which the account has connected.
ActionTry it
Get Courier Accounts
Tool to retrieve the list of accounts connected to a given courier. Use when you need to identify available courier accounts before performing shipping operations.
ActionTry it
Get Courier Fields
Tool to retrieve the form fields required for creating shipments with a specific courier. Use when you need to discover which fields are required or optional for shipment creation.
ActionTry it
Get Courier Packages Status History
Tool to retrieve the history of status changes for courier packages. Use when you need to track the delivery progress of shipments through their complete status timeline. Returns chronological status updates for up to 100 packages per request.
ActionTry it
Get Couriers List
Tool to retrieve a list of available couriers from BaseLinker. Use when you need to discover which shipping carriers are configured before creating packages or querying courier-specific fields.
ActionTry it
Get External Storage Products Quantity
Retrieve stock quantities from an external storage (shop/wholesaler) connected to BaseLinker. Use this tool to check current inventory levels for products in external integrations. Returns product IDs with their quantities, including variant-level stock if applicable.
ActionTry it
Get External Storages List
Retrieve a list of external storages (shops, warehouses, wholesalers) connected to BaseLinker that can be referenced via API. Returns storage IDs (e.g., 'shop_2444', 'warehouse_1334'), names, and supported API methods for each storage. Use this to discover available integrations before calling storage-specific methods like getExternalStorageProductsList.
ActionTry it
Get Inventories
Tool to retrieve a list of catalogs (inventories) available in the BaseLinker storage. Use when you need to discover available catalogs and their configurations before performing inventory-specific operations.
ActionTry it
Get Inventory Available Text Field Keys
Tool to retrieve a list of product text fields that can be overwritten for a specific integration. Use when you need to discover which text fields are available for modification within a given inventory catalog.
ActionTry it
Get Inventory Categories
Tool to retrieve a list of categories for a BaseLinker catalog. Use when you need to fetch category hierarchies for inventory management or product organization.
ActionTry it
Get Inventory Document Items
Tool to retrieve items from inventory documents in BaseLinker. Use when you need to fetch product details from a specific document with support for pagination (100 items per page).
ActionTry it
Get Inventory Document Series
Tool to retrieve available inventory document series. Use when you need to assign a numbering series to a new inventory document.
ActionTry it
Get Inventory Documents
Tool to retrieve a list of inventory documents. Use when you need to fetch inventory records with optional filters for ID, type, status, date range, warehouse, or pagination.
ActionTry it
Get Inventory Extra Fields
Tool to retrieve extra fields defined for BaseLinker catalog inventory items. Use before fetching or updating inventory products to list available custom fields.
ActionTry it
Get Inventory Integrations
Tool to retrieve a list of integrations where text values in the catalog can be overwritten. Use when you need to discover which sales channels support text customization and what languages are available for each integration.
ActionTry it
Get Inventory Manufacturers
Tool to retrieve a list of manufacturers from the BaseLinker catalog. Use when you need to view all manufacturers available in the system before adding or modifying manufacturer information.
ActionTry it
Get Inventory Payers
Tool to retrieve a list of payers available in BaseLinker storage. Use when you need to list payers, optionally filtered by ID or name.
ActionTry it
Get Inventory Price Groups
Tool to retrieve price groups existing in BaseLinker storage. Use when you need to discover available pricing tiers before assigning them to inventory items or performing price-related operations.
ActionTry it
Get Inventory Printout Templates
Tool to retrieve a list of all configured printout templates available for inventory (products). Use when you need to discover available printout templates before generating product documents.
ActionTry it
Get Inventory Product Logs
Tool to retrieve a list of events related to product changes in the BaseLinker catalog. Use when tracking product modification history, auditing changes, or monitoring inventory updates.
ActionTry it
Get Inventory Products Data
Tool to retrieve detailed data for selected products from the BaseLinker inventory. Use when you need comprehensive product information including SKU, prices, stock, dimensions, descriptions, images, variants, and bundle details.
ActionTry it
Get Inventory Products List
Tool to retrieve basic data of chosen products from BaseLinker catalogs. Use when you need to list products with optional filtering by ID, category, EAN, SKU, name, price range, or stock levels. Supports pagination for large catalogs (1000 products per page).
ActionTry it
Get Inventory Products Prices
Retrieve gross prices of products from BaseLinker inventories. Use when you need to get pricing information for products and their variants across different price groups. Supports pagination for large product catalogs.
ActionTry it
Get Inventory Products Stock
Tool to retrieve stock data of products from BaseLinker catalogs. Use when you need to check current inventory levels, reservations, or variant stock across warehouses. Results are paginated at 1000 products per page.
ActionTry it
Get Inventory Purchase Order Items
Tool to retrieve items from a specific purchase order in BaseLinker. Use when you need to fetch product details from a purchase order with support for pagination (100 items per page).
ActionTry it
Get Inventory Purchase Order Series
Tool to retrieve a list of purchase order document series. Use when you need to select a numbering series for a new purchase order.
ActionTry it
Get Inventory Purchase Orders
Tool to retrieve a list of purchase orders from BaseLinker storage. Use when you need to fetch purchase orders with optional filters like date range, supplier or pagination.
ActionTry it
Get Inventory Suppliers
Tool to retrieve a list of suppliers available in BaseLinker storage. Use when you need to list suppliers, optionally filtered by ID or name.
ActionTry it
Get Inventory Tags
Tool to retrieve a list of tags for a BaseLinker catalog. Use when you need to view all tags available in the system before categorizing or filtering inventory items.
ActionTry it
Get Inventory Warehouses
Tool to retrieve a list of warehouses available in BaseLinker inventories. Use when you need to discover available warehouse locations before performing inventory or stock operations. Returns warehouses created manually as well as those created automatically for external stocks (shops, wholesalers).
ActionTry it
Get Invoice File
Tool to retrieve an invoice file from BaseLinker in base64-encoded format. Use when you need to download an invoice document generated by BaseLinker or from an external accounting system.
ActionTry it
Get Invoices
Download invoices from BaseLinker order manager with optional filtering. Use this tool to: - Fetch all invoices from a specific date onwards - Retrieve a single invoice by ID or order ID - Filter invoices by numbering series - Paginate through invoices using id_from parameter Returns up to 100 invoices per request. Use getSeries to get available series IDs for filtering.
ActionTry it
Get Journal List
Tool to download order event logs from the last 3 days. Use when you need to track order activities, changes, or events. IMPORTANT: This method must be activated by BaseLinker support on your account. If not activated, it returns an empty response. Events include order creation, status changes, payments, invoices, receipts, product modifications, and package operations. Use last_log_id to paginate through results incrementally.
ActionTry it
Get New Receipts
Tool to retrieve receipts waiting to be issued. Use after confirming fiscal printer availability; fetch pending receipts and mark them with setOrderReceipt.
ActionTry it
Get Order Extra Fields
Tool to retrieve extra fields defined for orders. Use before fetching orders with include_custom_extra_fields to list available custom order fields.
ActionTry it
Get Order Packages
Tool to download shipments previously created for a selected order. Use when you need to retrieve tracking numbers, courier information, and delivery status for order packages.
ActionTry it
Get Order Payments History
Tool to retrieve payment history for a selected order, including external payment identifiers from payment gateways. Use when you need to track payment events for an order. One order can have multiple payment history entries due to surcharges, order value changes, or manual payment editing.
ActionTry it
Get Order Pick Pack History
Tool to retrieve pick and pack history for a selected order. Use when you need to track the fulfillment timeline and events for an order (reservations, picking, packing, photography). Returns chronological list of pick/pack events with timestamps and responsible profiles.
ActionTry it
Get Order Printout Templates
Tool to retrieve a list of all configured printout templates available for orders. Use when you need to discover available printout templates before generating order documents.
ActionTry it
Get Order Return Extra Fields
Tool to retrieve extra fields defined for order returns. Use before calling getOrderReturns with include_custom_extra_fields to list available custom fields. Field values can be set via setOrderReturnFields.
ActionTry it
Get Order Return Journal List
Tool to download return event logs from the last 3 days in BaseLinker. Use when tracking return order history, monitoring return status changes, or auditing return-related activities. Returns events like return creation, status changes, product modifications, and refund creation.
ActionTry it
Get Order Return Payments History
Tool to retrieve payment history for a selected order return, including external payment identifiers from the payment gateway. Use when you need to track payment events, surcharges, order value changes, or manual payment edits for a return.
ActionTry it
Get Order Return Product Statuses
Tool to retrieve a list of order return product statuses from BaseLinker. Use when you need to identify valid status IDs for return items, or to map status IDs to human-readable names.
ActionTry it
Get Order Return Reasons List
Tool to retrieve a list of order return reasons. Use when you need to discover available return reasons before setting return fields with setOrderReturnFields.
ActionTry it
Get Order Return Status List
Tool to retrieve order return statuses created in the BaseLinker order manager. Use when you need to map return status IDs to human-readable names.
ActionTry it
Get Order Returns
Download order returns from BaseLinker return manager with optional filtering. Use this tool to: - Fetch returns from a specific date onwards using date_from parameter - Retrieve a single return by return_id - Filter returns by source order, status, or marketplace source - Paginate through returns using id_from parameter Returns up to 100 order returns per request. For complete return data including custom fields, set include_custom_extra_fields=true. Use include_connect_data=true for Base Connect integration info.
ActionTry it
Get Order Sources
Tool to retrieve types of order sources along with their IDs from BaseLinker. Use when you need to understand available order sources for filtering orders or mapping order_source field values from getOrders method.
ActionTry it
Get Order Status List
Tool to retrieve a list of order statuses created in the BaseLinker order manager. Use when you need to map status IDs to human-readable names.
ActionTry it
Get Order Transaction Data
Tool to retrieve transaction details for a selected order. Use when you need marketplace transaction IDs, fulfillment data, or detailed tax breakdowns for an order.
ActionTry it
Get Orders
Download orders from BaseLinker order manager with optional filtering. Use this tool to: - Fetch all orders from a specific date onwards - Retrieve a single order by ID - Filter orders by status, email, or marketplace source - Paginate through orders using id_from parameter Returns up to 100 orders per request. For confirmed orders only, omit get_unconfirmed_orders. Tip: Use getOrderStatusList to get status IDs for filtering.
ActionTry it
Get Orders by Phone
Search for orders associated with a specific phone number in BaseLinker. Use when identifying callers in phone recognition systems or finding order history by phone. Returns basic order information including status, recipient names, and timestamps.
ActionTry it
Get Package Details
Tool to get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response. Use when you need comprehensive package dimensions, weight, COD, insurance, and shipping cost details.
ActionTry it
Get PickPack Carts
Tool to retrieve a list of all PickPack carts belonging to the authenticated user. Use when you need to discover available carts and their details (ID, name, color) before performing cart-specific operations.
ActionTry it
Get Protocol
Tool to download a parcel protocol for selected shipments. Use when you need to retrieve shipping protocol documents (PDF or HTML) for packages sent via a courier. The protocol is available only if supported by the chosen courier.
ActionTry it
Get Receipts
Tool to retrieve issued receipts from BaseLinker. Use when you need to fetch historical receipt data. Max 100 receipts returned per request.
ActionTry it
Get Request Parcel Pickup Fields
Tool to retrieve additional fields for a parcel pickup request from a specific courier. Use when preparing to request a parcel pickup and need to know which additional information the courier requires (e.g., pickup time, contact details, special instructions).
ActionTry it
Get Series
Tool to download invoice/receipt numbering series. Use when you need to retrieve all series configurations before issuing documents.
ActionTry it
Get Storages List
Tool to download a list of available storages accessible via API. Use when you need to discover storage endpoints and capabilities before performing storage-specific operations.
ActionTry it
Run Order Macro Trigger
Tool to run personal trigger for orders automatic actions. Use when you need to execute a specific automation trigger on an order.
ActionTry it
Run Product Macro Trigger
Tool to execute a personal trigger for products automatic actions. Use when you need to manually run a custom event trigger for a specific product in BaseLinker inventory.
ActionTry it
Run Request Parcel Pickup
Tool to request a parcel pickup for previously created shipments. Use when you need to schedule a courier pickup for packages that have been created. The method sends a pickup request to the courier API if the courier supports it. Use getRequestParcelPickupFields first to check if the courier requires additional fields.
ActionTry it
Set Inventory Purchase Order Status
Tool to change the status of a purchase order in BaseLinker inventory. Use when you need to update a purchase order's status (e.g., mark as sent, received, completed, or canceled).
ActionTry it
Set Order Fields
Tool to edit selected fields of a specific order in BaseLinker. Use when you need to update order details such as address data, notes, payment method, delivery information, or invoice details. Only provide the fields you want to change; other fields can be omitted.
ActionTry it
Set Order Payment
Tool to add a payment to an order in BaseLinker. Use when recording a payment for an order. The payment amount replaces (not adds to) the current payment value; if it matches the order total, the order is marked as paid.
ActionTry it
Set Order Product Fields
Tool to edit data of selected items in a specific BaseLinker order. Use when you need to update product fields like prices, quantities, SKU, or other item details. Only provide the fields you want to edit; other fields can be omitted.
ActionTry it
Set Order Receipt
Tool to mark orders with a receipt already issued. Use after printing receipts retrieved from getNewReceipts to confirm receipt issuance.
ActionTry it
Set Order Return Fields
Tool to edit selected fields of a specific order return. Use when updating return information such as buyer contact details, delivery address, or custom fields. Only the fields that need to be changed should be provided; other fields can be omitted.
ActionTry it
Set Order Return Product Fields
Tool to edit data of selected items (e.g., prices, quantities, attributes) of a specific order return product. Use when you need to update fields of a returned product in an order return.
ActionTry it
Set Order Return Refund
Tool to mark an order return as refunded in BaseLinker. Use when recording that a refund has been issued for a return. Note: This method doesn't issue an actual money refund - it only updates the refund status in BaseLinker.
ActionTry it
Set Order Return Status
Tool to change order return status in BaseLinker. Use when you need to update the status of a single order return.
ActionTry it
Set Order Return Statuses
Tool to batch set order return statuses in BaseLinker. Use when you need to update the status of multiple order returns at once.
ActionTry it
Set Order Status
Tool to change the status of an existing order in BaseLinker. Use when you need to update an order's status to a different value.
ActionTry it
Set Order Statuses
Tool to batch update order statuses in BaseLinker. Use when you need to set the same status for multiple orders at once.
ActionTry it
Set Orders Merge
Tool to merge multiple orders into one, based on the selected merge mode. Use when you need to combine orders together with either technical merge or into main order mode.
ActionTry it
Update Inventory Products Stock
Tool to update stocks of products and their variants in BaseLinker catalog. Use when you need to modify inventory levels for products across warehouses. Maximum 1000 products per request.
ActionTry it