Skip to main content
Baselinker logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 106
  • Triggers: 0
  • Slug: BASELINKER
  • Version: 20261101_00

Tools

Slug: 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

string
required
Catalog name
array
An array of languages available in the inventory.
array
An array of warehouse identifiers available in the inventory. Format: [type:bl|shop|warehouse]_[id:int]
string
Catalog description
integer
Catalog ID. The list of identifiers can be retrieved using the getInventories method. Should be used to update an existing inventory.
array
An array of price group identifiers available in the inventory.
boolean
Does this inventory support reservations
string
required
Default inventory language. Must be included in the languages parameter.
string
required
Identifier of the warehouse default for the inventory. The identifier must be included in the warehouses parameter.
integer
required
ID of the price group default for the inventory. The identifier must be included in the price_groups parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Category name.
integer
required
The parent category identifier obtained previously at the output of the addCategory method. Use 0 for root-level categories.
integer
The category identifier to be provided for updates. Should be left blank when creating a new category.
integer
required
Catalog ID. The list of identifiers can be retrieved by the getInventories method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Document notes or comments (max 500 characters).
integer
Date of document creation as Unix timestamp. If not specified, current date will be used.
string
Contractor description or notes (max 500 characters).
string
Related invoice number (max 50 characters).
integer
Date of document execution as Unix timestamp. If not specified, current date will be used.
integer
required
Source warehouse identifier where the document will be registered.
integer ("0" | "1" | "2" | "3" | "4" | "5")
required
Document classification: 0=GR (Goods Receipt), 1=IGR (Internal Goods Receipt), 2=GI (Goods Issue), 3=IGI (Internal Goods Issue), 4=IT (Inventory Transfer), 5=OB (Opening Balance).
integer
Target warehouse identifier. Required only for transfer documents (document_type=4).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Manufacturer name. Maximum 200 characters.
integer
Manufacturer ID. Provide this value when updating an existing manufacturer. Leave blank when creating a new manufacturer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Payer city.
string
required
Payer name (required).
string
Payer tax identification number (VAT number).
string
Payer address.
integer
Payer identifier. If provided, the existing payer will be updated. If not provided, a new payer will be created.
string
Payer postal code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_ADD_INVENTORY_PRICE_GROUPCreate or update a price group in BaseLinker storage. Price groups can later be assigned to catalogs.

Input Parameters

