API documentation
Method list
Test your request
Changelog


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

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

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