# Baselinker

BaseLinker is a comprehensive e-commerce management platform that integrates with various marketplaces, online stores, carriers, and accounting systems to streamline order processing, inventory management, and sales automation.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 106
- **Triggers:** 0
- **Slug:** `BASELINKER`
- **Version:** 20260312_00

## Tools

### Add Inventory

**Slug:** `BASELINKER_ADD_INVENTORY`

Tool to add or update a BaseLinker catalog (inventory). Use when you need to create a new catalog or update an existing one with the same identifier.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Category

**Slug:** `BASELINKER_ADD_INVENTORY_CATEGORY`

Tool to add or update a category in the BaseLinker catalog. Use when you need to create a new category or update an existing one. Adding a category with the same identifier again updates the previously saved category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Category name. |
| `parent_id` | integer | Yes | The parent category identifier obtained previously at the output of the addCategory method. Use 0 for root-level categories. |
| `category_id` | integer | No | The category identifier to be provided for updates. Should be left blank when creating a new category. |
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved by the getInventories method. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Document

**Slug:** `BASELINKER_ADD_INVENTORY_DOCUMENT`

Tool to create a new inventory document in BaseLinker storage. Use when you need to create goods receipts, issues, or transfers. Documents are created as drafts and require confirmation via user action or setInventoryDocumentStatusConfirmed API method.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Document notes or comments (max 500 characters). |
| `date_add` | integer | No | Date of document creation as Unix timestamp. If not specified, current date will be used. |
| `contractor` | string | No | Contractor description or notes (max 500 characters). |
| `invoice_no` | string | No | Related invoice number (max 50 characters). |
| `date_execute` | integer | No | Date of document execution as Unix timestamp. If not specified, current date will be used. |
| `warehouse_id` | integer | Yes | Source warehouse identifier where the document will be registered. |
| `document_type` | integer ("0" | "1" | "2" | "3" | "4" | "5") | Yes | 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). |
| `target_warehouse_id` | integer | No | Target warehouse identifier. Required only for transfer documents (document_type=4). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Manufacturer

**Slug:** `BASELINKER_ADD_INVENTORY_MANUFACTURER`

Tool to add or update a manufacturer in the BaseLinker catalog. Use when you need to create a new manufacturer or update an existing one. Adding a manufacturer with the same identifier again updates the previously saved manufacturer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Manufacturer name. Maximum 200 characters. |
| `manufacturer_id` | integer | No | Manufacturer ID. Provide this value when updating an existing manufacturer. Leave blank when creating a new manufacturer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Payer

**Slug:** `BASELINKER_ADD_INVENTORY_PAYER`

Tool to add a new payer or update an existing one in BaseLinker storage. Use when you need to create a new payer with contact details or update an existing payer's information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Payer city. |
| `name` | string | Yes | Payer name (required). |
| `tax_no` | string | No | Payer tax identification number (VAT number). |
| `address` | string | No | Payer address. |
| `payer_id` | integer | No | Payer identifier. If provided, the existing payer will be updated. If not provided, a new payer will be created. |
| `postcode` | string | No | Payer postal code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Price Group

**Slug:** `BASELINKER_ADD_INVENTORY_PRICE_GROUP`

Tool to create or update a price group in BaseLinker storage. Use when you need to define pricing tiers (e.g., wholesale, retail, VIP) that can be later assigned to inventory items via addInventory method.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the price group |
| `currency` | string | Yes | 3-letter currency code (ISO 4217 standard) for the price group |
| `description` | string | No | Price group description providing additional context about the pricing tier |
| `price_group_id` | integer | No | Price group identifier. If provided, updates an existing price group. Omit to create a new price group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Product

**Slug:** `BASELINKER_ADD_INVENTORY_PRODUCT`

Add a new product to BaseLinker catalog or update an existing product. Use when creating inventory items or modifying product details like SKU, price, stock, dimensions, and text fields. Provide product_id to update existing products, omit it to create new ones.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Purchase Order

**Slug:** `BASELINKER_ADD_INVENTORY_PURCHASE_ORDER`

Tool to create a new purchase order in BaseLinker storage. Orders are created as drafts by default. Use when you need to create a new purchase order for inventory management.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Purchase Order Items

**Slug:** `BASELINKER_ADD_INVENTORY_PURCHASE_ORDER_ITEMS`

Tool to add items to an existing purchase order in BaseLinker. Use when you need to add products to a purchase order that has already been created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | List of items to add to the purchase order. Each item must include product_id, quantity, and item_cost. |
| `order_id` | integer | Yes | Purchase order identifier to which items will be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Supplier

**Slug:** `BASELINKER_ADD_INVENTORY_SUPPLIER`

Tool to add a new supplier or update an existing one in BaseLinker storage. Use when you need to manage supplier information for inventory management. If supplier_id is provided, the existing supplier will be updated; otherwise, a new supplier will be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Supplier city |
| `name` | string | Yes | Supplier name |
| `email` | string | No | Supplier email address |
| `phone` | string | No | Supplier phone number |
| `address` | string | No | Supplier address |
| `currency` | string | No | Default supplier currency (e.g., EUR, USD) |
| `postcode` | string | No | Supplier postal code |
| `supplier_id` | integer | No | Existing supplier identifier. If provided, the existing supplier will be updated. |
| `email_copy_to` | string | No | Additional email addresses for correspondence |
| `take_product_code_from` | string | Yes | 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. |
| `take_product_cost_from` | string | Yes | Source of product cost for this supplier. Use 'cost' for product cost at the supplier, or provide a price group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Inventory Warehouse

**Slug:** `BASELINKER_ADD_INVENTORY_WAREHOUSE`

Tool to add a new warehouse or update an existing warehouse in BaseLinker inventories. Use when you need to create new warehouse locations for inventory management or update warehouse details. Adding a warehouse with the same identifier again will update the previously saved warehouse. The method does not allow editing warehouses created automatically for external stocks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Warehouse name. Required field with maximum length of 100 characters. |
| `description` | string | No | Warehouse description. Optional text field providing additional information about the warehouse. |
| `warehouse_id` | integer | No | 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.). |
| `stock_edition` | boolean | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Invoice

**Slug:** `BASELINKER_ADD_INVOICE`

Tool to issue an order invoice in BaseLinker. Use when you need to generate an invoice for an existing order using a specific numbering series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order Identifier from BaseLinker order manager |
| `vat_rate` | string | No | 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. |
| `series_id` | integer | Yes | Series numbering identifier. Use getSeries to retrieve available series IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Invoice Correction

**Slug:** `BASELINKER_ADD_INVOICE_CORRECTION`

