All integrations

BaseLinker

BUSINESS · COMMERCE & FINANCE

Orders, products, inventories, and shipments across the connected store.

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

baselinker_add_connect_contractor_credit_settlementWRITE

Add Connect Contractor Credit Settlement via POST /connector.php with method=addConnectContractorCreditSettlement. The method allows you to add a manual credit settlement (repayment) for a chosen contractor in Base Connect. A settlement reduces the blocked credit amount for the contractor, effectively recording a payment received for previously charged orders. The settlement amount cannot exceed the contractor's currently blocked credit amount (credit_to_pay).

api
baselinker_add_crm_clientWRITE

Add CRM Client via POST /connector.php with method=addCrmClient. The method allows you to add a new CRM client. Adding a client with the same crm_client_id again will update the previously saved client (only the provided fields will be changed).

api
baselinker_add_crm_client_statusWRITE

Add CRM Client Status via POST /connector.php with method=addCrmClientStatus. Creates a new CRM client status or updates an existing one if status_id is provided. A new status is appended at the end of the status list within its group.

api
baselinker_add_crm_client_status_groupWRITE

Add CRM Client Status Group via POST /connector.php with method=addCrmClientStatusGroup. Creates a new CRM client status group or updates an existing one if group_id is provided. Status groups are used to visually organize client statuses in the panel sidebar.

api
baselinker_add_inventoryWRITE

Add Inventory via POST /connector.php with method=addInventory. The method allows you to add the Base catalogs. Adding a catalog with the same identifier again will cause updates of the previously saved catalog.

api
baselinker_add_inventory_categoryWRITE

Add Inventory Category via POST /connector.php with method=addInventoryCategory. The method allows you to add a category to the Base catalog. Adding a category with the same identifier again, updates the previously saved category

api
baselinker_add_inventory_documentWRITE

Add Inventory Document via POST /connector.php with method=addInventoryDocument. The method allows you to create a new inventory document in Base storage. Documents are created as draft and need to be confirmed by the user or setInventoryDocumentStatusConfirmed API method.

api
baselinker_add_inventory_document_fileWRITE

Add Inventory Document File via POST /connector.php with method=addInventoryDocumentFile. The method allows you to add an external PDF file to a warehouse document. It enables attaching a document issued in an external ERP system to the corresponding warehouse document in Base.

api
baselinker_add_inventory_document_itemsWRITE

Add Inventory Document Items via POST /connector.php with method=addInventoryDocumentItems. The method allows you to add items to an existing inventory document.

api
baselinker_add_inventory_fulfillment_deliveryWRITE

Add Inventory Fulfillment Delivery via POST /connector.php with method=addInventoryFulfillmentDelivery. The method allows you to create a new fulfillment delivery in draft status. A fulfillment delivery represents a shipment of products from a source warehouse to a fulfillment center.

api
baselinker_add_inventory_fulfillment_delivery_itemsWRITE

Add Inventory Fulfillment Delivery Items via POST /connector.php with method=addInventoryFulfillmentDeliveryItems. The method allows you to add products to a fulfillment delivery. Items can only be added to deliveries in draft status. Products must exist in inventory and must not be bundles, drafts, or main products with variants.

api
baselinker_add_inventory_manufacturerWRITE

Add Inventory Manufacturer via POST /connector.php with method=addInventoryManufacturer. The method allows you to add a manufacturer to the Base catalog. Adding a manufacturer with the same identifier again, updates the previously saved manufacturer

api
baselinker_add_inventory_payerWRITE

Add Inventory Payer via POST /connector.php with method=addInventoryPayer. The method allows you to add a new payer or update an existing one in BaseLinker storage.

api
baselinker_add_inventory_price_groupWRITE

Add Inventory Price Group via POST /connector.php with method=addInventoryPriceGroup. The method allows to create a price group in Base storage. Providing a price group ID will update the existing price group. Such price groups may be later assigned in addInventory method. Supports defining price calculation options including group type, source price group, multiplier, and price addition.

api
baselinker_add_inventory_productWRITE

Add Inventory Product via POST /connector.php with method=addInventoryProduct. The method allows you to add a new product to Base catalog. Entering the product with the ID updates previously saved product.

api
baselinker_add_inventory_purchase_orderWRITE

Add Inventory Purchase Order via POST /connector.php with method=addInventoryPurchaseOrder. The method allows you to create a new purchase order in Base storage. Orders are created as drafts by default.

api
baselinker_add_inventory_purchase_order_fileWRITE

Add Inventory Purchase Order File via POST /connector.php with method=addInventoryPurchaseOrderFile. The method allows you to add a cost invoice PDF file to a purchase order. It enables attaching an invoice issued by the supplier to the corresponding purchase order in Base.

api
baselinker_add_inventory_purchase_order_itemsWRITE

Add Inventory Purchase Order Items via POST /connector.php with method=addInventoryPurchaseOrderItems. The method allows you to add items to an existing purchase order. Entering the product with the ID and price updates the previously saved position only if all other parameters match. If any parameter differs (e.g. location), a new item will be added.

api
baselinker_add_inventory_stocktakeWRITE

Add Inventory Stocktake via POST /connector.php with method=addInventoryStocktake. The method allows you to create a new stocktake (inventory count) in draft status. For non-manual scopes, the product list is automatically populated based on the selected scope and warehouse.

api
baselinker_add_inventory_stocktake_itemsWRITE

Add Inventory Stocktake Items via POST /connector.php with method=addInventoryStocktakeItems. The method allows you to add items to an existing stocktake in draft status. Entering a product with the same ID and matching parameters updates the previously saved position. If any parameter differs, a new item will be added.

api
baselinker_add_inventory_supplierWRITE

Add Inventory Supplier via POST /connector.php with method=addInventorySupplier. The method allows you to add a new supplier or update an existing one in BaseLinker storage.

api
baselinker_add_inventory_tagWRITE

Add Inventory Tag via POST /connector.php with method=addInventoryTag. The method allows you to add a tag to the Base product catalog. Adding a tag with the same tag_id again updates the previously saved tag.

api
baselinker_add_inventory_transferWRITE

