API documentation* In the event of a parameter format change/removal of a parameter/ method withdrawal, the existing integrations shall be supported in a backward compatibility. We recommend making modifications to systems using the API as soon as possible as compatibility is maintained for six months after the publication of the change.
| 2026-07-27 |
- (IMPORTANT) getInventoryManufacturers: Limited unpaginated responses to 10,000 manufacturers. |
| 2026-07-22 |
- getOrders: Added transaction_id field to order products in getOrders response, containing marketplace-specific item identifier. |
| 2026-07-15 |
- addInventoryTransfer: Added addInventoryTransfer method allowing the creation of a new inventory transfer in draft status. - addInventoryTransferItems: Added addInventoryTransferItems method allowing the addition of items to an inventory transfer. - getInventoryTransferItems: Added getInventoryTransferItems method allowing the retrieval of items from an inventory transfer. - getInventoryTransferSeries: Added getInventoryTransferSeries method allowing the retrieval of transfer numbering series. - getInventoryTransfers: Added getInventoryTransfers method allowing the retrieval of a list of inventory transfers. - setInventoryTransferStatus: Added setInventoryTransferStatus method allowing the change of an inventory transfer status. |
| 2026-07-08 |
- addInventoryPurchaseOrder: Added the additional_costs and packages parameters to addInventoryPurchaseOrder, allowing users to set additional costs and package tracking information when creating a purchase order. - (IMPORTANT) getCourierFields: Updated package_fields type: weight, size_length, size_width, size_height, and size_diameter can now be defined as int or float. Float types support an optional decimal_places information, depending on integration requirements. |
| 2026-07-02 |
- getInventoryProductsStock: Added variant_reservations output field to getInventoryProductsStock method, providing reservation quantities broken down by variant and warehouse for multi-variant products |
| 2026-07-01 |
- addInventoryProduct: Added support for channel-specific media in the 'images' and 'videos' parameters (keys "[position]|[source_id]") and added the new 'media_options' parameter for selecting how each channel resolves its media gallery (use default / separate / overwrite). - getInventoryProductsData: Added the optional 'include_channels_media' parameter; when enabled, the response 'images' and 'videos' lists additionally contain channel-specific keys ("[position]|[source_id]") and a new top-level 'media_options' map is returned per product (channel id -> use default / separate / overwrite). - getInventoryProductsStock: Added filter parameters (filter_id, filter_category_id, filter_ean, filter_sku, filter_name, filter_asin, filter_stock_from, filter_stock_to, filter_sort, filter_locations) to getInventoryProductsStock method, allowing to retrieve stock and reservations of specific products without paging through the whole catalog - addInventoryWarehouseRack: Added addInventoryWarehouseRack method, allowing you to add or update a warehouse rack. - addInventoryWarehouseZone: Added addInventoryWarehouseZone method, allowing you to add or update a warehouse zone. - deleteInventoryWarehouseRack: Added deleteInventoryWarehouseRack method, allowing you to delete a warehouse rack. - deleteInventoryWarehouseZone: Added deleteInventoryWarehouseZone method, allowing you to delete a warehouse zone. - getInventoryFulfillmentDeliveries: Added notes, external fulfillment delivery identifier, warehouse identifiers and shipment unit information, and multi-value status and fulfillment warehouse filters to fulfillment deliveries. - (IMPORTANT) getInventoryWarehouseLocations: Added optional filter parameters: filter_location_id, filter_name (with wildcard * support), filter_rack_id, filter_zone_id. - getInventoryWarehouseRacks: Added getInventoryWarehouseRacks method, allowing you to retrieve the list of warehouse racks. - getInventoryWarehouseZones: Added getInventoryWarehouseZones method, allowing you to retrieve the list of warehouse zones. |
| 2026-06-24 |
- getInventoryTags: Added tag_id field to each tag object in the output. - getOrderReturns: Added order_product_id field to products array in getOrderReturns response, allowing unique mapping of return items to original order items. - (FIXED) addInventoryFulfillmentDelivery: Improved error messages - the method now returns detailed validation error messages instead of a generic "Failed to save fulfillment delivery" message. - addInventoryTag: New method for creating and updating inventory tags. - deleteInventoryTag: New method for deleting inventory tags. |
| 2026-06-18 |
- addInventoryProduct: Added support for marketplace_category_id in text_fields parameter, allowing to set marketplace category per integration channel. For integrations with per-site categories (eBay, Amazon), a site component is required in the key (e.g. marketplace_category_id|ebay_123|us). - getInventoryProductsData: Added include_marketplace_categories input parameter and marketplace_category_id entries in text_fields output. For integrations with per-site categories (eBay, Amazon), the key includes a site component (e.g. marketplace_category_id|ebay_123|us). |
| 2026-06-17 |
- addInventoryPriceGroup: Added support for price group calculation options: price_group_type, source_price_group_id, price_multiplier, price_addition, is_bundle_price_calculated, bundle_price_multiplier, bundle_price_addition. - getInventoryPriceGroups: Added price group calculation fields to the output: price_group_type, source_price_group_id, price_multiplier, price_addition, is_bundle_price_calculated, bundle_price_multiplier, bundle_price_addition. - addInventoryWarehouse: Added optional address, postcode, city and country parameters for setting the warehouse address. - getInventoryWarehouses: Added address, postcode, city and country fields to warehouse data in the response. - getReceipts: Added currency field to the response - getReceipt: Added currency field to the response - addPickPackCart: Added new method allowing to add or update a PickPack cart - getPickPackCartOrders: Added new method allowing to retrieve all orders assigned to specific PickPack cart - getPickPackOrderCart: Added new method allowing to retrieve cart assignment information for a single order in the PickPack system - addPickPackOrdersToCart: Added new method allowing to assign multiple orders to specific PickPack cart - deletePickPackOrderFromCart: Added new method allowing to remove specific order from its assigned PickPack cart - deletePickPackCart: Added new method allowing to delete specific PickPack cart - deletePickPackCartOrders: Added new method allowing to remove all orders from specific PickPack cart |
| 2026-06-15 |
- addInventoryPurchaseOrderFile: Added addInventoryPurchaseOrderFile method, allowing you to upload a cost invoice PDF file to a purchase order. - getInventoryMapDetails: New method for retrieving detailed information about a warehouse map. - getInventoryMaps: New method for retrieving a list of warehouse maps. - getInventoryPurchaseOrderFile: Added getInventoryPurchaseOrderFile method, allowing you to download a cost invoice PDF file attached to a purchase order. |
| 2026-06-10 |
- getPackageDetails: Added service, additional_services and courier_packaging_type fields to package details. |
| 2026-06-08 |
- getInventoryFulfillmentDeliveryLabels: Added a method for downloading fulfillment delivery labels. |
| 2026-06-03 |
- getOrderStatusList: Added group_id and is_primary fields. - getOrderReturnStatusList: Added group_id and is_primary fields. |
| 2026-06-02 |
- addCrmClientStatus: Added new method allowing to create or update CRM client statuses. - addCrmClientStatusGroup: Added new method allowing to create or update CRM client status groups. - deleteCrmClientStatus: Added new method allowing to delete a CRM client status. - deleteCrmClientStatusGroup: Added new method allowing to delete a CRM client status group. - getOrderReturnStatusGroups: Added new method allowing to retrieve order return status groups. - getOrderStatusGroups: Added new method allowing to retrieve order status groups. |
| 2026-06-01 |
- addInventoryProduct: Added videos parameter to addInventoryProduct method allowing to add, update and delete product videos via URL or base64 data. - getInventoryProductsData: Added videos field to getInventoryProductsData response containing product video URLs. - addOrderReturnStatus: Added new method allowing to create or update order return statuses. - addOrderReturnStatusGroup: Added new method allowing to create or update order return status groups. - addOrderStatus: Added new method allowing to create or update order statuses. - addOrderStatusGroup: Added new method allowing to create or update order status groups. - deleteOrderReturnStatus: Added new method allowing to delete an order return status. - deleteOrderReturnStatusGroup: Added new method allowing to delete an order return status group. - deleteOrderStatus: Added new method allowing to delete an order status. - deleteOrderStatusGroup: Added new method allowing to delete an order status group. |
| 2026-05-27 |
- getInventoryProductsData: Added the optional 'include_relations' parameter; when enabled, the response contains a new 'relations' list per product with related product relationships (related, substitution, upsell, downsell, crosssell). |
| 2026-04-20 |
- (DEPRECATED) getInventoryDocuments: Deprecated connection_type and connection_id fields in getInventoryDocuments method response. Use source_object_type and source_object_id instead. |
| 2026-04-13 |
- getOrderReturns: Added refund_done parameter to getOrderReturns method returning the actual amount refunded to the buyer |
| 2026-03-24 |
- added filter_product_id parameter to getInventoryPurchaseOrders method allowing to filter purchase orders by product ID |
| 2026-03-23 |
- added new CRM API methods: addCrmClient, deleteCrmClient, getCrmClients, getCrmClientData, getCrmClientStatuses, getCrmClientStatusGroups - getOrders: Added filter_external_order_id parameter to getOrders method allowing filtering orders by the original order ID assigned by the marketplace or online store (e.g. Allegro transaction number, Amazon order number) |
| 2026-03-16 |
- added date_expected_delivery, additional_cost and cost_invoice_file fields to getInventoryPurchaseOrders method response |
| 2026-03-09 |
- getJournalList: Added new event type 22 (Package status change) to getJournalList method, providing package_id in object_id field |
| 2026-02-16 |
- added tax_no field support in getInventorySuppliers and addInventorySupplier methods - (DEPRECATED) setConnectContractorCreditLimit: Deprecated contractor_id parameter in setConnectContractorCreditLimit method. You should use connect_contractor_id instead. |
| 2026-01-27 |
- added target_location_name parameter to addInventoryDocumentItems and getInventoryDocumentItems methods for IT/MM transfer documents, allowing to specify both source and destination storage locations |
| 2026-01-26 |
- added date_delivery_expected parameter (unix timestamp) to addInventoryPurchaseOrder method allowing setting expected delivery date when creating purchase order - added parent_id field in getInventoryProductsData and getInventoryProductsList methods to identify parent product for variants - addInventoryDocument: Added notes parameter to addInventoryDocument method allowing to add notes/description to the document - getInventoryDocuments: Added notes field to getInventoryDocuments method response allowing to retrieve document notes/description - getOrderReturns: Added return_reason_comment field to getOrderReturns method response (in products array) exposing customer comment about return reason |
| 2026-01-20 |
- addInventoryDocument: Added the parameter 'notes' in the addInventoryDocument method. - getInventoryDocuments: Added connected_source_object_type and connected_source_object_id parameters to getInventoryDocuments method allowing filtering documents by connected source object - getInventoryDocuments: Added the notes, source_object_type and source_object_id fields to the getInventoryDocuments method |
| 2025-10-21 |
- (DEPRECATED) deprecated addConnectContractorCredit method. It will do nothing. - setConnectContractorCreditLimit: Added setConnectContractorCreditLimit method allowing setting trade credit limit |
| 2025-09-23 |
- added ASIN field support in product-related API methods: addInventoryProduct, getInventoryProductsData, getInventoryProductsList, addProduct, addProductVariant, getProductsData, getProductsList, getExternalStorageProductsData, getExternalStorageProductsList, addOrder and getOrders - addOrderDuplicate: Added addOrderDuplicate method allowing duplicating orders |
| 2025-09-15 |
- added getOrderPrintoutTemplates method allowing the listing orders printout templates - added getInventoryPrintoutTemplates method allowing listing inventory printout templates |
| 2025-09-08 |
- setOrdersMerge: Added setOrdersMerge method allowing merging orders - getPackageDetails: Added getPackageDetails method allowing the retrieval of detailed information about package. |
| 2025-09-02 |
- allow to use "include_connect_data" to choose if the Base Connect data should be included in the getOrders and getOrderReturns methods - getOrders: Allow to use "include_commission_data" to choose if the commission data should be included in the getOrders method |
| 2025-08-18 |
- added the order_product_id field to the addOrderReturn and addOrderReturnProduct methods |
| 2025-08-12 |
- added addInventoryPurchaseOrder method allowing the creation of a new purchase order - added addInventoryPurchaseOrderItems method allowing the creation of a new purchase order items - added setInventoryPurchaseOrderStatus method allowing the change of the purchase order status - added getInventoryPayers method allowing the retrieval of a list of payers - added addInventoryPayer method allowing the creation of a new payer - added deleteInventoryPayer method allowing the deletion of a payer - added getInventorySuppliers method allowing the retrieval of a list of suppliers - added addInventorySupplier method allowing the creation of a new supplier - added deleteInventorySupplier method allowing the deletion of a supplier - addOrderBySplit: Added addOrderBySplit method allowing splitting orders - addInventoryDocument: Added addInventoryDocument method allowing the creation of a new inventory document - setInventoryDocumentStatusConfirmed: Added setInventoryDocumentStatusConfirmed method allowing the change of the inventory document status to confirmed - addInventoryDocumentItems: Added addInventoryDocumentItems method allowing the addition of items to an existing inventory document |
| 2025-04-23 |
- getOrders: Added the parameter 'commission' in the getOrders method (when with_commission flag is enabled) |
| 2025-03-18 |
- getInventoryDocuments: Added getInventoryDocuments method allowing the retrieval of a list of inventory documents - getInventoryDocumentItems: Added getInventoryDocumentItems method allowing the retrieval of items from an inventory document - getInventoryDocumentSeries: Added getInventoryDocumentSeries method allowing the retrieval of document series |
| 2025-03-06 |
- added getInventoryPurchaseOrders method allowing the retrieval of a list of purchase orders - added getInventoryPurchaseOrderItems method allowing the retrieval of a list of purchase orders items - added getInventoryPurchaseOrderSeries method allowing the retrieval of a list of purchase order document series |
| 2025-02-19 |
- added possibility to get and set information about additional EANS for products - getInventoryTags: Added getInventoryTags method for returning inventory tags. - addInventoryProduct: Added the parameter 'tags' in the addInventoryProduct method. - getInventoryProductsData: Added the parameter 'tags' in the getInventoryProductsData method. - getJournalList: Added possibility to get info about editing invoice data in getJournalList method |
| 2024-10-10 |
- changed the name of parameter 'contractor_id' to 'connect_contractor_id' in the addConnectContractorCredit method - getConnectIntegrations: Changed the name of parameter 'id' to 'connect_integration_id' in the getConnectIntegrations method - getConnectIntegrationContractors: Removed the parameter 'token_id' in the getConnectIntegrationContractors method - getConnectIntegrationContractors: Added the parameter 'connect_integration_id' in the getConnectIntegrationContractors method - getConnectIntegrationContractors: Changed the name of parameter 'id' to 'connect_contractor_id' in the getConnectIntegrationContractors method - getConnectContractorCreditHistory: Changed the name of parameter 'contractor_id' to 'connect_contractor_id' in the getConnectContractorCreditHistory method - getConnectContractorCreditHistory: Changed the name of parameter 'id' to 'credit_entry_id' in the getConnectContractorCreditHistory method - getConnectContractorCreditHistory: Removed the parameter 'token_id' in the getConnectContractorCreditHistory method |
| 2024-06-05 |
- added new methods for BaseLinker Connect and contactors. - old method 'getOrderTransactionDetails' replaced with a new one 'getOrderTransactionData' to handle order transaction data. - getInventoryProductsData: Added new output 'stock_erp_unit' to getInventoryProductsData method. |
| 2024-05-16 |
- added new methods for handling order returns. |
| 2024-03-05 |
- addInventoryProduct: Added the average_cost field to the addInventoryProduct method |
| 2024-01-31 |
- getOrderPackages: Added the is_return field to the getOrderPackages method |
| 2024-01-10 |
- getOrderPickPackHistory: Added getOrderPickPackHistory API method allowing the retrieval of data related to order picking and packing. |
| 2023-08-23 |
- added the printer_name field to the setOrderReceipt method - addInvoice: Added the vat_rate field to the addInvoice method - getInvoiceFile: Added getInvoiceFile method |
| 2023-08-16 |
- added setOrdersStatuses method - (IMPORTANT) getOrders: Corrected return types of some parameters in the getOrders method - getInvoices: Added the issuer field to the response in the getInvoices method - addOrderReceiptFile: Added addOrderReceiptFile function, allowing to add own PDF document to a receipt issued in BaseLinker - runProductMacroTrigger: Added runProductMacroTrigger method |
| 2023-02-14 |
- createPackageManual: Added the return_shipment field to the createPackageManual method |
| 2022-12-28 |
- added the delivery_state and invoice_state fields to the getOrders, addOrder and setOrderFields methods |
| 2022-06-29 |
- added support for uploading files for product extra fields - getOrderPaymentsHistory: Added the comment field with the payment comment to the response in the getOrderPaymentsHistory method |
| 2022-06-14 |
- getInventoryProductsData: Added the average_cost and average_landed_cost fields to the getInventoryProductsData method - getOrders: Added new filters in getOrders method: filter_order_source and filter_order_source_id |
| 2022-05-11 |
- (IMPORTANT) changed the format in which the data of custom extra fields is handled in the methods getOrders, addOrder and setOrderFields (old format will be supported at least until 09.06.2022). - added support for uploading files for order custom extra fields - getOrders: Added information about bundle identifier for products in method getOrders |
| 2022-04-20 |
- (IMPORTANT) all responses are served with Content-Type header set to "application/json" instead of "application/html" |
| 2022-04-14 |
- added handling of custom extra fields in methods: getOrders, addOrder, setOrderFields - getOrderExtraFields: Added getOrderExtraFields function |
| 2022-01-28 |
- added handling of products source warehouse in methods: getOrders, addOrder, addOrderProduct, setOrderProductFields |
| 2021-12-28 |
- added handling of products location in methods: getOrders, addOrder, addOrderProduct, setOrderProductFields |
| 2021-11-14 |
- (IMPORTANT) changed ip addresses api.baselinker.com can response from (response from the one of the following is possible: https://www.cloudflare.com/ips/) |
| 2021-11-05 |
- (IMPORTANT) authorization with http header (X-BLToken) is recommended (token as a POST parameter will be supported at least until 05.05.2022) |
| 2021-09-29 |
- (IMPORTANT) changed the type of tax_rate field. It can be float (e.g. 5.5, 7.5 etc, due OSS). The integer values like 0, 5, 23 still be int |
| 2021-09-16 |
- added getOrderTransactionDetails function to retrieve additional information related to order source (now working for orders made on Amazon) - addOrder: Added the optional parameter custom_source_id in the addOrder method - getOrderSources: Added getOrderSources function |
| 2021-01-28 |
- setOrderFields: Removed the parameters invoice_country and delivery_country in the setOrderFields method (maintaining backward compatibility*) |
| 2020-11-18 |
- getInvoices: Added the parameter get_external_invoices to the request in the getInvoices method |
| 2020-09-07 |
- getInvoices: Added the external_id field with the external system invoice identifier to the response in the getInvoices method |
| 2020-08-18 |
- added the package_id parameter to the request in getLabel, deleteCourierPackage methods - added a package_id field with a package identifier to the response in createPackage, createPackageManual methods - added the courier_inner_number field with the courier internal number to the response in the createPackage, getOrderPackages methods - added the parameters description_extra3, description_extra4 to the request in the addProduct, getProductsData methods - getReceipt: Added getReceipt function to retrieve the receipt information for the order |
| 2020-05-20 |
- addInventoryWarehouseLocation: Added addInventoryWarehouseLocation method, allowing you to add or update a warehouse location in a Base inventory warehouse. - addInventoryWarehouseLocationType: Added addInventoryWarehouseLocationType method, allowing you to add or update a warehouse location type in a Base inventory warehouse. - deleteInventoryWarehouseLocation: Added deleteInventoryWarehouseLocation method, allowing you to delete a single warehouse location in a Base inventory warehouse. - deleteInventoryWarehouseLocationType: Added deleteInventoryWarehouseLocationType method, allowing you to delete a single warehouse location type in a Base inventory warehouse. - getInventoryWarehouseLocationTypes: Added getInventoryWarehouseLocationTypes method, allowing you to retrieve the list of warehouse locations types - getInventoryWarehouseLocations: Added getInventoryWarehouseLocations method, allowing you to retrieve the list of warehouse locations defined for a given Base inventory warehouse. |
| 2020-05-18 |
- getInvoices: Added the series_id field with numbering series identifier to the getInvoices, getNewReceipts methods - getInvoices: Added series_id parameter to getInvoices, allowing to filter by invoice numbering series |
| 2020-03-05 |
- addInvoice: Added the addInvoice function, enabling to issue an invoice to the order - getSeries: Added getSeries function to retrieve invoice and receipt numbering series |
| 2020-02-27 |
- added the delivery_point_id field with the pickup point identifier to the getOrders, setOrderFields, addOrder methods - (IMPORTANT) added the parameter "price_brutto" in the addProduct function instead of "price_netto" (maintaining backward compatibility*) - getInvoices: Added external_invoice_number field with invoice number from external system to getInvoices method |
| 2020-02-15 |
- addOrderInvoiceFile: Added addOrderInvoiceFile function, allowing to add own PDF document to an invoice issued in BaseLinker |
| 2020-02-06 |
- deleteCourierPackage: Added deleteCourierPackage function to delete a shipment |
| 2020-01-23 |
- added the "sku" and "ean" parameters to the "products" array in the getNewReceipts function |
| 2019-12-29 |
- added the field "nip" (VAT number) in the getNewReceipts function |
| 2019-12-12 |
- getOrderPaymentsHistory: Added function getOrderPaymentsHistory to retrieve the payment history for a selected order |
| 2019-11-28 |
- (IMPORTANT) change the format of the "storage_id" parameter in product storage functions from "[id:int]" to "[type:bl|shop|warehouse]_[id:int]" (maintaining backward compatibility*) - added support for external storages (shops/wholesalers) in the functions getStoragesList, getCategories, getProductsList, getProductsData, updateProductsQuantity - (IMPORTANT) added the "page" parameter in the getProductsList function instead of the "filter_limit" parameter (maintaining backward compatibility*) - (IMPORTANT) remove the "read" parameter in the getStoragesList function (maintaining backward compatibility*) - (IMPORTANT) remove the "write" parameter in the getStoragesList function (maintaining backward compatibility*) - (IMPORTANT) added parameter "price_brutto" in the addProductVariant function instead of "price_netto" (maintaining backward compatibility*) - (IMPORTANT) added the parameter "price_brutto" in the updateProductsPrices function instead of "price_netto" (maintaining backward compatibility*) - added function getProductsQuantity with support for external storages (shops/wholesalers) - added function getProductsPrices with support for external storages (shops/wholesalers) - addOrder: Added the "attributes" parameter to the "products" array in the addOrder function |
* In the event of a parameter format change/removal of a parameter/ method withdrawal, the existing integrations shall be supported in a backward compatibility. We recommend making modifications to systems using the API as soon as possible as compatibility is maintained for six months after the publication of the change.