Tool to issue an order invoice correction. Use when correcting pricing errors, handling returns, or updating invoice data. Either original_invoice_id or return_order_id must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | No | Array of items to correct. Required when correcting_items=1 |
| `date_sell` | integer | No | Sale date as Unix timestamp |
| `fv_person` | string | No | Name of the person issuing the invoice |
| `series_id` | integer | No | Numbering series ID for the invoice correction |
| `fv_payment` | string | No | Payment method description |
| `invoice_nip` | string | No | Tax identification number (VAT ID) |
| `invoice_city` | string | No | Invoice recipient city |
| `invoice_state` | string | No | Invoice recipient state/province |
| `correcting_data` | integer | No | Whether to correct invoice data: 0=no, 1=yes |
| `invoice_address` | string | No | Invoice recipient street address |
| `invoice_company` | string | No | Invoice recipient company name |
| `return_order_id` | integer | No | Return order ID - if supplied, all other fields except series_id are ignored and invoice is created using return order data |
| `correcting_items` | integer | No | Whether to correct invoice items: 0=no, 1=yes |
| `invoice_fullname` | string | No | Invoice recipient full name |
| `invoice_postcode` | string | No | Invoice recipient postcode |
| `correcting_reason` | integer | No | 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 |
| `original_invoice_id` | integer | No | Original invoice ID to correct. Either this or return_order_id must be provided |
| `invoice_country_code` | string | No | Two-letter country code (ISO 3166-1 alpha-2) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order

**Slug:** `BASELINKER_ADD_ORDER`

Tool to add a new order to the BaseLinker order manager. Use when you need to create a new order with customer details, products, and delivery information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paid` | boolean | Yes | Whether the order is already paid. Value 'true' automatically adds a full payment. |
| `email` | string | No | Buyer's email address |
| `phone` | string | No | Buyer's phone number |
| `currency` | string | Yes | 3-letter currency code (e.g., USD, EUR, PLN) |
| `date_add` | integer | Yes | Date of order creation in unix timestamp format |
| `products` | array | Yes | Order product array. At least one product is required. |
| `user_login` | string | No | Allegro or eBay user login |
| `invoice_nip` | string | No | Billing details - VAT registration number/tax number |
| `invoice_city` | string | No | Billing details - city |
| `want_invoice` | boolean | No | Flag indicating whether the customer wants an invoice |
| `delivery_city` | string | No | Delivery address - city |
| `extra_field_1` | string | No | Value of 'additional field 1' - seller can store any information |
| `extra_field_2` | string | No | Value of 'additional field 2' - seller can store any information |
| `invoice_state` | string | No | Billing details - state/province |
| `user_comments` | string | No | Buyer's written comments |
| `admin_comments` | string | No | Seller's internal comments |
| `delivery_price` | number | No | Gross delivery price |
| `delivery_state` | string | No | Delivery address - state/province |
| `payment_method` | string | Yes | Payment method name |
| `delivery_method` | string | No | Delivery method name |
| `invoice_address` | string | No | Billing details - street and house number |
| `invoice_company` | string | No | Billing details - company name |
| `order_status_id` | integer | Yes | Order status ID. Use GetOrderStatusList to retrieve available status IDs. |
| `custom_source_id` | integer | No | Identifier of custom order source from BaseLinker panel |
| `delivery_address` | string | No | Delivery address - street and number |
| `delivery_company` | string | No | Delivery address - company name |
| `invoice_fullname` | string | No | Billing details - name and surname |
| `invoice_postcode` | string | No | Billing details - postal code |
| `delivery_fullname` | string | No | Delivery address - name and surname |
| `delivery_point_id` | string | No | Pick-up point delivery - pick-up point identifier |
| `delivery_postcode` | string | No | Delivery address - postal code |
| `payment_method_cod` | boolean | Yes | Flag indicating whether the payment type is COD (cash on delivery) |
| `custom_extra_fields` | array | No | List of custom extra fields with field_id and value pairs |
| `delivery_point_city` | string | No | Pick-up point delivery - pick-up point city |
| `delivery_point_name` | string | No | Pick-up point delivery - pick-up point name |
| `invoice_country_code` | string | No | Billing details - country code (two-letter, e.g., US, GB) |
| `delivery_country_code` | string | No | Delivery address - country code (two-letter, e.g., US, GB) |
| `delivery_point_address` | string | No | Pick-up point delivery - pick-up point address |
| `delivery_point_postcode` | string | No | Pick-up point delivery - pick-up point postcode |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order By Split

**Slug:** `BASELINKER_ADD_ORDER_BY_SPLIT`

Tool to create a new order by splitting selected products from an existing order. Use when you need to split an order into multiple shipments or separate deliveries. The new order inherits all customer details, addresses, and settings from the original order, with only the specified products and optional delivery costs moved to it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | The BaseLinker order ID of the original order to split from. |
| `items_to_split` | array | Yes | 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. |
| `delivery_cost_to_split` | number | No | The shipping/delivery cost amount to allocate to the new order. If not specified, delivery cost remains with the original order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order Duplicate

**Slug:** `BASELINKER_ADD_ORDER_DUPLICATE`

Tool to add a new order by duplicating an existing order in BaseLinker. The new order will have the same data as the original order but with a different ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | The ID of the existing order to duplicate. Must be a valid order ID in BaseLinker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order Return

**Slug:** `BASELINKER_ADD_ORDER_RETURN`

Tool to add a new order return to BaseLinker. Use when creating a return for an order. Requires status_id (get from getOrderReturnStatusList), date_add (Unix timestamp), currency (3-letter code), and refunded status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Buyer email address |
| `phone` | string | No | Buyer phone number |
| `currency` | string | Yes | 3-letter currency code (e.g., EUR, PLN, USD) |
| `date_add` | integer | Yes | Date of order return creation in Unix timestamp format |
| `order_id` | integer | No | Order ID in BaseLinker panel |
| `products` | array | No | List of products being returned |
| `refunded` | boolean | No | Whether the order return is already refunded |
| `status_id` | integer | Yes | Order return status ID (retrieve available statuses with getOrderReturnStatusList) |
| `user_login` | string | No | Marketplace user login |
| `refund_iban` | string | No | IBAN of the bank account |
| `refund_swift` | string | No | SWIFT of the bank account |
| `delivery_city` | string | No | Delivery address - city |
| `extra_field_1` | string | No | Value of additional field 1 |
| `extra_field_2` | string | No | Value of additional field 2 |
| `admin_comments` | string | No | Seller comments |
| `delivery_price` | number | No | Gross delivery price |
| `delivery_state` | string | No | Delivery address - state/province |
| `custom_source_id` | integer | No | Identifier of custom order source defined in BaseLinker panel. If not provided, default order return source is assigned. |
| `delivery_address` | string | No | Delivery address - street and number |
| `delivery_company` | string | No | Delivery address - company |
| `reference_number` | string | No | Reference number from external source |
| `delivery_fullname` | string | No | Delivery address - name and surname |
| `delivery_postcode` | string | No | Delivery address - postcode |
| `custom_extra_fields` | array | No | List of custom extra fields for the order return |
| `delivery_country_code` | string | No | Delivery address - two-letter country code (e.g., EN, US) |
| `refund_account_number` | string | No | Bank account number to issue a refund |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order Return Product

**Slug:** `BASELINKER_ADD_ORDER_RETURN_PRODUCT`

Tool to add a new product to an existing order return in BaseLinker. Use when a customer is returning items and you need to register the returned products.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Shop Category

**Slug:** `BASELINKER_ADD_SHOP_CATEGORY`

Tool to add a new category to BaseLinker storage (shops, warehouses, or BaseLinker inventory). Use when you need to create a new category in a connected storage's category structure. Requires a storage_id which can be obtained from GetExternalStoragesList or use 'bl_1' for BaseLinker inventory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Category name to be added to the store. |
| `parent_id` | string | Yes | Parent category ID. Use '0' for root-level categories. |
| `storage_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Package Manual

