- Category: ecommerce
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 106
- Triggers: 0
- Slug:
BASELINKER - Version: 20261101_00
Tools
Add Inventory
Add Inventory
BASELINKER_ADD_INVENTORYTool 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.Input Parameters
Output
Add Inventory Category
Add Inventory Category
BASELINKER_ADD_INVENTORY_CATEGORYTool 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.Input Parameters
Output
Add Inventory Document
Add Inventory Document
BASELINKER_ADD_INVENTORY_DOCUMENTTool 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.Input Parameters
Output
Add Inventory Manufacturer
Add Inventory Manufacturer
BASELINKER_ADD_INVENTORY_MANUFACTURERTool 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.Input Parameters
Output
Add Inventory Payer
Add Inventory Payer
BASELINKER_ADD_INVENTORY_PAYERTool 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.Input Parameters
Output
Add Inventory Price Group
Add Inventory Price Group
Add Inventory Product
Add Inventory Product
BASELINKER_ADD_INVENTORY_PRODUCTAdd 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.Input Parameters
Output
Add Inventory Purchase Order
Add Inventory Purchase Order
BASELINKER_ADD_INVENTORY_PURCHASE_ORDERTool 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.Input Parameters
Output
Add Inventory Purchase Order Items
Add Inventory Purchase Order Items
BASELINKER_ADD_INVENTORY_PURCHASE_ORDER_ITEMSAdd items to an existing BaseLinker purchase order or update a matching existing item while the order is in draft status. A product with the same ID and price updates an existing position only when all other parameters match; otherwise a new item is added.Input Parameters
Output
Add Inventory Supplier
Add Inventory Supplier
BASELINKER_ADD_INVENTORY_SUPPLIERTool 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.Input Parameters
Output
Add Inventory Warehouse
Add Inventory Warehouse
BASELINKER_ADD_INVENTORY_WAREHOUSETool 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.Input Parameters
Output
Add Invoice
Add Invoice
BASELINKER_ADD_INVOICETool to issue an order invoice in BaseLinker. Use when you need to generate an invoice for an existing order using a specific numbering series.Input Parameters
Output
Add Invoice Correction
Add Invoice Correction
BASELINKER_ADD_INVOICE_CORRECTIONIssue an order invoice correction using an original invoice or a return order. When a return order is supplied, the correction uses its data and other supplied fields are ignored except the numbering series.Input Parameters
Output
Add Order
Add Order
Add Order By Split
Add Order By Split
BASELINKER_ADD_ORDER_BY_SPLITTool 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.Input Parameters
Output
Add Order Duplicate
Add Order Duplicate
Add Order Return
Add Order Return
BASELINKER_ADD_ORDER_RETURNTool 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.Input Parameters
Output
Add Order Return Product
Add Order Return Product
BASELINKER_ADD_ORDER_RETURN_PRODUCTTool 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.Input Parameters
Output
Add Shop Category
Add Shop Category
BASELINKER_ADD_SHOP_CATEGORYTool 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.Input Parameters
Output
Create Package Manual
Create Package Manual
BASELINKER_CREATE_PACKAGE_MANUALTool 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.Input Parameters
Output
Delete Inventory
Delete Inventory
Delete Inventory Category
Delete Inventory Category
BASELINKER_DELETE_INVENTORY_CATEGORYTool 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.Input Parameters
Output
Delete Inventory Manufacturer
Delete Inventory Manufacturer
Delete Inventory Payer
Delete Inventory Payer
Delete Inventory Price Group
Delete Inventory Price Group
Delete Inventory Product
Delete Inventory Product
Delete Inventory Warehouse
Delete Inventory Warehouse
BASELINKER_DELETE_INVENTORY_WAREHOUSETool 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.).Input Parameters
Output
Delete Order Product
Delete Order Product
Delete Order Return Product
Delete Order Return Product
Delete Orders
Delete Orders
Get Connect Integration Contractors
Get Connect Integration Contractors
Get Connect Integrations
Get Connect Integrations
Get Courier Accounts
Get Courier Accounts
Get Courier Fields
Get Courier Fields
BASELINKER_GET_COURIER_FIELDSTool 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.Input Parameters
Output
Get Courier Packages Status History
Get Courier Packages Status History
BASELINKER_GET_COURIER_PACKAGES_STATUS_HISTORYTool 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.Input Parameters
Output
Get Couriers List
Get Couriers List
Get External Storage Products Quantity
Get External Storage Products Quantity
BASELINKER_GET_EXTERNAL_STORAGE_PRODUCTS_QUANTITYRetrieve 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.Input Parameters
Output
Get External Storages List
Get External Storages List
BASELINKER_GET_EXTERNAL_STORAGES_LISTRetrieve 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.Output
Get Inventories
Get Inventories
Get Inventory Available Text Field Keys
Get Inventory Available Text Field Keys
BASELINKER_GET_INVENTORY_AVAILABLE_TEXT_FIELD_KEYSTool 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.Input Parameters
Output
Get Inventory Categories
Get Inventory Categories
BASELINKER_GET_INVENTORY_CATEGORIESTool to retrieve a list of categories for a BaseLinker catalog. Use when you need to fetch category hierarchies for inventory management or product organization.Input Parameters
Output
Get Inventory Document Items
Get Inventory Document Items
Get Inventory Documents
Get Inventory Documents
BASELINKER_GET_INVENTORY_DOCUMENTSTool 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.Input Parameters
Output
Get Inventory Document Series
Get Inventory Document Series
Get Inventory Extra Fields
Get Inventory Extra Fields
Get Inventory Integrations
Get Inventory Integrations
BASELINKER_GET_INVENTORY_INTEGRATIONSTool 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.Input Parameters
Output
Get Inventory Manufacturers
Get Inventory Manufacturers
Get Inventory Payers
Get Inventory Payers
BASELINKER_GET_INVENTORY_PAYERSTool to retrieve a list of payers available in BaseLinker storage. Use when you need to list payers, optionally filtered by ID or name.Input Parameters
Output
Get Inventory Price Groups
Get Inventory Price Groups
Get Inventory Printout Templates
Get Inventory Printout Templates
Get Inventory Product Logs
Get Inventory Product Logs
BASELINKER_GET_INVENTORY_PRODUCT_LOGSTool 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.Input Parameters
Output
Get Inventory Products Data
Get Inventory Products Data
BASELINKER_GET_INVENTORY_PRODUCTS_DATATool 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.Input Parameters
Output
Get Inventory Products List
Get Inventory Products List
BASELINKER_GET_INVENTORY_PRODUCTS_LISTTool 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).Input Parameters
Output
Get Inventory Products Prices
Get Inventory Products Prices
BASELINKER_GET_INVENTORY_PRODUCTS_PRICESRetrieve 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.Input Parameters
Output
Get Inventory Products Stock
Get Inventory Products Stock
BASELINKER_GET_INVENTORY_PRODUCTS_STOCKTool 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.Input Parameters
Output
Get Inventory Purchase Order Items
Get Inventory Purchase Order Items
Get Inventory Purchase Orders
Get Inventory Purchase Orders
BASELINKER_GET_INVENTORY_PURCHASE_ORDERSTool 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.Input Parameters
Output
Get Inventory Purchase Order Series
Get Inventory Purchase Order Series
Get Inventory Suppliers
Get Inventory Suppliers
BASELINKER_GET_INVENTORY_SUPPLIERSTool to retrieve a list of suppliers available in BaseLinker storage. Use when you need to list suppliers, optionally filtered by ID or name.Input Parameters
Output
Get Inventory Warehouses
Get Inventory Warehouses
BASELINKER_GET_INVENTORY_WAREHOUSESTool 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).Output
Get Invoice File
Get Invoice File
BASELINKER_GET_INVOICE_FILETool 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.Input Parameters
Output
Get Invoices
Get Invoices
BASELINKER_GET_INVOICESDownload 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.Input Parameters
Output
Get Journal List
Get Journal List
BASELINKER_GET_JOURNAL_LISTDownload order event logs from the last three days, with incremental pagination. The method must be enabled in the account’s API settings; if disabled, it may return an empty response.Input Parameters
Output
Get New Receipts
Get New Receipts
BASELINKER_GET_NEW_RECEIPTSTool to retrieve receipts waiting to be issued. Use after confirming fiscal printer availability; fetch pending receipts and mark them with setOrderReceipt.Input Parameters
Output
Get Order Extra Fields
Get Order Extra Fields
Get Order Packages
Get Order Packages
Get Order Payments History
Get Order Payments History
BASELINKER_GET_ORDER_PAYMENTS_HISTORYTool 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.Input Parameters
Output
Get Order Pick Pack History
Get Order Pick Pack History
BASELINKER_GET_ORDER_PICK_PACK_HISTORYTool 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.Input Parameters
Output
Get Order Printout Templates
Get Order Printout Templates
Get Order Return Extra Fields
Get Order Return Extra Fields
Get Order Return Journal List
Get Order Return Journal List
BASELINKER_GET_ORDER_RETURN_JOURNAL_LISTTool 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.Input Parameters
Output
Get Order Return Payments History
Get Order Return Payments History
BASELINKER_GET_ORDER_RETURN_PAYMENTS_HISTORYTool 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.Input Parameters
Output
Get Order Return Product Statuses
Get Order Return Product Statuses
Get Order Return Reasons List
Get Order Return Reasons List
Get Order Returns
Get Order Returns
BASELINKER_GET_ORDER_RETURNSDownload 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.Input Parameters
Output
Get Order Return Status List
Get Order Return Status List
Get Orders
Get Orders
BASELINKER_GET_ORDERSDownload 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.Input Parameters
Output
Get Orders by Phone
Get Orders by Phone
BASELINKER_GET_ORDERS_BY_PHONESearch 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.Input Parameters
Output
Get Order Sources
Get Order Sources
Get Order Status List
Get Order Status List
Get Order Transaction Data
Get Order Transaction Data
Get Package Details
Get Package Details
BASELINKER_GET_PACKAGE_DETAILSTool 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.Input Parameters
Output
Get PickPack Carts
Get PickPack Carts
Get Protocol
Get Protocol
BASELINKER_GET_PROTOCOLTool 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.Input Parameters
Output
Get Receipts
Get Receipts
Get Request Parcel Pickup Fields
Get Request Parcel Pickup Fields
BASELINKER_GET_REQUEST_PARCEL_PICKUP_FIELDSTool 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).Input Parameters
Output
Get Series
Get Series
Get Storages List
Get Storages List
Run Order Macro Trigger
Run Order Macro Trigger
Run Product Macro Trigger
Run Product Macro Trigger
Run Request Parcel Pickup
Run Request Parcel Pickup
BASELINKER_RUN_REQUEST_PARCEL_PICKUPTool 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.Input Parameters
Output
Set Inventory Purchase Order Status
Set Inventory Purchase Order Status
BASELINKER_SET_INVENTORY_PURCHASE_ORDER_STATUSTool 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).Input Parameters
Output
Set Order Fields
Set Order Fields
BASELINKER_SET_ORDER_FIELDSTool 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.Input Parameters
Output
Set Order Payment
Set Order Payment
BASELINKER_SET_ORDER_PAYMENTTool 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.Input Parameters
Output
Set Order Product Fields
Set Order Product Fields
Set Order Receipt
Set Order Receipt
Set Order Return Fields
Set Order Return Fields
BASELINKER_SET_ORDER_RETURN_FIELDSTool 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.Input Parameters
Output
Set Order Return Product Fields
Set Order Return Product Fields
BASELINKER_SET_ORDER_RETURN_PRODUCT_FIELDSTool 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.Input Parameters
Output
Set Order Return Refund
Set Order Return Refund
BASELINKER_SET_ORDER_RETURN_REFUNDTool 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.Input Parameters
Output
Set Order Return Status
Set Order Return Status
Set Order Return Statuses
Set Order Return Statuses
Set Orders Merge
Set Orders Merge
BASELINKER_SET_ORDERS_MERGETool 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.Input Parameters
Output
Set Order Status
Set Order Status
Set Order Statuses
Set Order Statuses
Update Inventory Products Stock
Update Inventory Products Stock
BASELINKER_UPDATE_INVENTORY_PRODUCTS_STOCKTool 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.