Add Inventory Transfer via POST /connector.php with method=addInventoryTransfer. The method allows you to create a new inventory transfer in draft status. Both source and target warehouses must belong to inventories with advanced WMS enabled.

api
baselinker_add_inventory_transfer_itemsWRITE

Add Inventory Transfer Items via POST /connector.php with method=addInventoryTransferItems. The method allows you to add planning items to an inventory transfer in draft status. Entering the product with the ID updates the previously saved position only if all other parameters match. If any parameter differs (e.g. location), a new item will be added.

api
baselinker_add_inventory_warehouseWRITE

Add Inventory Warehouse via POST /connector.php with method=addInventoryWarehouse. The method allows you to add a new warehouse available in Base inventories. Adding a warehouse with the same identifier again will cause updates of the previously saved warehouse. The method does not allow editing warehouses created automatically for the purpose of keeping external stocks of shops, wholesalers etc. Such warehouse may be later used in addInventory method.

api
baselinker_add_inventory_warehouse_locationWRITE

Add Inventory Warehouse Location via POST /connector.php with method=addInventoryWarehouseLocation. The method allows you to add or update a warehouse location in a Base inventory warehouse.

api
baselinker_add_inventory_warehouse_location_typeWRITE

Add Inventory Warehouse Location Type via POST /connector.php with method=addInventoryWarehouseLocationType. The method allows you to add or update a warehouse location type.

api
baselinker_add_inventory_warehouse_rackWRITE

Add Inventory Warehouse Rack via POST /connector.php with method=addInventoryWarehouseRack. The method allows you to add or update a warehouse rack. Providing a rack_id updates the existing rack; omitting it creates a new one.

api
baselinker_add_inventory_warehouse_zoneWRITE

Add Inventory Warehouse Zone via POST /connector.php with method=addInventoryWarehouseZone. The method allows you to add or update a warehouse zone. Providing a zone_id updates the existing zone; omitting it creates a new one.

api
baselinker_add_invoiceWRITE

Add Invoice via POST /connector.php with method=addInvoice. The method allows to issue an order invoice.

api
baselinker_add_invoice_correctionWRITE

Add Invoice Correction via POST /connector.php with method=addInvoiceCorrection. The method allows to issue an order invoice correction. Either original_invoice_id or return_order_id must be provided. If return_order_id is provided, all other fields will be ignored (except series_id) and invoice will be created with data from the return order. If field is optional and not provided, it will be set according to the series settings or default values.

api
baselinker_add_orderWRITE

Add Order via POST /connector.php with method=addOrder. The method allows adding a new order to the Base order manager.

api
baselinker_add_order_by_splitWRITE

Add Order By Split via POST /connector.php with method=addOrderBySplit. Creates a new order by splitting selected products from an existing order. The new order inherits all fields and information from the original one.

api
baselinker_add_order_duplicateWRITE

Add Order Duplicate via POST /connector.php with method=addOrderDuplicate. The method allows you to add a new order to the Base order manager by duplicating an existing order. The new order will have the same data as the original order, but with a different ID.

api
baselinker_add_order_invoice_fileWRITE

Add Order Invoice File via POST /connector.php with method=addOrderInvoiceFile. The method allows you to add an external file to an invoice previously issued from Base. It enables replacing a standard invoice from Base with an invoice issued e.g. in an ERP program.

api
baselinker_add_order_pick_listWRITE

Add Order Pick List via POST /connector.php with method=addOrderPickList. Creates a paper pick list for up to 100 orders belonging to the authenticated user. Creating the list does not print it and does not mark the orders as picked or packed.

api
baselinker_add_order_productWRITE

Add Order Product via POST /connector.php with method=addOrderProduct. The method allows you to add a new product to your order.

api
baselinker_add_order_receipt_fileWRITE

Add Order Receipt File via POST /connector.php with method=addOrderReceiptFile. The method allows you to add an external file to a receipt previously issued from Base. It enables replacing a standard receipt from Base with a receipt issued e.g. in an ERP program.

api
baselinker_add_order_returnWRITE

Add Order Return via POST /connector.php with method=addOrderReturn. The method allows adding a new order return to Base.

api
baselinker_add_order_return_productWRITE

Add Order Return Product via POST /connector.php with method=addOrderReturnProduct. Add new product to existing order return

api
baselinker_add_order_return_statusWRITE

Add Order Return Status via POST /connector.php with method=addOrderReturnStatus. Creates a new order return status or updates an existing one if status_id is provided. A new status is appended at the end of the status list within its group.

api
baselinker_add_order_return_status_groupWRITE

Add Order Return Status Group via POST /connector.php with method=addOrderReturnStatusGroup. Creates a new order return status group or updates an existing one if group_id is provided. Status groups are used to visually organize return statuses in the panel sidebar.

api
baselinker_add_order_statusWRITE

Add Order Status via POST /connector.php with method=addOrderStatus. Creates a new order status or updates an existing one if status_id is provided. A new status is appended at the end of the status list within its group.

api
baselinker_add_order_status_groupWRITE

Add Order Status Group via POST /connector.php with method=addOrderStatusGroup. Creates a new order status group or updates an existing one if group_id is provided. Status groups are used to visually organize statuses in the panel sidebar.

api
baselinker_add_pick_pack_cartWRITE

Add Pick Pack Cart via POST /connector.php with method=addPickPackCart. Creates a new PickPack cart or updates an existing one. When creating a cart, you must provide a name, and optionally a color. When updating a cart, you must provide the cart_id and can optionally update the name and/or color. If no color is provided during creation, the system will automatically generate a random color. The cart will be assigned to the current user and positioned at the end of their cart list (for new carts).

api
baselinker_add_pick_pack_orders_to_cartWRITE

Add Pick Pack Orders To Cart via POST /connector.php with method=addPickPackOrdersToCart. The method allows you to assign multiple orders to a specific PickPack cart in a single API call. You can assign up to 20 orders at once. If any order is already assigned to another cart, it will be moved to the new cart (only one cart assignment per order is allowed).

api
baselinker_add_receiptWRITE

Add Receipt via POST /connector.php with method=addReceipt. The method allows you to issue a receipt for an order.

