API documentation - baselinker.com

* 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.

2024-10-10	- Changed the name of parameter 'id' to 'connect_integration_id' in the getConnectIntegrations method - Removed the parameter 'token_id' in the getConnectIntegrationContractors method - Added the parameter 'connect_integration_id' in the getConnectIntegrationContractors method - Changed the name of parameter 'id' to 'connect_contractor_id' in the getConnectIntegrationContractors method - Changed the name of parameter 'contractor_id' to 'connect_contractor_id' in the getConnectContractorCreditHistory method - Changed the name of parameter 'id' to 'credit_entry_id' in the getConnectContractorCreditHistory method - Removed the parameter 'token_id' in the getConnectContractorCreditHistory method - Changed the name of parameter 'contractor_id' to 'connect_contractor_id' in the addConnectContractorCredit method
2024-06-05	- Added new methods for BaseLinker Connect and contactors. - Added new output 'stock_erp_unit' to getInventoryProductsData method. - Old method 'getOrderTransactionDetails' replaced with a new one 'getOrderTransactionData' to handle order transaction data.
2024-05-16	- Added new methods for handling order returns.
2024-03-05	- Added the average_cost field to the addInventoryProduct method
2024-01-31	- Added the is_return field to the getOrderPackages method
2024-01-10	- Added getOrderPickPackHistory API method allowing the retrieval of data related to order picking and packing.
2023-08-23	- added the vat_rate field to the addInvoice method - added the printer_name field to the setOrderReceipt method - added getInvoiceFile method
2023-08-16	- added setOrdersStatuses method - added runProductMacroTrigger method - added addOrderReceiptFile function, allowing to add own PDF document to a receipt issued in BaseLinker - added the issuer field to the response in the getInvoices method - (IMPORTANT) corrected return types of some parameters in the getOrders method
2023-02-14	- 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 - added the comment field with the payment comment to the response in the getOrderPaymentsHistory method
2022-06-14	- added new filters in getOrders method: filter_order_source and filter_order_source_id - added the average_cost and average_landed_cost fields to the getInventoryProductsData method
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 - 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 getOrderExtraFields function - added handling of custom extra fields in methods: getOrders, addOrder, setOrderFields
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 getOrderSources function - added the optional parameter custom_source_id in the addOrder method - added getOrderTransactionDetails function to retrieve additional information related to order source (now working for orders made on Amazon)
2021-01-28	- removed the parameters invoice_country and delivery_country in the setOrderFields method (maintaining backward compatibility*)
2020-11-18	- added the parameter get_external_invoices to the request in the getInvoices method
2020-09-07	- 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 getReceipt function to retrieve the receipt information for the order - added the parameters description_extra3, description_extra4 to the request in the addProduct, getProductsData methods
2020-05-18	- added the series_id field with numbering series identifier to the getInvoices, getNewReceipts methods - added series_id parameter to getInvoices, allowing to filter by invoice numbering series
2020-03-05	- added the addInvoice function, enabling to issue an invoice to the order - 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 - added external_invoice_number field with invoice number from external system to getInvoices method - (IMPORTANT) added the parameter "price_brutto" in the addProduct function instead of "price_netto" (maintaining backward compatibility*)
2020-02-15	- added addOrderInvoiceFile function, allowing to add own PDF document to an invoice issued in BaseLinker
2020-02-06	- 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	- 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) - added the "attributes" parameter to the "products" array in the addOrder function