string
required
Name of the price group
string
required
3-letter currency code (ISO 4217 standard) for the price group
string
Price group description providing additional context about the pricing tier
integer
Price group identifier. If provided, updates an existing price group. Omit to create a new price group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Product EAN (European Article Number) barcode.
string
Product SKU (Stock Keeping Unit) number.
integer
Product star rating (0-5). 0 means no rating.
object
Product stock levels by warehouse. Key is warehouse ID, value is stock quantity.
number
Product width in centimeters.
number
Product height in centimeters.
object
Product images (up to 16). Key is image position (0-15), value is image URL.
number
Product length in centimeters.
object
Product prices by price group. Key is price group ID, value is gross price.
number
Product weight in kilograms.
number
VAT tax rate percentage (0-100). Use -1 for tax-exempt products.
boolean
Indicates whether the product is a bundle.
string
Product parent ID. If specified, the product becomes a variant of another product.
string
Main product identifier. Provide this only when updating an existing product. Leave blank when creating a new product.
integer
Product category ID.
object
Text fields for the product (name, description, features, etc.).
string
required
Catalog ID. Use getInventories method to retrieve available catalog IDs.
integer
Product manufacturer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Purchase order name/title. Helps identify the order in the system.
string
Additional notes or description for the purchase order.
string
required
Order currency code (3-letter ISO code, e.g., ‘EUR’, ‘USD’, ‘PLN’).
integer
required
Payer identifier responsible for payment of this purchase order.
integer
required
Document series identifier. Use getInventoryPurchaseOrderSeries to get available series IDs.
string
Related invoice number for this purchase order.
integer
required
Supplier identifier from whom goods are being purchased.
integer
Creation timestamp (Unix timestamp). If not provided, current time will be used.
integer
required
Warehouse identifier where the purchase order will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of items to add to the purchase order. Each item must include product_id, quantity, and item_cost.
integer
required
Purchase order identifier to which items will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Supplier city
string
required
Supplier name
string
Supplier email address
string
Supplier phone number
string
Supplier address
string
Default supplier currency (e.g., EUR, USD)
string
Supplier postal code
integer
Existing supplier identifier. If provided, the existing supplier will be updated.
string
Additional email addresses for correspondence
string
required
Source of product code for this supplier. Available values: ‘sku’ (Product SKU), ‘ean’ (Product EAN), ‘code’ (Product code at the supplier), or extra field ID.
string
required
Source of product cost for this supplier. Use ‘cost’ for product cost at the supplier, or provide a price group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Warehouse name. Required field with maximum length of 100 characters.
string
Warehouse description. Optional text field providing additional information about the warehouse.
integer
ID of the warehouse. Optional for creation (creates new warehouse). When provided, updates the existing warehouse with this ID. Cannot edit warehouses created automatically for external stocks (shops, wholesalers, etc.).
boolean
required
Whether manual editing of stocks is permitted. Set to false if you want to edit stock only through the API. Set to true to allow manual stock editing in BaseLinker interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order Identifier from BaseLinker order manager
string
VAT rate: ‘DEFAULT’ (uses series setting), ‘ITEM’ (uses item rate), ‘EXPT’/‘ZW’ (exempt), ‘NP’ (annotation), ‘OO’ (reverse charge), or numeric 0-100. If omitted, uses series default.
integer
required
Series numbering identifier. Use getSeries to retrieve available series IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of items to correct. Required when correcting_items=1
integer
Sale date as Unix timestamp
string
Name of the person issuing the invoice
integer
Numbering series ID for the invoice correction
string
Payment method description
string
Tax identification number (VAT ID)
string
Invoice recipient city
string
Invoice recipient state/province
integer
Whether to correct invoice data: 0=no, 1=yes
string
Invoice recipient street address
string
Invoice recipient company name
integer
Return order ID - if supplied, all other fields except series_id are ignored and invoice is created using return order data
integer
Whether to correct invoice items: 0=no, 1=yes
string
Invoice recipient full name
string
Invoice recipient postcode
integer
Reason code: 1=prepayments return, 2=compulsory discounts, 3=price increase, 4=refunds, 5=goods return, 6=pricing errors, 7=address correction, 8=contract withdrawal, 9=other
integer
Original invoice ID to correct. Either this or return_order_id must be provided
string
Two-letter country code (ISO 3166-1 alpha-2)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_ADD_ORDERTool 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.

Input Parameters

boolean
required
Whether the order is already paid. Value ‘true’ automatically adds a full payment.
string
Buyer’s email address
string
Buyer’s phone number
string
required
3-letter currency code (e.g., USD, EUR, PLN)
integer
required
Date of order creation in unix timestamp format
array
required
Order product array. At least one product is required.
string
Allegro or eBay user login
string
Billing details - VAT registration number/tax number
string
Billing details - city
boolean
Flag indicating whether the customer wants an invoice
string
Delivery address - city
string
Value of ‘additional field 1’ - seller can store any information
string
Value of ‘additional field 2’ - seller can store any information
string
Billing details - state/province
string
Buyer’s written comments
string
Seller’s internal comments
number
Gross delivery price
string
Delivery address - state/province
string
required
Payment method name
string
Delivery method name
string
Billing details - street and house number
string
Billing details - company name
integer
required
Order status ID. Use GetOrderStatusList to retrieve available status IDs.
integer
Identifier of custom order source from BaseLinker panel
string
Delivery address - street and number
string
Delivery address - company name
string
Billing details - name and surname
string
Billing details - postal code
string
Delivery address - name and surname
string
Pick-up point delivery - pick-up point identifier
string
Delivery address - postal code
boolean
required
Flag indicating whether the payment type is COD (cash on delivery)
array
List of custom extra fields with field_id and value pairs
string
Pick-up point delivery - pick-up point city
string
Pick-up point delivery - pick-up point name
string
Billing details - country code (two-letter, e.g., US, GB)
string
Delivery address - country code (two-letter, e.g., US, GB)
string
Pick-up point delivery - pick-up point address
string
Pick-up point delivery - pick-up point postcode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The BaseLinker order ID of the original order to split from.
array
required
Array of product items to move from the original order to the new order. Each item specifies the order_product_id and quantity to split.
number
The shipping/delivery cost amount to allocate to the new order. If not specified, delivery cost remains with the original order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_ADD_ORDER_DUPLICATETool 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.