api
baselinker_create_packageWRITE

Create Package via POST /connector.php with method=createPackage. The method allows you to create a shipment in the system of the selected courier.

api
baselinker_create_package_manualWRITE

Create Package Manual via POST /connector.php with method=createPackageManual. The method allows you to enter the shipping number and the name of the courier to the order (function used only to add shipments created outside Base)

api
baselinker_delete_courier_packageWRITE

Delete Courier Package via POST /connector.php with method=deleteCourierPackage. The method allows you to delete a previously created shipment. The method removes the shipment from the Base system and from the courier system if the courier API allows it

api
baselinker_delete_crm_clientWRITE

Delete CRM Client via POST /connector.php with method=deleteCrmClient. The method allows you to remove a CRM client. Orders previously associated with the deleted client are not affected.

api
baselinker_delete_crm_client_statusWRITE

Delete CRM Client Status via POST /connector.php with method=deleteCrmClientStatus. Deletes a CRM client status. All clients currently in the deleted status are moved to the specified target status. The primary (default) status cannot be deleted.

api
baselinker_delete_crm_client_status_groupWRITE

Delete CRM Client Status Group via POST /connector.php with method=deleteCrmClientStatusGroup. Deletes a CRM client status group. All client statuses in the deleted group are moved to the main (default) group. The main group itself cannot be deleted.

api
baselinker_delete_inventoryWRITE

Delete Inventory via POST /connector.php with method=deleteInventory. The method allows you to delete a catalog from Base storage.

api
baselinker_delete_inventory_categoryWRITE

Delete Inventory Category via POST /connector.php with method=deleteInventoryCategory. The method allows you to remove categories from Base 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.

api
baselinker_delete_inventory_manufacturerWRITE

Delete Inventory Manufacturer via POST /connector.php with method=deleteInventoryManufacturer. The method allows you to remove manufacturer from Base catalog

api
baselinker_delete_inventory_payerWRITE

Delete Inventory Payer via POST /connector.php with method=deleteInventoryPayer. The method allows you to remove a payer from BaseLinker storage.

api
baselinker_delete_inventory_price_groupWRITE

Delete Inventory Price Group via POST /connector.php with method=deleteInventoryPriceGroup. The method allows you to remove the price group from Base storage.

api
baselinker_delete_inventory_productWRITE

Delete Inventory Product via POST /connector.php with method=deleteInventoryProduct. The method allows you to remove the product from Base catalog.

api
baselinker_delete_inventory_supplierWRITE

Delete Inventory Supplier via POST /connector.php with method=deleteInventorySupplier. The method allows you to remove a supplier from BaseLinker storage.

api
baselinker_delete_inventory_tagWRITE

Delete Inventory Tag via POST /connector.php with method=deleteInventoryTag. The method allows you to remove a tag from the Base product catalog. When a tag is deleted, it is automatically unlinked from all products that have it assigned.

api
baselinker_delete_inventory_warehouseWRITE

Delete Inventory Warehouse via POST /connector.php with method=deleteInventoryWarehouse. The method allows you to remove the warehouse available in Base inventories. The method does not allow to remove warehouses created automatically for the purpose of keeping external stocks of shops, wholesalers etc.

api
baselinker_delete_inventory_warehouse_locationWRITE

Delete Inventory Warehouse Location via POST /connector.php with method=deleteInventoryWarehouseLocation. The method allows you to delete a single warehouse location from a Base inventory warehouse. The location is identified by location_id and must belong to the warehouse identified by warehouse_type + warehouse_id.

api
baselinker_delete_inventory_warehouse_location_typeWRITE

Delete Inventory Warehouse Location Type via POST /connector.php with method=deleteInventoryWarehouseLocationType. The method allows you to delete a single warehouse location type. The default location type cannot be deleted.

api
baselinker_delete_inventory_warehouse_rackWRITE

Delete Inventory Warehouse Rack via POST /connector.php with method=deleteInventoryWarehouseRack. The method allows you to delete a warehouse rack. All locations assigned to the rack are unassigned.

api
baselinker_delete_inventory_warehouse_zoneWRITE

Delete Inventory Warehouse Zone via POST /connector.php with method=deleteInventoryWarehouseZone. The method allows you to delete a warehouse zone. All racks assigned to the zone are also deleted and all locations within the zone are unassigned.

api
baselinker_delete_order_productWRITE

Delete Order Product via POST /connector.php with method=deleteOrderProduct. The method allows you to remove a specific product from the order.

api
baselinker_delete_order_return_productWRITE

Delete Order Return Product via POST /connector.php with method=deleteOrderReturnProduct. The method allows you to remove a specific product from the return.

api
baselinker_delete_order_return_statusWRITE

Delete Order Return Status via POST /connector.php with method=deleteOrderReturnStatus. Deletes an order return status. All returns currently in the deleted status are moved to the specified target status. The primary (default) status cannot be deleted.

api
baselinker_delete_order_return_status_groupWRITE

Delete Order Return Status Group via POST /connector.php with method=deleteOrderReturnStatusGroup. Deletes an order return status group. All return statuses in the deleted group are moved to the main (default) group. The main group itself cannot be deleted.

api
baselinker_delete_order_statusWRITE

Delete Order Status via POST /connector.php with method=deleteOrderStatus. Deletes an order status. All orders currently in the deleted status are moved to the specified target status. The primary (default) status cannot be deleted.

api
baselinker_delete_order_status_groupWRITE

Delete Order Status Group via POST /connector.php with method=deleteOrderStatusGroup. Deletes an order status group. All statuses in the deleted group are moved to the main (default) group. The main group itself cannot be deleted.

api
baselinker_delete_ordersWRITE

Delete Orders via POST /connector.php with method=deleteOrders. The method allows you to delete multiple orders from the Base order manager.

api
baselinker_delete_pick_pack_cartWRITE

Delete Pick Pack Cart via POST /connector.php with method=deletePickPackCart. The method allows you to delete a PickPack cart from the user's account. When a cart is deleted, all order assignments to that cart are automatically cleared (all orders in the cart are unassigned). The cart must belong to the authenticated user.

api
baselinker_delete_pick_pack_cart_ordersWRITE