**Slug:** `BASELINKER_CREATE_PACKAGE_MANUAL`

Tool to register shipping details for orders when shipments are created outside BaseLinker. Use when you need to add tracking numbers and courier information for manually created shipments. Supports marking packages as return shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order identifier from BaseLinker order manager. |
| `pickup_date` | integer | Yes | Date of dispatch in Unix timestamp format (seconds since epoch). |
| `courier_code` | string | Yes | Courier code retrieved with getCouriersList or custom courier name (e.g., 'dhl', 'ups', 'fedex'). |
| `package_number` | string | Yes | Shipping/consignment tracking number assigned by the courier. |
| `return_shipment` | boolean | No | If true, marks package as a return shipment. Default: false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory

**Slug:** `BASELINKER_DELETE_INVENTORY`

Tool to delete a catalog from BaseLinker storage. Use when you need to permanently remove an inventory/catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_id` | integer | Yes | Catalog identifier to delete. Obtainable via getInventories method. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Category

**Slug:** `BASELINKER_DELETE_INVENTORY_CATEGORY`

Tool to remove categories from BaseLinker warehouse. Along with the category, the products contained therein are removed (however, this does not apply to products in subcategories). The subcategories will be changed to the highest level categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | The ID of the category to remove from BaseLinker warehouse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Manufacturer

**Slug:** `BASELINKER_DELETE_INVENTORY_MANUFACTURER`

Tool to remove a manufacturer from the BaseLinker catalog. Use when you need to delete a manufacturer that is no longer needed or was added by mistake.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manufacturer_id` | integer | Yes | The ID of the manufacturer to remove from BaseLinker catalog. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Payer

**Slug:** `BASELINKER_DELETE_INVENTORY_PAYER`

Tool to remove a payer from BaseLinker storage. Use when you need to delete an existing payer entry by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payer_id` | integer | Yes | The identifier of the payer to be removed from BaseLinker storage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Price Group

**Slug:** `BASELINKER_DELETE_INVENTORY_PRICE_GROUP`

Tool to remove a price group from BaseLinker storage. Use when you need to delete an existing price group by its identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price_group_id` | integer | Yes | Price group identifier to be deleted from BaseLinker storage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Product

**Slug:** `BASELINKER_DELETE_INVENTORY_PRODUCT`

Tool to remove a product from the BaseLinker catalog. Use when you need to permanently delete an inventory product by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | BaseLinker inventory product identifier to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Warehouse

**Slug:** `BASELINKER_DELETE_INVENTORY_WAREHOUSE`

Tool to remove a warehouse from BaseLinker inventories. Use when you need to delete a warehouse that is no longer needed. Note: This method does not allow removal of warehouses created automatically for external stock management (shops, wholesalers, etc.).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `warehouse_id` | integer | Yes | ID of the warehouse to remove from BaseLinker inventories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Product

**Slug:** `BASELINKER_DELETE_ORDER_PRODUCT`

Tool to remove a specific product from an order in BaseLinker. Use when you need to delete an order item without canceling the entire order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order ID from BaseLinker order manager. |
| `order_product_id` | integer | Yes | Order item ID from BaseLinker order manager. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Return Product

**Slug:** `BASELINKER_DELETE_ORDER_RETURN_PRODUCT`

Tool to remove a specific product from an order return in BaseLinker. Use when you need to delete a product item from an existing return request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_id` | integer | Yes | The identifier for the order return from which the product will be removed. |
| `order_return_product_id` | integer | Yes | The identifier of the specific product item to delete from the return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Orders

**Slug:** `BASELINKER_DELETE_ORDERS`

Tool to delete multiple orders from BaseLinker order manager. Use when you need to permanently remove orders from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_ids` | array | Yes | Array of order IDs to delete from BaseLinker order manager. Must contain at least one order ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Connect Integration Contractors

**Slug:** `BASELINKER_GET_CONNECT_INTEGRATION_CONTRACTORS`

Tool to retrieve a list of contractors connected to a selected Base Connect integration. Use when you need to discover available contractors for a specific integration before performing contractor-specific operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration_id` | integer | Yes | The identifier of the Base Connect integration to retrieve contractors from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Connect Integrations

**Slug:** `BASELINKER_GET_CONNECT_INTEGRATIONS`

Tool to retrieve a list of all Base Connect integrations on this account. Returns both integrations created on the account and integrations to which the account has connected.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Courier Accounts

**Slug:** `BASELINKER_GET_COURIER_ACCOUNTS`

Tool to retrieve the list of accounts connected to a given courier. Use when you need to identify available courier accounts before performing shipping operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `courier_code` | string | Yes | Courier code to retrieve accounts for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Courier Fields

**Slug:** `BASELINKER_GET_COURIER_FIELDS`

Tool to retrieve the form fields required for creating shipments with a specific courier. Use when you need to discover which fields are required or optional for shipment creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `courier_code` | string | Yes | Courier code that identifies which shipping provider to query for form fields (e.g., 'dpd', 'ups', 'fedex'). Maximum 20 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Courier Packages Status History

**Slug:** `BASELINKER_GET_COURIER_PACKAGES_STATUS_HISTORY`

Tool to retrieve the history of status changes for courier packages. Use when you need to track the delivery progress of shipments through their complete status timeline. Returns chronological status updates for up to 100 packages per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_ids` | array | Yes | An array with a list of parcel IDs. Maximum 100 shipments at a time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Couriers List

**Slug:** `BASELINKER_GET_COURIERS_LIST`

Tool to retrieve a list of available couriers from BaseLinker. Use when you need to discover which shipping carriers are configured before creating packages or querying courier-specific fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get External Storage Products Quantity

**Slug:** `BASELINKER_GET_EXTERNAL_STORAGE_PRODUCTS_QUANTITY`