Input Parameters

integer
required
The ID of the existing order to duplicate. Must be a valid order ID in BaseLinker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Buyer email address
string
Buyer phone number
string
required
3-letter currency code (e.g., EUR, PLN, USD)
integer
required
Date of order return creation in Unix timestamp format
integer
Order ID in BaseLinker panel
array
List of products being returned
boolean
Whether the order return is already refunded
integer
required
Order return status ID (retrieve available statuses with getOrderReturnStatusList)
string
Marketplace user login
string
IBAN of the bank account
string
SWIFT of the bank account
string
Delivery address - city
string
Value of additional field 1
string
Value of additional field 2
string
Seller comments
number
Gross delivery price
string
Delivery address - state/province
integer
Identifier of custom order source defined in BaseLinker panel. If not provided, default order return source is assigned.
string
Delivery address - street and number
string
Delivery address - company
string
Reference number from external source
string
Delivery address - name and surname
string
Delivery address - postcode
array
List of custom extra fields for the order return
string
Delivery address - two-letter country code (e.g., EN, US)
string
Bank account number to issue a refund

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Product EAN (European Article Number) barcode number.
string
Product SKU (Stock Keeping Unit) number. Unique identifier for inventory tracking.
string
Product name. Human-readable name of the product being returned.
number
Single piece weight in kilograms. Used for shipping calculations.
string
Type of product source storage. Valid values: ‘db’ (BaseLinker catalog), ‘shop’ (shop storage), ‘warehouse’ (warehouse).
string
Product location in warehouse. Physical location code or description.
integer
Number of pieces being returned. Quantity must be positive.
number
VAT tax rate percentage (0-100). Special values: -1 (not applicable), -0.02 (reverse charge), -0.03 (margin scheme).
integer
required
Order return identifier. The ID of the return to which the product should be added.
integer
Return item status identifier. Use to set the initial status of the return item.
string
Detailed product attributes (e.g., color, size, material). Use for variant details or custom attributes.
string
Listing ID number from marketplace (eBay/Allegro). Use for marketplace-originated products.
string
Product identifier in BaseLinker or shop storage. Use to identify the product being returned.
string
Storage identifier. Required when storage is ‘shop’ or ‘warehouse’.
string
Product variant ID. Specify if the product has variants (e.g., size, color).
number
Single item gross price (including tax). The price per unit with VAT included.
integer
Product source warehouse identifier. Specify the warehouse from which the product is being returned.
integer
ID of connected order item from BaseLinker order manager. Links this return product to an original order item.
integer
Return reason identifier. Specify why the product is being returned (e.g., defective, wrong item).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Category name to be added to the store.
string
required
Parent category ID. Use ‘0’ for root-level categories.
string
required
Storage identifier in format ‘[type:bl|shop|warehouse]_[id:int]’ (e.g., ‘shop_2445’, ‘bl_1’). Use external storage ID for shop integrations or ‘bl_1’ for BaseLinker inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order identifier from BaseLinker order manager.
integer
required
Date of dispatch in Unix timestamp format (seconds since epoch).
string
required
Courier code retrieved with getCouriersList or custom courier name (e.g., ‘dhl’, ‘ups’, ‘fedex’).
string
required
Shipping/consignment tracking number assigned by the courier.
boolean
If true, marks package as a return shipment. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_INVENTORYTool to delete a catalog from BaseLinker storage. Use when you need to permanently remove an inventory/catalog.

Input Parameters

integer
required
Catalog identifier to delete. Obtainable via getInventories method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the category to remove from BaseLinker warehouse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_INVENTORY_MANUFACTURERTool 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.

Input Parameters

integer
required
The ID of the manufacturer to remove from BaseLinker catalog.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_INVENTORY_PAYERTool to remove a payer from BaseLinker storage. Use when you need to delete an existing payer entry by its ID.