Delete Pick Pack Cart Orders via POST /connector.php with method=deletePickPackCartOrders. The method allows you to remove all orders from a specific PickPack cart. After clearing, the cart remains active but contains no orders. All orders that were in the cart become unassigned. The operation only affects carts belonging to the authenticated user.

api
baselinker_delete_pick_pack_order_from_cartWRITE

Delete Pick Pack Order From Cart via POST /connector.php with method=deletePickPackOrderFromCart. The method allows you to remove a specific order from its assigned PickPack cart. After removal, the order will no longer be associated with any cart. The operation only affects orders belonging to the authenticated user.

api
baselinker_get_connect_contractor_credit_historyREAD

Get Connect Contractor Credit History via POST /connector.php with method=getConnectContractorCreditHistory. The method allows you to retrieve an information about chosen contractor trade credit history

api
baselinker_get_connect_integration_contractorsREAD

Get Connect Integration Contractors via POST /connector.php with method=getConnectIntegrationContractors. The method allows you to retrieve a list of contractors connected to the selected Base Connect integration

api
baselinker_get_connect_integrationsREAD

Get Connect Integrations via POST /connector.php with method=getConnectIntegrations. The method allows you to retrieve a list of all Base Connect integrations on this account

api
baselinker_get_courier_accountsREAD

Get Courier Accounts via POST /connector.php with method=getCourierAccounts. The method allows you to retrieve a list of accounts connected with a courier.

api
baselinker_get_courier_documentREAD

Get Courier Document via POST /connector.php with method=getCourierDocument. The method allows you to download a parcel document

api
baselinker_get_courier_fieldsREAD

Get Courier Fields via POST /connector.php with method=getCourierFields. The method allows you to retrieve the form fields for creating shipments for the selected courier.

api
baselinker_get_courier_packages_status_historyREAD

Get Courier Packages Status History via POST /connector.php with method=getCourierPackagesStatusHistory. The method allows you to retrieve the history of the status list of the given shipments. Maximum 100 shipments at a time

api
baselinker_get_courier_servicesREAD

Get Courier Services via POST /connector.php with method=getCourierServices. The method allows you to retrieve additional courier services, which depend on other shipment settings. Used only for BrokerSystem, Wysyłam z Allegro, ErliPRO couriers. Not applicable to other couriers whose forms have fixed options. The details of the package should be sent with the method (the format as in createPackage) in order to receive a list of additional services

api
baselinker_get_couriers_listREAD

Get Couriers List via POST /connector.php with method=getCouriersList. The method allows you to retrieve a list of available couriers.

api
baselinker_get_crm_client_dataREAD

Get CRM Client Data via POST /connector.php with method=getCrmClientData. The method allows you to retrieve detailed data of a specific CRM client, including notes.

api
baselinker_get_crm_client_extra_fieldsREAD

Get CRM Client Extra Fields via POST /connector.php with method=getCrmClientExtraFields. The method returns extra fields defined for CRM clients. Values of those fields can be set with method addCrmClient. In order to retrieve values of those fields use method getCrmClientData or set parameter include_custom_extra_fields in method getCrmClients.

api
baselinker_get_crm_client_status_groupsREAD

Get CRM Client Status Groups via POST /connector.php with method=getCrmClientStatusGroups. Returns the list of CRM client status groups.

api
baselinker_get_crm_client_statusesREAD

Get CRM Client Statuses via POST /connector.php with method=getCrmClientStatuses. Returns CRM client statuses created by the user in the order manager.

api
baselinker_get_crm_clientsREAD

Get CRM Clients via POST /connector.php with method=getCrmClients. The method allows you to retrieve a list of CRM clients. The client list can be limited using the filters described in the method parameters. A maximum of 100 clients are returned at a time. To retrieve full client details (including notes and custom extra fields), use the getCrmClientData method.

api
baselinker_get_external_storage_categoriesREAD

Get External Storage Categories via POST /connector.php with method=getExternalStorageCategories. The method allows you to retrieve a category list from an external storage (shop/wholesale) connected to BaseLinker.

api
baselinker_get_external_storage_products_dataREAD

Get External Storage Products Data via POST /connector.php with method=getExternalStorageProductsData. The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker.

api
baselinker_get_external_storage_products_listREAD

Get External Storage Products List via POST /connector.php with method=getExternalStorageProductsList. The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker.

api
baselinker_get_external_storage_products_pricesREAD

Get External Storage Products Prices via POST /connector.php with method=getExternalStorageProductsPrices. The method allows to retrieve product prices from an external storage (shop/wholesaler) connected to BaseLinker.

api
baselinker_get_external_storage_products_quantityREAD

Get External Storage Products Quantity via POST /connector.php with method=getExternalStorageProductsQuantity. The method allows to retrieve stock from an external storage (shop/wholesaler) connected to BaseLinker.

api
baselinker_get_external_storages_listREAD

Get External Storages List via POST /connector.php with method=getExternalStoragesList. The method allows you to retrieve a list of available external storages (shops, wholesalers) that can be referenced via API.

api
baselinker_get_inventoriesREAD

Get Inventories via POST /connector.php with method=getInventories. The method allows you to retrieve a list of catalogs available in the Base storage.

api
baselinker_get_inventory_available_text_field_keysREAD

Get Inventory Available Text Field Keys via POST /connector.php with method=getInventoryAvailableTextFieldKeys. The method returns a list of product text fields that can be overwritten for specific integration.

api
baselinker_get_inventory_categoriesREAD

Get Inventory Categories via POST /connector.php with method=getInventoryCategories. The method allows you to retrieve a list of categories for a Base catalog.

api
baselinker_get_inventory_document_fileREAD

Get Inventory Document File via POST /connector.php with method=getInventoryDocumentFile. The method allows you to download a warehouse document PDF file.

api
baselinker_get_inventory_document_itemsREAD

Get Inventory Document Items via POST /connector.php with method=getInventoryDocumentItems. This method allows you to retrieve document items for a specific inventory document in Base. In case of a large number of items, pagination is possible.

api
baselinker_get_inventory_document_seriesREAD