Retrieve stock quantities from an external storage (shop/wholesaler) connected to BaseLinker. Use this tool to check current inventory levels for products in external integrations. Returns product IDs with their quantities, including variant-level stock if applicable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Optional page number for pagination when dealing with large product datasets. Returns subsequent pages of results. |
| `storage_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get External Storages List

**Slug:** `BASELINKER_GET_EXTERNAL_STORAGES_LIST`

Retrieve a list of external storages (shops, warehouses, wholesalers) connected to BaseLinker that can be referenced via API. Returns storage IDs (e.g., 'shop_2444', 'warehouse_1334'), names, and supported API methods for each storage. Use this to discover available integrations before calling storage-specific methods like getExternalStorageProductsList.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventories

**Slug:** `BASELINKER_GET_INVENTORIES`

Tool to retrieve a list of catalogs (inventories) available in the BaseLinker storage. Use when you need to discover available catalogs and their configurations before performing inventory-specific operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Available Text Field Keys

**Slug:** `BASELINKER_GET_INVENTORY_AVAILABLE_TEXT_FIELD_KEYS`

Tool to retrieve a list of product text fields that can be overwritten for a specific integration. Use when you need to discover which text fields are available for modification within a given inventory catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved by the getInventories method (inventory_id field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Categories

**Slug:** `BASELINKER_GET_INVENTORY_CATEGORIES`

Tool to retrieve a list of categories for a BaseLinker catalog. Use when you need to fetch category hierarchies for inventory management or product organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Document Items

**Slug:** `BASELINKER_GET_INVENTORY_DOCUMENT_ITEMS`

Tool to retrieve items from inventory documents in BaseLinker. Use when you need to fetch product details from a specific document with support for pagination (100 items per page).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (100 items per page). If not specified, returns first page. |
| `document_id` | integer | Yes | Inventory document ID to retrieve items from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Documents

**Slug:** `BASELINKER_GET_INVENTORY_DOCUMENTS`

Tool to retrieve a list of inventory documents. Use when you need to fetch inventory records with optional filters for ID, type, status, date range, warehouse, or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results (max 100 documents per page). |
| `filter_date_to` | integer | No | Maximum creation date (Unix timestamp) to filter by. |
| `filter_date_from` | integer | No | Minimum creation date (Unix timestamp) to filter by. |
| `filter_document_id` | integer | No | Specific inventory document ID to filter by. |
| `filter_warehouse_id` | integer | No | Warehouse ID to filter by. |
| `filter_document_type` | integer ("0" | "1" | "2" | "3" | "4" | "5") | No | Document type to filter by: 0=GR, 1=IGR, 2=GI, 3=IGI, 4=IT, 5=OB. |
| `filter_document_status` | integer ("0" | "1") | No | Document status to filter by: 0=Draft, 1=Confirmed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Document Series

**Slug:** `BASELINKER_GET_INVENTORY_DOCUMENT_SERIES`

Tool to retrieve available inventory document series. Use when you need to assign a numbering series to a new inventory document.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Extra Fields

**Slug:** `BASELINKER_GET_INVENTORY_EXTRA_FIELDS`

Tool to retrieve extra fields defined for BaseLinker catalog inventory items. Use before fetching or updating inventory products to list available custom fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Integrations

**Slug:** `BASELINKER_GET_INVENTORY_INTEGRATIONS`

Tool to retrieve a list of integrations where text values in the catalog can be overwritten. Use when you need to discover which sales channels support text customization and what languages are available for each integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved by the getInventories method (inventory_id field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Manufacturers

**Slug:** `BASELINKER_GET_INVENTORY_MANUFACTURERS`

Tool to retrieve a list of manufacturers from the BaseLinker catalog. Use when you need to view all manufacturers available in the system before adding or modifying manufacturer information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Payers

**Slug:** `BASELINKER_GET_INVENTORY_PAYERS`

Tool to retrieve a list of payers available in BaseLinker storage. Use when you need to list payers, optionally filtered by ID or name.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Price Groups

**Slug:** `BASELINKER_GET_INVENTORY_PRICE_GROUPS`

Tool to retrieve price groups existing in BaseLinker storage. Use when you need to discover available pricing tiers before assigning them to inventory items or performing price-related operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Printout Templates

**Slug:** `BASELINKER_GET_INVENTORY_PRINTOUT_TEMPLATES`

Tool to retrieve a list of all configured printout templates available for inventory (products). Use when you need to discover available printout templates before generating product documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Product Logs

**Slug:** `BASELINKER_GET_INVENTORY_PRODUCT_LOGS`

Tool to retrieve a list of events related to product changes in the BaseLinker catalog. Use when tracking product modification history, auditing changes, or monitoring inventory updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Results page number. Returns 100 product events per page. |
| `sort` | string ("ASC" | "DESC") | No | Sort order for logs. |
| `date_to` | integer | No | Unix timestamp. Only return logs up to this date. |
| `log_type` | string ("stock_change" | "price_change" | "product_creation" | "product_deletion" | "text_fields_modifications" | "locations_modifications" | "links_modifications" | "gallery_modifications" | "variant_modifications" | "bundle_products_modifications") | No | Log type classifications for product events. |
| `date_from` | integer | No | Unix timestamp. Only return logs from this date onwards. |
| `product_id` | integer | Yes | Product identifier. For retrieving variant logs, provide the variant identifier as the product identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Products Data

**Slug:** `BASELINKER_GET_INVENTORY_PRODUCTS_DATA`

Tool to retrieve detailed data for selected products from the BaseLinker inventory. Use when you need comprehensive product information including SKU, prices, stock, dimensions, descriptions, images, variants, and bundle details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `products` | array | Yes | An array of product ID numbers to download |
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved using the method getInventories. |
| `include_erp_units` | boolean | No | Include ERP units in the response. Only available for inventories with purchase cost calculations system different than AVCO. |
| `include_suppliers` | boolean | No | Include suppliers data in the response. |
| `include_wms_units` | boolean | No | Include WMS units in the response. Only available for inventories with enabled advanced warehouse management system. |
| `include_additional_eans` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Products List

**Slug:** `BASELINKER_GET_INVENTORY_PRODUCTS_LIST`

Tool to retrieve basic data of chosen products from BaseLinker catalogs. Use when you need to list products with optional filtering by ID, category, EAN, SKU, name, price range, or stock levels. Supports pagination for large catalogs (1000 products per page).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Results paging (1000 products per page for BaseLinker warehouse) |
| `filter_id` | integer | No | Narrows results to a specific product ID |
| `filter_ean` | string | No | Limits results to a specific EAN code |
| `filter_sku` | string | No | Limiting the results to a specific SKU (stock keeping number) |
| `filter_name` | string | No | Filters by product name or partial name match |
| `filter_sort` | string | No | The value for sorting the product list. Possible values: 'id [ASC\|DESC]' |
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved using the method getInventories. |
| `filter_price_to` | number | No | Sets maximum price threshold |
| `filter_stock_to` | integer | No | Sets maximum quantity threshold |
| `include_variants` | boolean | No | Include product variants alongside main products |
| `filter_price_from` | number | No | Sets minimum price threshold |
| `filter_stock_from` | integer | No | Sets minimum quantity threshold |
| `filter_category_id` | integer | No | Retrieves products from a particular category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Products Prices

**Slug:** `BASELINKER_GET_INVENTORY_PRODUCTS_PRICES`

Retrieve gross prices of products from BaseLinker inventories. Use when you need to get pricing information for products and their variants across different price groups. Supports pagination for large product catalogs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Results paging (1000 products per page for BaseLinker warehouse). Start from 0 for the first page. |
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved using the method getInventories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Products Stock

**Slug:** `BASELINKER_GET_INVENTORY_PRODUCTS_STOCK`

Tool to retrieve stock data of products from BaseLinker catalogs. Use when you need to check current inventory levels, reservations, or variant stock across warehouses. Results are paginated at 1000 products per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Results paging (1000 products per page for BaseLinker warehouse). Use for iterating through large inventories. |
| `inventory_id` | integer | Yes | Catalog ID. Retrieve available catalog IDs using the getInventories method (inventory_id field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Purchase Order Items

**Slug:** `BASELINKER_GET_INVENTORY_PURCHASE_ORDER_ITEMS`

Tool to retrieve items from a specific purchase order in BaseLinker. Use when you need to fetch product details from a purchase order with support for pagination (100 items per page).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (100 items per page). If not specified, returns first page. |
| `order_id` | integer | Yes | Purchase order identifier to retrieve items from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Purchase Orders

**Slug:** `BASELINKER_GET_INVENTORY_PURCHASE_ORDERS`

Tool to retrieve a list of purchase orders from BaseLinker storage. Use when you need to fetch purchase orders with optional filters like date range, supplier or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results (100 purchase orders per page). |
| `date_to` | integer | No | Unix timestamp up to which purchase orders should be retrieved. |
| `date_from` | integer | No | Unix timestamp from which purchase orders should be retrieved. |
| `series_id` | integer | No | Limit results to a specific document series ID. |
| `supplier_id` | integer | No | Limit results to a specific supplier ID. |
| `warehouse_id` | integer | No | Filter by warehouse identifier. Use to limit results to purchase orders for a specific warehouse. |
| `filter_document_number` | string | No | Filter by document number (full or partial match). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Purchase Order Series

**Slug:** `BASELINKER_GET_INVENTORY_PURCHASE_ORDER_SERIES`

Tool to retrieve a list of purchase order document series. Use when you need to select a numbering series for a new purchase order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `warehouse_id` | integer | No | Filter series by warehouse ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Suppliers

**Slug:** `BASELINKER_GET_INVENTORY_SUPPLIERS`

Tool to retrieve a list of suppliers available in BaseLinker storage. Use when you need to list suppliers, optionally filtered by ID or name.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Tags

**Slug:** `BASELINKER_GET_INVENTORY_TAGS`

Tool to retrieve a list of tags for a BaseLinker catalog. Use when you need to view all tags available in the system before categorizing or filtering inventory items.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Warehouses

**Slug:** `BASELINKER_GET_INVENTORY_WAREHOUSES`

Tool to retrieve a list of warehouses available in BaseLinker inventories. Use when you need to discover available warehouse locations before performing inventory or stock operations. Returns warehouses created manually as well as those created automatically for external stocks (shops, wholesalers).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice File

**Slug:** `BASELINKER_GET_INVOICE_FILE`

Tool to retrieve an invoice file from BaseLinker in base64-encoded format. Use when you need to download an invoice document generated by BaseLinker or from an external accounting system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | The BaseLinker invoice identifier number |
| `get_external` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoices

**Slug:** `BASELINKER_GET_INVOICES`

Download invoices from BaseLinker order manager with optional filtering. Use this tool to: - Fetch all invoices from a specific date onwards - Retrieve a single invoice by ID or order ID - Filter invoices by numbering series - Paginate through invoices using id_from parameter Returns up to 100 invoices per request. Use getSeries to get available series IDs for filtering.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Journal List

**Slug:** `BASELINKER_GET_JOURNAL_LIST`

Tool to download order event logs from the last 3 days. Use when you need to track order activities, changes, or events. IMPORTANT: This method must be activated by BaseLinker support on your account. If not activated, it returns an empty response. Events include order creation, status changes, payments, invoices, receipts, product modifications, and package operations. Use last_log_id to paginate through results incrementally.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | No | Order ID number to filter events for a specific order. |
| `logs_types` | array | No | 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. |
| `last_log_id` | integer | No | Log ID number from which the logs are to be retrieved. Use to paginate through results. Must be greater than zero. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get New Receipts

**Slug:** `BASELINKER_GET_NEW_RECEIPTS`

Tool to retrieve receipts waiting to be issued. Use after confirming fiscal printer availability; fetch pending receipts and mark them with setOrderReceipt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_from` | integer | No | Retrieve receipts with receipt_id greater than this value. Defaults to 0 if omitted. |
| `series_id` | integer | No | Filter receipts by numbering series ID. Use separate series when multiple fiscal printers exist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Extra Fields