Input Parameters

integer
required
The identifier of the payer to be removed from BaseLinker storage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_INVENTORY_PRICE_GROUPTool to remove a price group from BaseLinker storage. Use when you need to delete an existing price group by its identifier.

Input Parameters

integer
required
Price group identifier to be deleted from BaseLinker storage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_INVENTORY_PRODUCTTool to remove a product from the BaseLinker catalog. Use when you need to permanently delete an inventory product by its ID.

Input Parameters

integer
required
BaseLinker inventory product identifier to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the warehouse to remove from BaseLinker inventories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_ORDER_PRODUCTTool to remove a specific product from an order in BaseLinker. Use when you need to delete an order item without canceling the entire order.

Input Parameters

integer
required
Order ID from BaseLinker order manager.
integer
required
Order item ID from BaseLinker order manager.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_ORDER_RETURN_PRODUCTTool 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.

Input Parameters

integer
required
The identifier for the order return from which the product will be removed.
integer
required
The identifier of the specific product item to delete from the return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_DELETE_ORDERSTool to delete multiple orders from BaseLinker order manager. Use when you need to permanently remove orders from the system.

Input Parameters

array
required
Array of order IDs to delete from BaseLinker order manager. Must contain at least one order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_CONNECT_INTEGRATION_CONTRACTORSTool 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.

Input Parameters

integer
required
The identifier of the Base Connect integration to retrieve contractors from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_CONNECT_INTEGRATIONSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_COURIER_ACCOUNTSTool to retrieve the list of accounts connected to a given courier. Use when you need to identify available courier accounts before performing shipping operations.

Input Parameters

string
required
Courier code to retrieve accounts for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Courier code that identifies which shipping provider to query for form fields (e.g., ‘dpd’, ‘ups’, ‘fedex’). Maximum 20 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
An array with a list of parcel IDs. Maximum 100 shipments at a time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_COURIERS_LISTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Optional page number for pagination when dealing with large product datasets. Returns subsequent pages of results.
string
required
Storage ID in format ‘[type:shop|warehouse]_[id:int]’. The type indicates whether it’s a shop or warehouse, followed by underscore and numeric ID. Use getExternalStoragesList to discover available storage IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORIESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Catalog ID. The list of identifiers can be retrieved by the getInventories method (inventory_id field).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Catalog identifier. Retrieve available IDs using the getInventories method’s inventory_id field. Omit this parameter to access categories across all catalogs in BaseLinker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_DOCUMENT_ITEMSTool 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).

Input Parameters