Get Inventory Document Series via POST /connector.php with method=getInventoryDocumentSeries. This method allows you to retrieve information about available inventory document series in Base. Each series can be linked to a specific warehouse and can have its own numbering format settings.

api
baselinker_get_inventory_documentsREAD

Get Inventory Documents via POST /connector.php with method=getInventoryDocuments. This method allows you to retrieve a list of inventory documents from Base. It supports pagination and optional filtering by document type, date range, etc.

api
baselinker_get_inventory_extra_fieldsREAD

Get Inventory Extra Fields via POST /connector.php with method=getInventoryExtraFields. The method allows you to retrieve a list of extra fields for a BaseLinker catalog.

api
baselinker_get_inventory_fulfillment_deliveriesREAD

Get Inventory Fulfillment Deliveries via POST /connector.php with method=getInventoryFulfillmentDeliveries. The method allows you to retrieve a list of fulfillment deliveries with optional filtering. Results are paginated with 100 results per page.

api
baselinker_get_inventory_fulfillment_delivery_itemsREAD

Get Inventory Fulfillment Delivery Items via POST /connector.php with method=getInventoryFulfillmentDeliveryItems. The method allows you to retrieve items from a specific fulfillment delivery. Results are paginated with 100 results per page.

api
baselinker_get_inventory_fulfillment_delivery_labelsREAD

Get Inventory Fulfillment Delivery Labels via POST /connector.php with method=getInventoryFulfillmentDeliveryLabels. The method allows you to download labels of a selected type for a specific fulfillment delivery.

api
baselinker_get_inventory_integrationsREAD

Get Inventory Integrations via POST /connector.php with method=getInventoryIntegrations. The method returns a list of integrations where text values in the catalog can be overwritten. The returned data contains a list of accounts for each integration and a list of languages supported by the integration

api
baselinker_get_inventory_manufacturersREAD

Get Inventory Manufacturers via POST /connector.php with method=getInventoryManufacturers. The method allows you to retrieve a list of manufacturers for a Base catalog. Results can be paginated by providing the page parameter (1000 manufacturers per page). Without the page parameter, up to 10000 manufacturers are returned.

api
baselinker_get_inventory_map_detailsREAD

Get Inventory Map Details via POST /connector.php with method=getInventoryMapDetails. The method returns detailed information about a specific warehouse map, including the full JSON representation of the visual map layout.

api
baselinker_get_inventory_mapsREAD

Get Inventory Maps via POST /connector.php with method=getInventoryMaps. The method allows you to retrieve a list of warehouse maps available in the Base inventory system. Each warehouse map represents a location with assigned warehouses and an optional visual map layout.

api
baselinker_get_inventory_payersREAD

Get Inventory Payers via POST /connector.php with method=getInventoryPayers. The method allows you to retrieve a list of payers available in BaseLinker storage.

api
baselinker_get_inventory_price_groupsREAD

Get Inventory Price Groups via POST /connector.php with method=getInventoryPriceGroups. The method allows to retrieve price groups existing in Base storage.

api
baselinker_get_inventory_printout_templatesREAD

Get Inventory Printout Templates via POST /connector.php with method=getInventoryPrintoutTemplates. Returns a list of all configured printout templates available for inventory (products).

api
baselinker_get_inventory_product_logsREAD

Get Inventory Product Logs via POST /connector.php with method=getInventoryProductLogs. The method allows to retrieve a list of events related to product change (or their variants) in the Base catalog.

api
baselinker_get_inventory_products_dataREAD

Get Inventory Products Data via POST /connector.php with method=getInventoryProductsData. The method allows you to retrieve detailed data for selected products from the Base inventory.

api
baselinker_get_inventory_products_listREAD

Get Inventory Products List via POST /connector.php with method=getInventoryProductsList. The method allows to retrieve a basic data of chosen products from Base catalogs.

api
baselinker_get_inventory_products_pricesREAD

Get Inventory Products Prices via POST /connector.php with method=getInventoryProductsPrices. The method allows to retrieve the gross prices of products from Base inventories.

api
baselinker_get_inventory_products_stockREAD

Get Inventory Products Stock via POST /connector.php with method=getInventoryProductsStock. The method allows you to retrieve stock and reservations data of products from Base catalogs, optionally narrowed down with product filters.

api
baselinker_get_inventory_purchase_order_fileREAD

Get Inventory Purchase Order File via POST /connector.php with method=getInventoryPurchaseOrderFile. The method allows you to download a cost invoice PDF file attached to a purchase order.

api
baselinker_get_inventory_purchase_order_itemsREAD

Get Inventory Purchase Order Items via POST /connector.php with method=getInventoryPurchaseOrderItems. The method allows you to retrieve items from a specific purchase order.

api
baselinker_get_inventory_purchase_order_logsREAD

Get Inventory Purchase Order Logs via POST /connector.php with method=getInventoryPurchaseOrderLogs. Returns a list of log entries for a given purchase order, allowing to track status changes, item modifications, and other events.

api
baselinker_get_inventory_purchase_order_seriesREAD

Get Inventory Purchase Order Series via POST /connector.php with method=getInventoryPurchaseOrderSeries. The method allows you to retrieve a list of available purchase order numbering series. Each series is linked to a specific warehouse and defines the numbering format for purchase orders.

api
baselinker_get_inventory_purchase_ordersREAD

Get Inventory Purchase Orders via POST /connector.php with method=getInventoryPurchaseOrders. The method allows you to retrieve a list of purchase orders from Base storage.

api
baselinker_get_inventory_shipping_templatesREAD

Get Inventory Shipping Templates via POST /connector.php with method=getInventoryShippingTemplates. Returns a list of available shipping templates (delivery schemas) for all connected marketplace integrations. Use the returned template IDs when setting the shipping_template parameter in the addInventoryProduct method.

api
baselinker_get_inventory_stocktake_itemsREAD

Get Inventory Stocktake Items via POST /connector.php with method=getInventoryStocktakeItems. The method allows you to retrieve items from a specific stocktake. Supports pagination for stocktakes with a large number of items.

api
baselinker_get_inventory_stocktake_seriesREAD