**Slug:** `BASELINKER_GET_ORDER_EXTRA_FIELDS`

Tool to retrieve extra fields defined for orders. Use before fetching orders with include_custom_extra_fields to list available custom order fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Packages

**Slug:** `BASELINKER_GET_ORDER_PACKAGES`

Tool to download shipments previously created for a selected order. Use when you need to retrieve tracking numbers, courier information, and delivery status for order packages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order identifier from BaseLinker order manager. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Payments History

**Slug:** `BASELINKER_GET_ORDER_PAYMENTS_HISTORY`

Tool to retrieve payment history for a selected order, including external payment identifiers from payment gateways. Use when you need to track payment events for an order. One order can have multiple payment history entries due to surcharges, order value changes, or manual payment editing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order identifier from BaseLinker order manager |
| `show_full_history` | boolean | No | Download full payment history, including order value change entries and manual order payment edits. Default: false |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Pick Pack History

**Slug:** `BASELINKER_GET_ORDER_PICK_PACK_HISTORY`

Tool to retrieve pick and pack history for a selected order. Use when you need to track the fulfillment timeline and events for an order (reservations, picking, packing, photography). Returns chronological list of pick/pack events with timestamps and responsible profiles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order identifier from BaseLinker order manager |
| `action_type` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Printout Templates

**Slug:** `BASELINKER_GET_ORDER_PRINTOUT_TEMPLATES`

Tool to retrieve a list of all configured printout templates available for orders. Use when you need to discover available printout templates before generating order documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Extra Fields