integer
Page number for pagination (100 items per page). If not specified, returns first page.
integer
required
Inventory document ID to retrieve items from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number of results (max 100 documents per page).
integer
Maximum creation date (Unix timestamp) to filter by.
integer
Minimum creation date (Unix timestamp) to filter by.
integer
Specific inventory document ID to filter by.
integer
Warehouse ID to filter by.
integer ("0" | "1" | "2" | "3" | "4" | "5")
Document type to filter by: 0=GR, 1=IGR, 2=GI, 3=IGI, 4=IT, 5=OB.
integer ("0" | "1")
Document status to filter by: 0=Draft, 1=Confirmed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_DOCUMENT_SERIESTool to retrieve available inventory document series. Use when you need to assign a numbering series to a new inventory document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_EXTRA_FIELDSTool to retrieve extra fields defined for BaseLinker catalog inventory items. Use before fetching or updating inventory products to list available custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Catalog ID. The list of identifiers can be retrieved by the getInventories method (inventory_id field).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_MANUFACTURERSRetrieve manufacturers from the BaseLinker catalog. The unpaginated request returns up to 10,000 manufacturers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Narrows results to a specific payer identifier. When provided, only the payer with this ID will be returned.
string
Enables filtering by payer designation using full or partial string matching (max 40 chars). Returns all payers whose names contain this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_PRICE_GROUPSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_PRINTOUT_TEMPLATESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Results page number. Returns 100 product events per page.
string ("ASC" | "DESC")
Sort order for logs.
integer
Unix timestamp. Only return logs up to this date.
string ("stock_change" | "price_change" | "product_creation" | "product_deletion" | "text_fields_modifications" | "locations_modifications" | "links_modifications" | "gallery_modifications" | "variant_modifications" | "bundle_products_modifications")
Log type classifications for product events.
integer
Unix timestamp. Only return logs from this date onwards.
integer
required
Product identifier. For retrieving variant logs, provide the variant identifier as the product identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
An array of product ID numbers to download
integer
required
Catalog ID. The list of identifiers can be retrieved using the method getInventories.
boolean
Include ERP units in the response. Only available for inventories with purchase cost calculations system different than AVCO.
boolean
Include suppliers data in the response.
boolean
Include WMS units in the response. Only available for inventories with enabled advanced warehouse management system.
boolean
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Results paging (1000 products per page for BaseLinker warehouse)
integer
Narrows results to a specific product ID
string
Limits results to a specific EAN code
string
Limiting the results to a specific SKU (stock keeping number)
string
Filters by product name or partial name match
string
The value for sorting the product list. Possible values: ‘id [ASC|DESC]’
integer
required
Catalog ID. The list of identifiers can be retrieved using the method getInventories.
number
Sets maximum price threshold
integer
Sets maximum quantity threshold
boolean
Include product variants alongside main products
number
Sets minimum price threshold
integer
Sets minimum quantity threshold
integer
Retrieves products from a particular category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Results paging (1000 products per page for BaseLinker warehouse). Start from 0 for the first page.
integer
required
Catalog ID. The list of identifiers can be retrieved using the method getInventories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Results paging (1000 products per page for BaseLinker warehouse). Use for iterating through large inventories.
integer
required
Catalog ID. Retrieve available catalog IDs using the getInventories method (inventory_id field).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_PURCHASE_ORDER_ITEMSTool 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).

Input Parameters

integer
Page number for pagination (100 items per page). If not specified, returns first page.
integer
required
Purchase order identifier to retrieve items from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number of results (100 purchase orders per page).
integer
Unix timestamp up to which purchase orders should be retrieved.
integer
Unix timestamp from which purchase orders should be retrieved.
integer
Limit results to a specific document series ID.
integer
Limit results to a specific supplier ID.
integer
Filter by warehouse identifier. Use to limit results to purchase orders for a specific warehouse.
string
Filter by document number (full or partial match).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_PURCHASE_ORDER_SERIESTool to retrieve a list of purchase order document series. Use when you need to select a numbering series for a new purchase order.

Input Parameters

integer
Filter series by warehouse ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Narrows results to a specific supplier identifier. When provided, only the supplier with this ID will be returned.
string
Enables filtering by supplier designation using full or partial string matching (max 40 chars). Returns all suppliers whose names contain this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_INVENTORY_TAGSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The BaseLinker invoice identifier number
boolean
When false (default): downloads invoice generated by BaseLinker. When true: retrieves invoice from external accounting system if available, falls back to BaseLinker format if unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Only return invoices with IDs greater than this value. Useful for pagination.
integer
Retrieve the invoice associated with a specific order ID.
integer
Unix timestamp. Only return invoices created on or after this date.
integer
Filter invoices by numbering series ID. Use getSeries to get available series IDs.
integer
Retrieve a specific invoice by its BaseLinker invoice ID.
boolean
If true, includes government data fields (gov_id, gov_date, gov_status) in the response. Default: false.
boolean
If false, excludes invoices with external files uploaded. Default: true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Order ID number to filter events for a specific order.
array
Event ID list to filter by. Event types range from 1-21 (e.g., 1=order created, 3=payment received, 7=invoice issued). If not provided, all event types are returned.
integer
Log ID number from which the logs are to be retrieved. Use to paginate through results. Must be greater than zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Retrieve receipts with receipt_id greater than this value. Defaults to 0 if omitted.
integer
Filter receipts by numbering series ID. Use separate series when multiple fiscal printers exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_EXTRA_FIELDSTool to retrieve extra fields defined for orders. Use before fetching orders with include_custom_extra_fields to list available custom order fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_PACKAGESTool 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.

Input Parameters