Get Inventory Stocktake Series via POST /connector.php with method=getInventoryStocktakeSeries. The method allows you to retrieve a list of available stocktake numbering series. Each series is linked to a specific warehouse and defines the numbering format for stocktakes.

api
baselinker_get_inventory_stocktakesREAD

Get Inventory Stocktakes via POST /connector.php with method=getInventoryStocktakes. The method allows you to retrieve a paginated list of stocktakes from BaseLinker storage. It supports filtering by stocktake, warehouse, status, series, number, and creation date range.

api
baselinker_get_inventory_suppliersREAD

Get Inventory Suppliers via POST /connector.php with method=getInventorySuppliers. The method allows you to retrieve a list of suppliers available in BaseLinker storage.

api
baselinker_get_inventory_tagsREAD

Get Inventory Tags via POST /connector.php with method=getInventoryTags. The method allows you to retrieve a list of tags for a Base catalog.

api
baselinker_get_inventory_transfer_itemsREAD

Get Inventory Transfer Items via POST /connector.php with method=getInventoryTransferItems. The method allows you to retrieve items from a specific inventory transfer. Supports pagination for transfers with a large number of items.

api
baselinker_get_inventory_transfer_seriesREAD

Get Inventory Transfer Series via POST /connector.php with method=getInventoryTransferSeries. The method allows you to retrieve a list of available transfer numbering series. Each series is linked to a specific warehouse and defines the numbering format for transfers.

api
baselinker_get_inventory_transfersREAD

Get Inventory Transfers via POST /connector.php with method=getInventoryTransfers. The method allows you to retrieve a list of inventory transfers from BaseLinker storage. It supports pagination and optional filtering by status, warehouse, date range, and transfer type.

api
baselinker_get_inventory_warehouse_location_typesREAD

Get Inventory Warehouse Location Types via POST /connector.php with method=getInventoryWarehouseLocationTypes. The method allows you to retrieve the list of warehouse location types. The returned list is sorted alphabetically by name.

api
baselinker_get_inventory_warehouse_locationsREAD

Get Inventory Warehouse Locations via POST /connector.php with method=getInventoryWarehouseLocations. The method allows you to retrieve the list of warehouse locations (slots/bins) defined for a given Base inventory warehouse. Locations are returned in pages of 100 entries, sorted by name.

api
baselinker_get_inventory_warehouse_racksREAD

Get Inventory Warehouse Racks via POST /connector.php with method=getInventoryWarehouseRacks. The method allows you to retrieve the list of warehouse racks. The returned list is sorted alphabetically by name.

api
baselinker_get_inventory_warehouse_zonesREAD

Get Inventory Warehouse Zones via POST /connector.php with method=getInventoryWarehouseZones. The method allows you to retrieve the list of warehouse zones. The returned list is sorted alphabetically by name.

api
baselinker_get_inventory_warehousesREAD

Get Inventory Warehouses via POST /connector.php with method=getInventoryWarehouses. The method allows you to retrieve a list of warehouses available in Base inventories. The method also returns information about the warehouses created automatically for the purpose of keeping external stocks (shops, wholesalers etc.)

api
baselinker_get_invoice_fileREAD

Get Invoice File via POST /connector.php with method=getInvoiceFile. The method allows you to get the invoice file from Base.

api
baselinker_get_invoicesREAD

Get Invoices via POST /connector.php with method=getInvoices. The method allows you to download invoices issued from the Base order manager. The list of invoices can be limited using filters described in the method parameters. Maximum 100 invoices are returned at a time.

api
baselinker_get_journal_listREAD

Get Journal List via POST /connector.php with method=getJournalList. The method allows you to download a list of order events from the last 3 days. If this method is not enabled for your account, it may return an empty response - in such case, make sure it is enabled in your account API settings. If you cannot enable it in the panel, please contact Base support.

api
baselinker_get_labelREAD

Get Label via POST /connector.php with method=getLabel. The method allows you to download a shipping label (consignment) for a selected shipment.

api
baselinker_get_new_receiptsREAD

Get New Receipts via POST /connector.php with method=getNewReceipts. The method allows you to retrieve receipts waiting to be issued. This method should be used in creating integration with a fiscal printer. The method can be requested for new receipts every e.g. 10 seconds. If any receipts appear in response, they should be confirmed by the setOrderReceipt method after printing to disappear from the waiting list.

api
baselinker_get_order_extra_fieldsREAD

Get Order Extra Fields via POST /connector.php with method=getOrderExtraFields. The method returns extra fields defined for the orders. Values of those fields can be set with method **setOrderFields**. In order to retrieve values of those fields set parameter include_custom_extra_fields in method **getOrders**

api
baselinker_get_order_packagesREAD

Get Order Packages via POST /connector.php with method=getOrderPackages. The method allows you to download shipments previously created for the selected order.

api
baselinker_get_order_payments_historyREAD

Get Order Payments History via POST /connector.php with method=getOrderPaymentsHistory. The method allows you to retrieve payment history for a selected order, including an external payment identifier from the payment gateway. One order can have multiple payment history entries, caused by surcharges, order value changes, manual payment editing

api
baselinker_get_order_pick_listsREAD

Get Order Pick Lists via POST /connector.php with method=getOrderPickLists. Returns up to 100 paper pick lists belonging to the authenticated user. Results are sorted by pick_list_id. You can filter them by pick_list_id or id_from.

api
baselinker_get_order_pick_pack_historyREAD

Get Order Pick Pack History via POST /connector.php with method=getOrderPickPackHistory. The method allows you to retrieve pick pack history for a selected order.

api
baselinker_get_order_printout_templatesREAD

Get Order Printout Templates via POST /connector.php with method=getOrderPrintoutTemplates. Returns a list of all configured printout templates available for orders. The output includes technical identifiers used when executing a printout.

api
baselinker_get_order_return_extra_fieldsREAD

Get Order Return Extra Fields via POST /connector.php with method=getOrderReturnExtraFields. The method returns extra fields defined for order returns. Values of those fields can be set with method setOrderReturnFields. To retrieve values of those fields set parameter include_custom_extra_fields in method getOrderReturns

api
baselinker_get_order_return_journal_listREAD