**Slug:** `BASELINKER_GET_ORDER_RETURN_EXTRA_FIELDS`

Tool to retrieve extra fields defined for order returns. Use before calling getOrderReturns with include_custom_extra_fields to list available custom fields. Field values can be set via setOrderReturnFields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Journal List

**Slug:** `BASELINKER_GET_ORDER_RETURN_JOURNAL_LIST`

Tool to download return event logs from the last 3 days in BaseLinker. Use when tracking return order history, monitoring return status changes, or auditing return-related activities. Returns events like return creation, status changes, product modifications, and refund creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_id` | integer | No | Return ID number to filter events for a specific return order. |
| `logs_types` | array | No | 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). |
| `last_log_id` | integer | No | Log ID number from which the logs are to be retrieved. Use this to paginate through results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Payments History

**Slug:** `BASELINKER_GET_ORDER_RETURN_PAYMENTS_HISTORY`

Tool to retrieve payment history for a selected order return, including external payment identifiers from the payment gateway. Use when you need to track payment events, surcharges, order value changes, or manual payment edits for a return.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_id` | integer | Yes | Order return identifier |
| `show_full_history` | boolean | No | Download full payment history including order value changes and manual edits. Default: false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Product Statuses

**Slug:** `BASELINKER_GET_ORDER_RETURN_PRODUCT_STATUSES`

Tool to retrieve a list of order return product statuses from BaseLinker. Use when you need to identify valid status IDs for return items, or to map status IDs to human-readable names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Reasons List

**Slug:** `BASELINKER_GET_ORDER_RETURN_REASONS_LIST`

Tool to retrieve a list of order return reasons. Use when you need to discover available return reasons before setting return fields with setOrderReturnFields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Returns

**Slug:** `BASELINKER_GET_ORDER_RETURNS`

Download order returns from BaseLinker return manager with optional filtering. Use this tool to: - Fetch returns from a specific date onwards using date_from parameter - Retrieve a single return by return_id - Filter returns by source order, status, or marketplace source - Paginate through returns using id_from parameter Returns up to 100 order returns per request. For complete return data including custom fields, set include_custom_extra_fields=true. Use include_connect_data=true for Base Connect integration info.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Return Status List

**Slug:** `BASELINKER_GET_ORDER_RETURN_STATUS_LIST`

Tool to retrieve order return statuses created in the BaseLinker order manager. Use when you need to map return status IDs to human-readable names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders

**Slug:** `BASELINKER_GET_ORDERS`

Download orders from BaseLinker order manager with optional filtering. Use this tool to: - Fetch all orders from a specific date onwards - Retrieve a single order by ID - Filter orders by status, email, or marketplace source - Paginate through orders using id_from parameter Returns up to 100 orders per request. For confirmed orders only, omit get_unconfirmed_orders. Tip: Use getOrderStatusList to get status IDs for filtering.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders by Phone

**Slug:** `BASELINKER_GET_ORDERS_BY_PHONE`

Search for orders associated with a specific phone number in BaseLinker. Use when identifying callers in phone recognition systems or finding order history by phone. Returns basic order information including status, recipient names, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Sources

**Slug:** `BASELINKER_GET_ORDER_SOURCES`

Tool to retrieve types of order sources along with their IDs from BaseLinker. Use when you need to understand available order sources for filtering orders or mapping order_source field values from getOrders method.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Status List

**Slug:** `BASELINKER_GET_ORDER_STATUS_LIST`

Tool to retrieve a list of order statuses created in the BaseLinker order manager. Use when you need to map status IDs to human-readable names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Transaction Data

**Slug:** `BASELINKER_GET_ORDER_TRANSACTION_DATA`

Tool to retrieve transaction details for a selected order. Use when you need marketplace transaction IDs, fulfillment data, or detailed tax breakdowns for an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order identifier from BaseLinker order manager |
| `include_amazon_data` | boolean | No | Include legacy Amazon fulfillment data for backward compatibility. Default: true |
| `include_complex_taxes` | boolean | No | Include detailed tax breakdown with order_lines structure in order_items. Default: false |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Package Details

**Slug:** `BASELINKER_GET_PACKAGE_DETAILS`

Tool to get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response. Use when you need comprehensive package dimensions, weight, COD, insurance, and shipping cost details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | integer | Yes | The unique identifier of the package for which you want to retrieve details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PickPack Carts

**Slug:** `BASELINKER_GET_PICK_PACK_CARTS`

Tool to retrieve a list of all PickPack carts belonging to the authenticated user. Use when you need to discover available carts and their details (ID, name, color) before performing cart-specific operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Protocol

**Slug:** `BASELINKER_GET_PROTOCOL`

Tool to download a parcel protocol for selected shipments. Use when you need to retrieve shipping protocol documents (PDF or HTML) for packages sent via a courier. The protocol is available only if supported by the chosen courier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Courier API account identifier. Retrieve account IDs using getCourierAccounts for the specified courier. |
| `package_ids` | array | No | Array of shipment identifiers. Either package_ids or package_numbers must be provided, not both. |
| `courier_code` | string | Yes | Courier code for which to retrieve the protocol. Use codes from getCouriersList. |
| `package_numbers` | array | No | Array of shipment consignment numbers. Either package_ids or package_numbers must be provided, not both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receipts

**Slug:** `BASELINKER_GET_RECEIPTS`