integer
required
Order identifier from BaseLinker order manager.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order identifier from BaseLinker order manager
boolean
Download full payment history, including order value change entries and manual order payment edits. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order identifier from BaseLinker order manager
integer
Filter by specific event type (1-17). If omitted, returns all history entries. Common values: 1=Reservation for collecting, 2=Picking started, 5=Picking finished, 8=Packing started, 11=Packing finished

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_PRINTOUT_TEMPLATESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_RETURN_EXTRA_FIELDSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Return ID number to filter events for a specific return order.
array
List of event type IDs to filter by. Valid types: 1 (Return creation), 2 (Accepted by customer), 3 (Completed), 4 (Cancelled), 5 (Status change), 6 (Products change), 7 (Data change), 8 (New product), 9 (Product removal), 10 (Invoice created), 11 (Parcel created), 12 (Refund created).
integer
Log ID number from which the logs are to be retrieved. Use this to paginate through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order return identifier
boolean
Download full payment history including order value changes and manual edits. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_RETURN_PRODUCT_STATUSESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_RETURN_REASONS_LISTTool to retrieve a list of order return reasons. Use when you need to discover available return reasons before setting return fields with setOrderReturnFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Return ID threshold. Only returns with return_id greater than this value will be included. Useful for pagination.
integer
Identifier of the order the return was created from. Filter returns by source order.
integer
Return creation date (Unix timestamp). Only returns created on or after this date will be included.
integer
Order return identifier. Use to download only one specific return.
integer
Status identifier filter. Leave blank to download returns from all statuses.
boolean
If true, include Base Connect integration and contractor data. Default: false.
string
Filter by return source (e.g., ‘ebay’, ‘amazon’, ‘allegro’, ‘shop’, ‘personal’).
boolean
If true, download values of custom additional fields. Default: false.
integer
Filter by order return source identifier. Requires filter_order_return_source to be set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_RETURN_STATUS_LISTTool to retrieve order return statuses created in the BaseLinker order manager. Use when you need to map return status IDs to human-readable names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Only return orders with IDs greater than or equal to this value. Useful for pagination.
integer
Retrieve a single specific order by its BaseLinker order ID.
integer
Unix timestamp. Only return orders created on or after this date.
integer
Filter orders by status ID. Use getOrderStatusList to get available status IDs.
string
Filter orders by customer email address (exact match).
integer
Unix timestamp. Only return orders confirmed on or after this date.
string
Filter orders by source name (e.g., ‘ebay’, ‘amazon’, ‘allegro’).
string
Filter by shop-specific order ID (the ID from the external marketplace/shop).
boolean
If true, include Base Connect integration and contractor data. Default: false.
integer
Filter orders by source account ID. Requires filter_order_source to be set.
boolean
If true, include unconfirmed orders (e.g., orders where customer hasn’t completed delivery form). Default: false.
boolean
If true, include marketplace commission data for each product. Default: false.
boolean
If true, include custom extra field values in the response. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Phone number to search for in orders. The phone number can include country code prefix (e.g., +48123456789). Returns all orders associated with this phone number. Maximum length is 50 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_SOURCESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_STATUS_LISTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_ORDER_TRANSACTION_DATATool to retrieve transaction details for a selected order. Use when you need marketplace transaction IDs, fulfillment data, or detailed tax breakdowns for an order.

Input Parameters

integer
required
Order identifier from BaseLinker order manager
boolean
Include legacy Amazon fulfillment data for backward compatibility. Default: true
boolean
Include detailed tax breakdown with order_lines structure in order_items. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the package for which you want to retrieve details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_PICK_PACK_CARTSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Courier API account identifier. Retrieve account IDs using getCourierAccounts for the specified courier.
array
Array of shipment identifiers. Either package_ids or package_numbers must be provided, not both.
string
required
Courier code for which to retrieve the protocol. Use codes from getCouriersList.
array
Array of shipment consignment numbers. Either package_ids or package_numbers must be provided, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_RECEIPTSTool to retrieve issued receipts from BaseLinker. Use when you need to fetch historical receipt data. Max 100 receipts returned per request.

Input Parameters

integer
Sets the end date for receipt collection in Unix timestamp format.
integer
Specifies the receipt ID from which subsequent receipts will be retrieved (inclusive).
integer
Sets the start date for receipt collection in Unix timestamp format.
integer
Enables filtering results by receipt numbering series identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Courier identifier code (e.g., ‘dpd’, ‘inpost’, ‘dhl’). Maximum 20 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_SERIESTool to download invoice/receipt numbering series. Use when you need to retrieve all series configurations before issuing documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_GET_STORAGES_LISTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_RUN_ORDER_MACRO_TRIGGERTool to run personal trigger for orders automatic actions. Use when you need to execute a specific automation trigger on an order.

Input Parameters

integer
required
The ID of the order to run the trigger on
integer
required
The ID of the personal trigger to execute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_RUN_PRODUCT_MACRO_TRIGGERTool 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.

Input Parameters

integer
required
Product identifier from BaseLinker product manager.
integer
required
Identifier of personal trigger from products automatic actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional array of additional fields required by the courier (e.g., pickup date, contact person). Use getRequestParcelPickupFields to determine required fields for the courier.
integer
required
The courier account identifier. Must be a positive integer.
string
required
Courier identifier code (e.g., ‘dpd’, ‘inpost’, ‘dhl’). Maximum 20 characters.
array
required
Array of package tracking numbers to request pickup for. Must contain at least one package number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer ("0" | "1" | "2" | "3" | "4" | "5")
required
New status code: 0=draft, 1=sent, 2=received, 3=completed, 4=partially completed, 5=canceled.
integer
required
Purchase order identifier to update.
array
List of items with their completion quantities. Each item includes item_id and completed_quantity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Buyer’s email address
string
Buyer’s phone number
integer
required
Order identifier from the BaseLinker order manager
integer
Pack state: 0 = not packed, 1 = packed
integer
Pick state: 0 = not picked, 1 = picked
string
Buyer’s account name (Allegro or eBay user login)
string
Billing details - VAT registration number/tax number
string
Billing details - city
boolean
Flag indicating whether the customer wants an invoice
string
Delivery address - city
string
Value of ‘additional field 1’ - seller can store any information
string
Value of ‘additional field 2’ - seller can store any information
string
Billing details - state/province
string
Buyer’s written comments
string
Seller’s internal comments
number
Gross delivery price
string
Delivery address - state/province
string
Payment method name
string
Delivery method name
string
Billing details - street and house number
string
Billing details - company name
string
Delivery address - street and number
string
Delivery address - company name
string
Billing details - name and surname
string
Billing details - postal code
string
Delivery address - recipient name and surname
string
Pick-up point delivery - pick-up point identifier
string
Delivery address - postal code
boolean
Flag indicating whether the payment type is COD (cash on delivery)
array
List of custom extra fields with field_id and value pairs
string
Pick-up point delivery - pick-up point city
string
Pick-up point delivery - pick-up point name
string
Billing details - country code (two-letter, e.g., US, GB)
string
Delivery address - country code (two-letter, e.g., US, GB)
string
Pick-up point delivery - pick-up point address
string
Pick-up point delivery - pick-up point postcode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order ID number
integer
required
Payment date as Unix timestamp
number
required
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.
string
required
Payment commentary
string
External payment identifier from payment gateway

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_PRODUCT_FIELDSTool 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.

Input Parameters

string
Product EAN number
string
Product SKU number
string
Product name
number
Single piece weight
string ("db" | "shop" | "warehouse")
Storage type for the product.
string
Product location
integer
required
Order identifier from the BaseLinker order manager
integer
Number of pieces
number
VAT tax rate e.g. ‘23’, (value from range 0-100)
string
The detailed product attributes, e.g. ‘Colour: blue’
string
Listing ID number (if the order comes from ebay/allegro)
string
Product identifier in BaseLinker or shop storage
string
The identifier of the storage (inventory/shop/warehouse)
string
Product variant ID number
number
Single item gross price
integer
Product source warehouse identifier. Only applies to products
integer
required
Order item ID from BaseLinker order manager

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_RECEIPTTool to mark orders with a receipt already issued. Use after printing receipts retrieved from getNewReceipts to confirm receipt issuance.