Get Order Return Journal List via POST /connector.php with method=getOrderReturnJournalList. The method allows you to download a list of return events from the last 3 days.

api
baselinker_get_order_return_payments_historyREAD

Get Order Return Payments History via POST /connector.php with method=getOrderReturnPaymentsHistory. The method allows you to retrieve payment history for a selected order, including an external payment identifier from the payment gateway. One order can have multiple payment history entries, caused by surcharges, order value changes, manual payment editing

api
baselinker_get_order_return_product_statusesREAD

Get Order Return Product Statuses via POST /connector.php with method=getOrderReturnProductStatuses. The method returns a list of order return item statuses. Values of those fields can be set with method setOrderReturnFields.

api
baselinker_get_order_return_reasons_listREAD

Get Order Return Reasons List via POST /connector.php with method=getOrderReturnReasonsList. The method returns a list of order return reasons. Values of those fields can be set with method setOrderReturnFields.

api
baselinker_get_order_return_status_groupsREAD

Get Order Return Status Groups via POST /connector.php with method=getOrderReturnStatusGroups. Returns the list of order return status groups. Status groups are used to visually organize return statuses in the panel sidebar.

api
baselinker_get_order_return_status_listREAD

Get Order Return Status List via POST /connector.php with method=getOrderReturnStatusList. Returns order return statuses created by the user in the order manager.

api
baselinker_get_order_returnsREAD

Get Order Returns via POST /connector.php with method=getOrderReturns. The method allows you to download order returns from a specific date from the Base return manager. The return list can be limited using the filters described in the method parameters. A maximum of 100 order returns are returned at a time.

api
baselinker_get_order_sourcesREAD

Get Order Sources via POST /connector.php with method=getOrderSources. The method returns types of order sources along with their IDs. Order sources are grouped by their type that corresponds to a field order_source from the getOrders method. Available source types are "personal", "shop", "order_return" or "marketplace_code" e.g. "ebay", "amazon", "ceneo", "emag", "allegro", etc.

api
baselinker_get_order_status_groupsREAD

Get Order Status Groups via POST /connector.php with method=getOrderStatusGroups. Returns the list of order status groups. Status groups are used to visually organize statuses in the panel sidebar.

api
baselinker_get_order_status_listREAD

Get Order Status List via POST /connector.php with method=getOrderStatusList. Returns order statuses created by the user in the order manager.

api
baselinker_get_order_transaction_dataREAD

Get Order Transaction Data via POST /connector.php with method=getOrderTransactionData. The method allows you to retrieve transaction details for a selected order

api
baselinker_get_ordersREAD

Get Orders via POST /connector.php with method=getOrders. The method allows you to download orders from a specific date from the Base order manager. The order list can be limited using the filters described in the method parameters. A maximum of 100 orders are returned at a time. It is recommended to download only confirmed orders (get_unconfirmed_orders = false). Unconfirmed orders may be incomplete. The user may be, for example, in the process of creating an order - it already exists in the database, but not all information is completed. Unconfirmed orders may contain only a partial list of products and may be changed soon. Confirmed orders usually do not change anymore and can be safely downloaded to an external system. The best way to download the ongoing orders is: Collecting new order identifiers using getJournalList. Or, using this method: 1. Setting the starting date and specifying it in the date_confirmed_from field 2. Processing of all received orders. If 100 orders are received, there may be even more to download. 3. Downloading the next package of orders by entering the value of the date_confirmed field from last downloaded order in the date_confirmed_from field. In order to avoid downloading the same orders value of date_confirmed should be increased by 1 second. This operation is repeated until you receive a package with less than 100 orders (this means that there are no more orders left to download). 4. Saving the date_confirmed last processed order. You can download orders from this date onwards so that you do not download the same order twice. It is not possible for an order to 'jump' into the database with an earlier confirmation date. This way you can be sure that all confirmed orders have been downloaded.

api
baselinker_get_orders_by_emailREAD

Get Orders By Email via POST /connector.php with method=getOrdersByEmail. The method allows to search for orders related to the given e-mail address. This function is designed to be used in plugins for mail clients (Thunderbird, Outlook, etc.).

api
baselinker_get_orders_by_phoneREAD

Get Orders By Phone via POST /connector.php with method=getOrdersByPhone. The method allows you to search for orders related to the given phone number. This function is intended for use in caller recognition programs.

api
baselinker_get_package_detailsREAD

Get Package Details via POST /connector.php with method=getPackageDetails. This method allows to get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response.

api
baselinker_get_pick_pack_cart_ordersREAD

Get Pick Pack Cart Orders via POST /connector.php with method=getPickPackCartOrders. Retrieves all orders assigned to a specific PickPack cart. Returns all order IDs in reverse chronological order (most recently assigned first) without any pagination restrictions.

api
baselinker_get_pick_pack_cartsREAD

Get Pick Pack Carts via POST /connector.php with method=getPickPackCarts. The method allows you to retrieve a list of all PickPack carts belonging to the authenticated user. The method returns cart details including ID, name, color.

api
baselinker_get_pick_pack_order_cartREAD

Get Pick Pack Order Cart via POST /connector.php with method=getPickPackOrderCart. The method allows you to retrieve cart assignment information for a single order in the PickPack system. The method returns which cart (if any) the order is currently assigned to, along with cart details. The method uses singular naming since it handles a single order and its cart assignment.

api
baselinker_get_protocolREAD

Get Protocol via POST /connector.php with method=getProtocol. The method allows you to download a parcel protocol for selected shipments if the protocol is available for chosen courier

api
baselinker_get_receiptREAD

Get Receipt via POST /connector.php with method=getReceipt. The method allows you to retrieve a single receipt from the Base order manager. To retrieve a list of new receipts (when integrating a fiscal printer), use the getNewReceipts method.

api
baselinker_get_receiptsREAD

Get Receipts via POST /connector.php with method=getReceipts. The method allows you to retrieve issued receipts. Max 100 receipts are returned at a time. To retrieve a list of new receipts (when integrating a fiscal printer), use the getNewReceipts method.

api
baselinker_get_request_parcel_pickup_fieldsREAD