Tool to retrieve issued receipts from BaseLinker. Use when you need to fetch historical receipt data. Max 100 receipts returned per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_to` | integer | No | Sets the end date for receipt collection in Unix timestamp format. |
| `id_from` | integer | No | Specifies the receipt ID from which subsequent receipts will be retrieved (inclusive). |
| `date_from` | integer | No | Sets the start date for receipt collection in Unix timestamp format. |
| `series_id` | integer | No | Enables filtering results by receipt numbering series identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Request Parcel Pickup Fields

**Slug:** `BASELINKER_GET_REQUEST_PARCEL_PICKUP_FIELDS`

Tool to retrieve additional fields for a parcel pickup request from a specific courier. Use when preparing to request a parcel pickup and need to know which additional information the courier requires (e.g., pickup time, contact details, special instructions).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `courier_code` | string | Yes | Courier identifier code (e.g., 'dpd', 'inpost', 'dhl'). Maximum 20 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Series

**Slug:** `BASELINKER_GET_SERIES`

Tool to download invoice/receipt numbering series. Use when you need to retrieve all series configurations before issuing documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Storages List

**Slug:** `BASELINKER_GET_STORAGES_LIST`

Tool to download a list of available storages accessible via API. Use when you need to discover storage endpoints and capabilities before performing storage-specific operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Order Macro Trigger

**Slug:** `BASELINKER_RUN_ORDER_MACRO_TRIGGER`

Tool to run personal trigger for orders automatic actions. Use when you need to execute a specific automation trigger on an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | The ID of the order to run the trigger on |
| `trigger_id` | integer | Yes | The ID of the personal trigger to execute |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Product Macro Trigger

**Slug:** `BASELINKER_RUN_PRODUCT_MACRO_TRIGGER`

Tool to execute a personal trigger for products automatic actions. Use when you need to manually run a custom event trigger for a specific product in BaseLinker inventory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | Product identifier from BaseLinker product manager. |
| `trigger_id` | integer | Yes | Identifier of personal trigger from products automatic actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Request Parcel Pickup

**Slug:** `BASELINKER_RUN_REQUEST_PARCEL_PICKUP`

Tool to request a parcel pickup for previously created shipments. Use when you need to schedule a courier pickup for packages that have been created. The method sends a pickup request to the courier API if the courier supports it. Use getRequestParcelPickupFields first to check if the courier requires additional fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Optional array of additional fields required by the courier (e.g., pickup date, contact person). Use getRequestParcelPickupFields to determine required fields for the courier. |
| `account_id` | integer | Yes | The courier account identifier. Must be a positive integer. |
| `courier_code` | string | Yes | Courier identifier code (e.g., 'dpd', 'inpost', 'dhl'). Maximum 20 characters. |
| `package_numbers` | array | Yes | Array of package tracking numbers to request pickup for. Must contain at least one package number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Inventory Purchase Order Status

**Slug:** `BASELINKER_SET_INVENTORY_PURCHASE_ORDER_STATUS`

Tool to change the status of a purchase order in BaseLinker inventory. Use when you need to update a purchase order's status (e.g., mark as sent, received, completed, or canceled).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | integer ("0" | "1" | "2" | "3" | "4" | "5") | Yes | New status code: 0=draft, 1=sent, 2=received, 3=completed, 4=partially completed, 5=canceled. |
| `order_id` | integer | Yes | Purchase order identifier to update. |
| `completed_items` | array | No | List of items with their completion quantities. Each item includes item_id and completed_quantity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Fields

**Slug:** `BASELINKER_SET_ORDER_FIELDS`

Tool to edit selected fields of a specific order in BaseLinker. Use when you need to update order details such as address data, notes, payment method, delivery information, or invoice details. Only provide the fields you want to change; other fields can be omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Buyer's email address |
| `phone` | string | No | Buyer's phone number |
| `order_id` | integer | Yes | Order identifier from the BaseLinker order manager |
| `pack_state` | integer | No | Pack state: 0 = not packed, 1 = packed |
| `pick_state` | integer | No | Pick state: 0 = not picked, 1 = picked |
| `user_login` | string | No | Buyer's account name (Allegro or eBay user login) |
| `invoice_nip` | string | No | Billing details - VAT registration number/tax number |
| `invoice_city` | string | No | Billing details - city |
| `want_invoice` | boolean | No | Flag indicating whether the customer wants an invoice |
| `delivery_city` | string | No | Delivery address - city |
| `extra_field_1` | string | No | Value of 'additional field 1' - seller can store any information |
| `extra_field_2` | string | No | Value of 'additional field 2' - seller can store any information |
| `invoice_state` | string | No | Billing details - state/province |
| `user_comments` | string | No | Buyer's written comments |
| `admin_comments` | string | No | Seller's internal comments |
| `delivery_price` | number | No | Gross delivery price |
| `delivery_state` | string | No | Delivery address - state/province |
| `payment_method` | string | No | Payment method name |
| `delivery_method` | string | No | Delivery method name |
| `invoice_address` | string | No | Billing details - street and house number |
| `invoice_company` | string | No | Billing details - company name |
| `delivery_address` | string | No | Delivery address - street and number |
| `delivery_company` | string | No | Delivery address - company name |
| `invoice_fullname` | string | No | Billing details - name and surname |
| `invoice_postcode` | string | No | Billing details - postal code |
| `delivery_fullname` | string | No | Delivery address - recipient name and surname |
| `delivery_point_id` | string | No | Pick-up point delivery - pick-up point identifier |
| `delivery_postcode` | string | No | Delivery address - postal code |
| `payment_method_cod` | boolean | No | Flag indicating whether the payment type is COD (cash on delivery) |
| `custom_extra_fields` | array | No | List of custom extra fields with field_id and value pairs |
| `delivery_point_city` | string | No | Pick-up point delivery - pick-up point city |
| `delivery_point_name` | string | No | Pick-up point delivery - pick-up point name |
| `invoice_country_code` | string | No | Billing details - country code (two-letter, e.g., US, GB) |
| `delivery_country_code` | string | No | Delivery address - country code (two-letter, e.g., US, GB) |
| `delivery_point_address` | string | No | Pick-up point delivery - pick-up point address |
| `delivery_point_postcode` | string | No | Pick-up point delivery - pick-up point postcode |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Payment

**Slug:** `BASELINKER_SET_ORDER_PAYMENT`

Tool to add a payment to an order in BaseLinker. Use when recording a payment for an order. The payment amount replaces (not adds to) the current payment value; if it matches the order total, the order is marked as paid.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order ID number |
| `payment_date` | integer | Yes | Payment date as Unix timestamp |
| `payment_done` | number | Yes | The amount of the payment. The value changes the current payment in the order (not added to the previous value). If the amount matches the order value, the order will be marked as paid. |
| `payment_comment` | string | Yes | Payment commentary |
| `external_payment_id` | string | No | External payment identifier from payment gateway |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Product Fields

**Slug:** `BASELINKER_SET_ORDER_PRODUCT_FIELDS`

Tool to edit data of selected items in a specific BaseLinker order. Use when you need to update product fields like prices, quantities, SKU, or other item details. Only provide the fields you want to edit; other fields can be omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ean` | string | No | Product EAN number |
| `sku` | string | No | Product SKU number |
| `name` | string | No | Product name |
| `weight` | number | No | Single piece weight |
| `storage` | string ("db" | "shop" | "warehouse") | No | Storage type for the product. |
| `location` | string | No | Product location |
| `order_id` | integer | Yes | Order identifier from the BaseLinker order manager |
| `quantity` | integer | No | Number of pieces |
| `tax_rate` | number | No | VAT tax rate e.g. '23', (value from range 0-100) |
| `attributes` | string | No | The detailed product attributes, e.g. 'Colour: blue' |
| `auction_id` | string | No | Listing ID number (if the order comes from ebay/allegro) |
| `product_id` | string | No | Product identifier in BaseLinker or shop storage |
| `storage_id` | string | No | The identifier of the storage (inventory/shop/warehouse) |
| `variant_id` | string | No | Product variant ID number |
| `price_brutto` | number | No | Single item gross price |
| `warehouse_id` | integer | No | Product source warehouse identifier. Only applies to products |
| `order_product_id` | integer | Yes | Order item ID from BaseLinker order manager |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Receipt