Input Parameters

integer
required
Receipt printing date in Unix timestamp format.
integer
required
Receipt ID number received from the getNewReceipts method.
string
required
The number of the issued receipt. May be blank if the printer does not return a number.
string
Name identifying the printer device used for printing.
boolean
required
Flag indicating receipt printing errors. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Buyer email address
string
Buyer phone number
integer
required
Order return identifier
string
Buyer login
string
Delivery address - city
string
Custom extra field 1 value
string
Custom extra field 2 value
string
Seller comments
number
Gross delivery price
string
Delivery address - state/province
string
Delivery address - street and number
string
Delivery address - company
string
Delivery address - name and surname
string
Delivery address - postcode
object
Custom extra fields with ID as key. Supports file uploads (2MB limit) in format {‘title’: ‘filename.pdf’, ‘file’: ‘data:base64_content’} or empty strings for removal
string
Delivery address - country code (two-letter format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Product EAN number
string
Product SKU number
string
Product name
number
Single piece weight in kilograms
string
Product source type: ‘db’ (internal inventory), ‘shop’ (online shop), or ‘warehouse’ (wholesaler)
string
Product location in warehouse
integer
Number of pieces
number
VAT rate (0-100, or special values: -1 for exempt, -0.02 for NP, -0.03 for reverse charge)
integer
required
Order return identifier from the BaseLinker order manager
integer
Product return status identifier
string
Product attributes (e.g., ‘Color: Red, Size: Large’)
string
Listing ID (for eBay/Allegro orders). Use for marketplace-originated products.
string
Product identifier in BaseLinker or shop storage
string
Identifier of the storage source. Required when storage is ‘shop’ or ‘warehouse’.
string
Product variant ID. Specify if the product has variants (e.g., size, color).
number
Single item gross price (including tax)
integer
Product source warehouse identifier
integer
Return reason identifier
integer
required
Order return item ID from BaseLinker order manager. The specific product within the return to edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Order return identifier. The ID of the return to mark as refunded.
integer
required
Refund date in Unix timestamp format. The date when the refund was issued.
string
required
Refund commentary. A note describing the refund details or reason.
number
required
The amount of the refund. The value changes the current refund in the order return (not added to the previous value).
string
External refund identifier. Optional reference ID from external payment system or refund processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_RETURN_STATUSTool to change order return status in BaseLinker. Use when you need to update the status of a single order return.

Input Parameters

integer
required
Order return ID number
integer
required
Status ID number. The status list can be retrieved using getOrderReturnStatusList

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_RETURN_STATUSESTool to batch set order return statuses in BaseLinker. Use when you need to update the status of multiple order returns at once.

Input Parameters

integer
required
Order return status ID number. The status list can be retrieved using getOrderReturnStatusList
array
required
Array of order return ID numbers to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("technical_merge" | "into_main_order")
required
Selection between ‘technical_merge’ (creates new technical order) or ‘into_main_order’ (moves items, deletes others)
integer
required
ID of the primary order whose shipping and invoice data will be retained
array
required
List of additional order IDs to merge; cannot include main_order_id
boolean
required
true = sum all shipping costs; false = keep main order’s shipping cost only

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_STATUSTool to change the status of an existing order in BaseLinker. Use when you need to update an order’s status to a different value.

Input Parameters

integer
required
Order ID number to update the status for.
integer
required
Status ID number to set for the order. The status list can be retrieved using GetOrderStatusList.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASELINKER_SET_ORDER_STATUSESTool to batch update order statuses in BaseLinker. Use when you need to set the same status for multiple orders at once.

Input Parameters

array
required
Collection of order ID numbers to update. At least one order ID is required.
integer
required
Status ID number to set for all specified orders. Use GetOrderStatusList to retrieve available status IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

object
required
An object where each key is a product ID and the value contains warehouse stock mappings. For variants, use the variant ID as the product ID. Within each product, warehouse IDs serve as keys with stock quantities as values. Warehouse identifiers follow the format [type:bl|shop|warehouse]_[id:int] (e.g., bl_123). Maximum 1000 products at a time.
integer
required
Catalog ID. The list of identifiers can be retrieved using the method getInventories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not