Get Request Parcel Pickup Fields via POST /connector.php with method=getRequestParcelPickupFields. The method allows you to retrieve additional fields for a parcel pickup request.

api
baselinker_get_seriesREAD

Get Series via POST /connector.php with method=getSeries. The method allows to download a series of invoice/receipt numbering.

api
baselinker_run_inventory_fulfillment_delivery_submissionWRITE

Run Inventory Fulfillment Delivery Submission via POST /connector.php with method=runInventoryFulfillmentDeliverySubmission. The method allows you to submit (register) a fulfillment delivery in draft or packing status. Products are treated as packed in simple packing mode and the shipment is registered in the fulfillment center. Optionally accepts date_arrival (unix timestamp) as the expected arrival date when required by the fulfillment integration. Currently supported for selected fulfillment integrations with simple packing mode.

api
baselinker_run_order_macro_triggerWRITE

Run Order Macro Trigger via POST /connector.php with method=runOrderMacroTrigger. The method allows you to run personal trigger for orders automatic actions.

api
baselinker_run_order_return_macro_triggerWRITE

Run Order Return Macro Trigger via POST /connector.php with method=runOrderReturnMacroTrigger. The method allows you to run personal trigger for order returns automatic actions.

api
baselinker_run_product_macro_triggerWRITE

Run Product Macro Trigger via POST /connector.php with method=runProductMacroTrigger. The method allows you to run personal trigger for products automatic actions.

api
baselinker_run_request_parcel_pickupWRITE

Run Request Parcel Pickup via POST /connector.php with method=runRequestParcelPickup. The method allows you to request a parcel pickup for previously created shipments. The method sends a parcel pickup request to courier API if the courier API allows it

api
baselinker_set_connect_contractor_credit_limitWRITE

Set Connect Contractor Credit Limit via POST /connector.php with method=setConnectContractorCreditLimit. The method allows you to set new trade credit limit for chosen contractor

api
baselinker_set_inventory_document_status_confirmedWRITE

Set Inventory Document Status Confirmed via POST /connector.php with method=setInventoryDocumentStatusConfirmed. The method allows you to confirm an inventory document, which will affect the stock levels in the warehouse.

api
baselinker_set_inventory_purchase_order_statusWRITE

Set Inventory Purchase Order Status via POST /connector.php with method=setInventoryPurchaseOrderStatus. The method allows you to change the status of a purchase order.

api
baselinker_set_inventory_stocktake_statusWRITE

Set Inventory Stocktake Status via POST /connector.php with method=setInventoryStocktakeStatus. The method allows you to change the status of a stocktake. When completing a stocktake, verified quantities are applied to warehouse stock and corresponding documents are generated.

api
baselinker_set_inventory_transfer_statusWRITE

Set Inventory Transfer Status via POST /connector.php with method=setInventoryTransferStatus. The method allows you to change the status of an inventory transfer. When completing it, unverified items omitted from completed_items are marked as missing goods.

api
baselinker_set_order_fieldsWRITE

Set Order Fields via POST /connector.php with method=setOrderFields. The method allows you to edit selected fields (e.g. address data, notes, etc.) of a specific order. Only the fields that you want to edit should be given, other fields can be omitted in the request.

api
baselinker_set_order_paymentWRITE

Set Order Payment via POST /connector.php with method=setOrderPayment. The method allows you to add a payment to the order.

api
baselinker_set_order_product_fieldsWRITE

Set Order Product Fields via POST /connector.php with method=setOrderProductFields. The method allows you to edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Only the fields that you want to edit should be given, the remaining fields can be omitted in the request.

api
baselinker_set_order_receiptWRITE

Set Order Receipt via POST /connector.php with method=setOrderReceipt. The method allows you to mark orders with a receipt already issued.

api
baselinker_set_order_return_fieldsWRITE

Set Order Return Fields via POST /connector.php with method=setOrderReturnFields. The method allows you to edit selected fields of a specific order return. Only the fields that you want to edit should be given, other fields can be omitted in the request.

api
baselinker_set_order_return_product_fieldsWRITE

Set Order Return Product Fields via POST /connector.php with method=setOrderReturnProductFields. The method allows you to edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Only the fields that you want to edit should be given, the remaining fields can be omitted in the request.

api
baselinker_set_order_return_refundWRITE

Set Order Return Refund via POST /connector.php with method=setOrderReturnRefund. The method allows you to mark an order return as refunded. Note this method doesn't issue an actual money refund.

api
baselinker_set_order_return_statusWRITE

Set Order Return Status via POST /connector.php with method=setOrderReturnStatus. The method allows you to change order return status.

api
baselinker_set_order_return_statusesWRITE

Set Order Return Statuses via POST /connector.php with method=setOrderReturnStatuses. The method allows you to batch set order return statuses.

api
baselinker_set_order_statusWRITE

Set Order Status via POST /connector.php with method=setOrderStatus. The method allows you to change order status.

api
baselinker_set_order_statusesWRITE

Set Order Statuses via POST /connector.php with method=setOrderStatuses. The method allows you to batch set orders statuses

api
baselinker_set_orders_mergeWRITE

Set Orders Merge via POST /connector.php with method=setOrdersMerge. Merges multiple orders into one, based on the selected merge mode.

api
baselinker_update_external_storage_products_quantityWRITE

Update External Storage Products Quantity via POST /connector.php with method=updateExternalStorageProductsQuantity. The method allows to bulk update the product stock (and/or variants) in an external storage (shop/wholesaler) connected to BaseLinker. Maximum 1000 products at a time.

api
baselinker_update_inventory_products_pricesWRITE

Update Inventory Products Prices via POST /connector.php with method=updateInventoryProductsPrices. The method allows bulk update of gross prices of products (and/or their variants) in the Base catalog. Maximum 1000 products at a time.

api
baselinker_update_inventory_products_stockWRITE

Update Inventory Products Stock via POST /connector.php with method=updateInventoryProductsStock. The method allows to update stocks of products (and/or their variants) in Base catalog. Maximum 1000 products at a time.

api

Put BaseLinker behind one governed endpoint.

Same permissions, same audit trail, whatever else you connect next.