**Slug:** `BASELINKER_SET_ORDER_RECEIPT`

Tool to mark orders with a receipt already issued. Use after printing receipts retrieved from getNewReceipts to confirm receipt issuance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | integer | Yes | Receipt printing date in Unix timestamp format. |
| `receipt_id` | integer | Yes | Receipt ID number received from the getNewReceipts method. |
| `receipt_nr` | string | Yes | The number of the issued receipt. May be blank if the printer does not return a number. |
| `printer_name` | string | No | Name identifying the printer device used for printing. |
| `printer_error` | boolean | Yes | Flag indicating receipt printing errors. Defaults to false if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Return Fields

**Slug:** `BASELINKER_SET_ORDER_RETURN_FIELDS`

Tool to edit selected fields of a specific order return. Use when updating return information such as buyer contact details, delivery address, or custom fields. Only the fields that need to be changed should be provided; other fields can be omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Buyer email address |
| `phone` | string | No | Buyer phone number |
| `return_id` | integer | Yes | Order return identifier |
| `user_login` | string | No | Buyer login |
| `delivery_city` | string | No | Delivery address - city |
| `extra_field_1` | string | No | Custom extra field 1 value |
| `extra_field_2` | string | No | Custom extra field 2 value |
| `admin_comments` | string | No | Seller comments |
| `delivery_price` | number | No | Gross delivery price |
| `delivery_state` | string | No | Delivery address - state/province |
| `delivery_address` | string | No | Delivery address - street and number |
| `delivery_company` | string | No | Delivery address - company |
| `delivery_fullname` | string | No | Delivery address - name and surname |
| `delivery_postcode` | string | No | Delivery address - postcode |
| `custom_extra_fields` | object | No | 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 |
| `delivery_country_code` | string | No | Delivery address - country code (two-letter format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Return Product Fields

**Slug:** `BASELINKER_SET_ORDER_RETURN_PRODUCT_FIELDS`

Tool to edit data of selected items (e.g., prices, quantities, attributes) of a specific order return product. Use when you need to update fields of a returned product in an order return.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ean` | string | No | Product EAN number |
| `sku` | string | No | Product SKU number |
| `name` | string | No | Product name |
| `weight` | number | No | Single piece weight in kilograms |
| `storage` | string | No | Product source type: 'db' (internal inventory), 'shop' (online shop), or 'warehouse' (wholesaler) |
| `location` | string | No | Product location in warehouse |
| `quantity` | integer | No | Number of pieces |
| `tax_rate` | number | No | VAT rate (0-100, or special values: -1 for exempt, -0.02 for NP, -0.03 for reverse charge) |
| `return_id` | integer | Yes | Order return identifier from the BaseLinker order manager |
| `status_id` | integer | No | Product return status identifier |
| `attributes` | string | No | Product attributes (e.g., 'Color: Red, Size: Large') |
| `auction_id` | string | No | Listing ID (for eBay/Allegro orders). Use for marketplace-originated products. |
| `product_id` | string | No | Product identifier in BaseLinker or shop storage |
| `storage_id` | string | No | Identifier of the storage source. Required when storage is 'shop' or 'warehouse'. |
| `variant_id` | string | No | Product variant ID. Specify if the product has variants (e.g., size, color). |
| `price_brutto` | number | No | Single item gross price (including tax) |
| `warehouse_id` | integer | No | Product source warehouse identifier |
| `return_reason_id` | integer | No | Return reason identifier |
| `order_return_product_id` | integer | Yes | Order return item ID from BaseLinker order manager. The specific product within the return to edit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Return Refund

**Slug:** `BASELINKER_SET_ORDER_RETURN_REFUND`

Tool to mark an order return as refunded in BaseLinker. Use when recording that a refund has been issued for a return. Note: This method doesn't issue an actual money refund - it only updates the refund status in BaseLinker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_id` | integer | Yes | Order return identifier. The ID of the return to mark as refunded. |
| `refund_date` | integer | Yes | Refund date in Unix timestamp format. The date when the refund was issued. |
| `refund_comment` | string | Yes | Refund commentary. A note describing the refund details or reason. |
| `order_refund_done` | number | Yes | The amount of the refund. The value changes the current refund in the order return (not added to the previous value). |
| `external_refund_id` | string | No | External refund identifier. Optional reference ID from external payment system or refund processor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Return Status

**Slug:** `BASELINKER_SET_ORDER_RETURN_STATUS`

Tool to change order return status in BaseLinker. Use when you need to update the status of a single order return.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_id` | integer | Yes | Order return ID number |
| `status_id` | integer | Yes | Status ID number. The status list can be retrieved using getOrderReturnStatusList |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Return Statuses

**Slug:** `BASELINKER_SET_ORDER_RETURN_STATUSES`

Tool to batch set order return statuses in BaseLinker. Use when you need to update the status of multiple order returns at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status_id` | integer | Yes | Order return status ID number. The status list can be retrieved using getOrderReturnStatusList |
| `return_ids` | array | Yes | Array of order return ID numbers to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Orders Merge

**Slug:** `BASELINKER_SET_ORDERS_MERGE`

Tool to merge multiple orders into one, based on the selected merge mode. Use when you need to combine orders together with either technical merge or into main order mode.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merge_mode` | string ("technical_merge" | "into_main_order") | Yes | Selection between 'technical_merge' (creates new technical order) or 'into_main_order' (moves items, deletes others) |
| `main_order_id` | integer | Yes | ID of the primary order whose shipping and invoice data will be retained |
| `order_ids_to_merge` | array | Yes | List of additional order IDs to merge; cannot include main_order_id |
| `sum_delivery_costs` | boolean | Yes | true = sum all shipping costs; false = keep main order's shipping cost only |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Status

**Slug:** `BASELINKER_SET_ORDER_STATUS`

Tool to change the status of an existing order in BaseLinker. Use when you need to update an order's status to a different value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Order ID number to update the status for. |
| `status_id` | integer | Yes | Status ID number to set for the order. The status list can be retrieved using GetOrderStatusList. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Order Statuses

**Slug:** `BASELINKER_SET_ORDER_STATUSES`

Tool to batch update order statuses in BaseLinker. Use when you need to set the same status for multiple orders at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_ids` | array | Yes | Collection of order ID numbers to update. At least one order ID is required. |
| `status_id` | integer | Yes | Status ID number to set for all specified orders. Use GetOrderStatusList to retrieve available status IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inventory Products Stock

**Slug:** `BASELINKER_UPDATE_INVENTORY_PRODUCTS_STOCK`

Tool to update stocks of products and their variants in BaseLinker catalog. Use when you need to modify inventory levels for products across warehouses. Maximum 1000 products per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `products` | object | Yes | 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. |
| `inventory_id` | integer | Yes | Catalog ID. The list of identifiers can be retrieved using the method getInventories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |