Skip to content
Changelog

Report a bug

Baselinker integration: operations for AI agents

Baselinker connects to Type.com as an integration. This page lists the 211 operations documented for Claude and Codex in Type.com: 107 read, 75 write, 29 destructive.

About Baselinker

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

Categories: Commerce & Payments

How to connect Baselinker to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

211 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

211 operations listed.

BaseLinker RPC

  • Read

    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.

    POST /connector.php

  • Read

    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

    POST /connector.php

  • Read

    getOrderStatusGroups

    Returns the list of order status groups. Status groups are used to visually organize statuses in the panel sidebar.

    POST /connector.php

  • Read

    getOrderStatusList

    Returns order statuses created by the user in the order manager.

    POST /connector.php

  • Read

    getInvoiceFile

    The method allows you to get the invoice file from Base.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getSeries

    The method allows to download a series of invoice/receipt numbering.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

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

    POST /connector.php

  • Read

    getOrderPickPackHistory

    The method allows you to retrieve pick pack history for a selected order.

    POST /connector.php

  • Read

    getOrderPrintoutTemplates

    Returns a list of all configured printout templates available for orders. The output includes technical identifiers used when executing a printout.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getOrderTransactionData

    The method allows you to retrieve transaction details for a selected order

    POST /connector.php

  • Read

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

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getOrderReturnProductStatuses

    The method returns a list of order return item statuses. Values of those fields can be set with method setOrderReturnFields .

    POST /connector.php

  • Read

    getOrderReturnReasonsList

    The method returns a list of order return reasons. Values of those fields can be set with method setOrderReturnFields .

    POST /connector.php

  • Read

    getOrderReturnStatusGroups

    Returns the list of order return status groups. Status groups are used to visually organize return statuses in the panel sidebar.

    POST /connector.php

  • Read

    getOrderReturnStatusList

    Returns order return statuses created by the user in the order manager.

    POST /connector.php

  • Read

    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

    POST /connector.php

  • Read

    getOrderReturnJournalList

    The method allows you to download a list of return events from the last 3 days.

    POST /connector.php

  • Read

    getCourierPackagesStatusHistory

    The method allows you to retrieve the history of the status list of the given shipments. Maximum 100 shipments at a time

    POST /connector.php

  • Read

    getOrderPackages

    The method allows you to download shipments previously created for the selected order.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getPricePackage

    Returns available shipment quotations for a shipment handled by the selected courier.

    POST /connector.php

  • Read

    getCourierAccounts

    The method allows you to retrieve a list of accounts connected with a courier.

    POST /connector.php

  • Read

    getCourierFields

    The method allows you to retrieve the form fields for creating shipments for the selected courier.

    POST /connector.php

  • Read

    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

    POST /connector.php

  • Read

    getCouriersList

    The method allows you to retrieve a list of available couriers.

    POST /connector.php

  • Read

    getCourierDocument

    The method allows you to download a parcel document

    POST /connector.php

  • Read

    getLabel

    The method allows you to download a shipping label (consignment) for a selected shipment.

    POST /connector.php

  • Read

    getProtocol

    The method allows you to download a parcel protocol for selected shipments if the protocol is available for chosen courier

    POST /connector.php

  • Read

    getRequestParcelPickupFields

    The method allows you to retrieve additional fields for a parcel pickup request.

    POST /connector.php

  • Read

    getCrmClientData

    The method allows you to retrieve detailed data of a specific CRM client, including notes.

    POST /connector.php

  • Read

    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 .

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getCrmClientStatusGroups

    Returns the list of CRM client status groups.

    POST /connector.php

  • Read

    getCrmClientStatuses

    Returns CRM client statuses created by the user in the order manager.

    POST /connector.php

  • Read

    getInventories

    The method allows you to retrieve a list of catalogs available in the Base storage.

    POST /connector.php

  • Read

    getInventoryPriceGroups

    The method allows to retrieve price groups existing in Base storage.

    POST /connector.php

  • Read

    getInventoryMapDetails

    The method returns detailed information about a specific warehouse map, including the full JSON representation of the visual map layout.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

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

    POST /connector.php

  • Read

    getInventoryWarehouseLocationTypes

    The method allows you to retrieve the list of warehouse location types. The returned list is sorted alphabetically by name.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryWarehouseZones

    The method allows you to retrieve the list of warehouse zones. The returned list is sorted alphabetically by name.

    POST /connector.php

  • Read

    getInventoryWarehouseRacks

    The method allows you to retrieve the list of warehouse racks. The returned list is sorted alphabetically by name.

    POST /connector.php

  • Read

    getInventoryCategories

    The method allows you to retrieve a list of categories for a Base catalog.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryParameters

    Returns predefined inventory parameters with all stored translations, existing choice options, and parameter-group mappings.

    POST /connector.php

  • Read

    getInventoryProductLogs

    The method allows to retrieve a list of events related to product change (or their variants) in the Base catalog.

    POST /connector.php

  • Read

    getInventoryProductsData

    The method allows you to retrieve detailed data for selected products from the Base inventory.

    POST /connector.php

  • Read

    getInventoryProductsList

    The method allows to retrieve a basic data of chosen products from Base catalogs.

    POST /connector.php

  • Read

    getInventoryProductsPrices

    The method allows to retrieve the gross prices of products from Base inventories.

    POST /connector.php

  • Read

    getInventoryProductsStock

    The method allows you to retrieve stock and reservations data of products from Base catalogs, optionally narrowed down with product filters.

    POST /connector.php

  • Read

    getInventoryDocumentFile

    The method allows you to download a warehouse document PDF file.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryPurchaseOrderFile

    The method allows you to download a cost invoice PDF file attached to a purchase order.

    POST /connector.php

  • Read

    getInventoryPurchaseOrderItems

    The method allows you to retrieve items from a specific purchase order.

    POST /connector.php

  • Read

    getInventoryPurchaseOrderLogs

    Returns a list of log entries for a given purchase order, allowing to track status changes, item modifications, and other events.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryPurchaseOrders

    The method allows you to retrieve a list of purchase orders from Base storage.

    POST /connector.php

  • Read

    getInventoryTransferItems

    The method allows you to retrieve items from a specific inventory transfer. Supports pagination for transfers with a large number of items.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryStocktakeItems

    The method allows you to retrieve items from a specific stocktake. Supports pagination for stocktakes with a large number of items.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getInventoryFulfillmentDeliveries

    The method allows you to retrieve a list of fulfillment deliveries with optional filtering. Results are paginated with 100 results per page.

    POST /connector.php

  • Read

    getInventoryFulfillmentDeliveryItems

    The method allows you to retrieve items from a specific fulfillment delivery. Results are paginated with 100 results per page.

    POST /connector.php

  • Read

    getInventoryFulfillmentDeliveryLabels

    The method allows you to download labels of a selected type for a specific fulfillment delivery.

    POST /connector.php

  • Read

    getInventorySuppliers

    The method allows you to retrieve a list of suppliers available in BaseLinker storage.

    POST /connector.php

  • Read

    getInventoryPayers

    The method allows you to retrieve a list of payers available in BaseLinker storage.

    POST /connector.php

  • Read

    getInventoryTags

    The method allows you to retrieve a list of tags for a Base catalog.

    POST /connector.php

  • Read

    getInventoryAvailableTextFieldKeys

    The method returns a list of product text fields that can be overwritten for specific integration.

    POST /connector.php

  • Read

    getInventoryExtraFields

    The method allows you to retrieve a list of extra fields for a BaseLinker catalog.

    POST /connector.php

  • Read

    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

    POST /connector.php

  • Read

    getInventoryPrintoutTemplates

    Returns a list of all configured printout templates available for inventory (products).

    POST /connector.php

  • Read

    getInventoryPromotionsList

    Returns account-level catalog promotion definitions in priority order with pagination.

    POST /connector.php

  • Read

    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.

    POST /connector.php

  • Read

    getSyncLogList

    Returns up to 1,000 price and stock synchronization log entries for the authenticated user. Pass source to select a marketplace, including allegro, ebay, amazon, or amazon_vendor. Set errors_only to true to return only entries with a synchronization error.

    POST /connector.php

  • Read

    getConnectIntegrationContractors

    The method allows you to retrieve a list of contractors connected to the selected Base Connect integration

    POST /connector.php

  • Read

    getConnectIntegrations

    The method allows you to retrieve a list of all Base Connect integrations on this account

    POST /connector.php

  • Read

    getConnectContractorCreditHistory

    The method allows you to retrieve an information about chosen contractor trade credit history

    POST /connector.php

  • Read

    getExternalStorageCategories

    The method allows you to retrieve a category list from an external storage (shop/wholesale) connected to BaseLinker.

    POST /connector.php

  • Read

    getExternalStorageProductsData

    The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker.

    POST /connector.php

  • Read

    getExternalStorageProductsList

    The method allows to retrieve detailed data of selected products from an external storage (shop/wholesaler) connected to BaseLinker.

    POST /connector.php

  • Read

    getExternalStorageProductsPrices

    The method allows to retrieve product prices from an external storage (shop/wholesaler) connected to BaseLinker.

    POST /connector.php

  • Read

    getExternalStorageProductsQuantity

    The method allows to retrieve stock from an external storage (shop/wholesaler) connected to BaseLinker.

    POST /connector.php

  • Read

    getExternalStoragesList

    The method allows you to retrieve a list of available external storages (shops, wholesalers) that can be referenced via API.

    POST /connector.php

  • Read

    getListingAgentQueueItems

    Returns listing queue rows created by a Listing Agent with their status and errors, e.g. offers rejected by the marketplace. Works also for agents deleted in the last 14 days. Rows created before 2026-09-24 are not assigned to agents.

    POST /connector.php

  • Read

    getListingAgentRunItems

    Returns per-product results of one Listing Agent run: products added to the listing queue (with the current queue status) and products rejected before the queue with their errors.

    POST /connector.php

  • Read

    getListingAgentRunsList

    Returns Listing Agent runs from the last 14 days, newest first, including runs that failed to start. Agents listing to several sites have a separate run per site. Without listing_agent_id the date range is limited to 3 days.

    POST /connector.php

  • Read

    getListingAgentSettingsHistory

    Returns the history of a Listing Agent from the last 14 days: creation, settings changes, enabling, disabling and deletion, with changed fields. Marketplace account settings (default category, price group) are not part of the agent history.

    POST /connector.php

  • Read

    getListingAgentsData

    Returns details of up to 10 Listing Agents: settings, effective marketplace account settings used for listing (including a pause after marketplace API errors), detected configuration issues, the latest run per site and a summary of the agent listing queue.

    POST /connector.php

  • Read

    getListingAgentsList

    Returns Listing Agents (automatic listing of products to marketplaces) configured in the account, with their current status and the reason of the last stop.

    POST /connector.php

  • Write

    addOrder

    The method allows adding a new order to the Base order manager.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addOrderProduct

    The method allows you to add a new product to your order.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    setOrderPayment

    The method allows you to add a payment to the order.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    setOrderStatus

    The method allows you to change order status.

    POST /connector.php

  • Write

    setOrderStatuses

    The method allows you to batch set orders statuses

    POST /connector.php

  • Write

    addInvoice

    The method allows to issue an order invoice.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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. The method supports PDF and JWS (e-receipt) file formats.

    POST /connector.php

  • Write

    addReceipt

    The method allows you to issue a receipt for an order.

    POST /connector.php

  • Write

    setOrderReceipt

    The method allows you to mark orders with a receipt already issued.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

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

    POST /connector.php

  • Write

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

    POST /connector.php

  • Write

    runOrderMacroTrigger

    The method allows you to run personal trigger for orders automatic actions.

    POST /connector.php

  • Write

    addOrderReturn

    The method allows adding a new order return to Base.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addOrderReturnProduct

    Add new product to existing order return

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    setOrderReturnStatus

    The method allows you to change order return status.

    POST /connector.php

  • Write

    setOrderReturnStatuses

    The method allows you to batch set order return statuses.

    POST /connector.php

  • Write

    setOrderReturnRefund

    The method allows you to mark an order return as refunded. Note this method doesn't issue an actual money refund.

    POST /connector.php

  • Write

    runOrderReturnMacroTrigger

    The method allows you to run personal trigger for order returns automatic actions.

    POST /connector.php

  • Write

    createPackage

    The method allows you to create a shipment in the system of the selected courier.

    POST /connector.php

  • Write

    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)

    POST /connector.php

  • Write

    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

    POST /connector.php

  • Write

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

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryWarehouseLocation

    The method allows you to add or update a warehouse location in a Base inventory warehouse.

    POST /connector.php

  • Write

    addInventoryWarehouseLocationType

    The method allows you to add or update a warehouse location type.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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

    POST /connector.php

  • Write

    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

    POST /connector.php

  • Write

    addInventoryProduct

    The method allows you to add a new product to Base catalog. Entering the product with the ID updates previously saved product.

    POST /connector.php

  • Write

    runFulfillmentLinkProducts

    The runFulfillmentLinkProducts method synchronously links selected inventory products to a fulfillment warehouse using its configured product extra field.

    POST /connector.php

  • Write

    runProductMacroTrigger

    The method allows you to run personal trigger for products automatic actions.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    updateInventoryProductsStock

    The method allows to update stocks of products (and/or their variants) in Base catalog. Maximum 1000 products at a time.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryDocumentItems

    The method allows you to add items to an existing inventory document, or to update the quantity and price of an existing item by item_id. The document must be in draft status.

    POST /connector.php

  • Write

    setInventoryDocumentStatusConfirmed

    The method allows you to confirm an inventory document, which will affect the stock levels in the warehouse.

    POST /connector.php

  • Write

    addInventoryPurchaseOrder

    The method allows you to create a new purchase order in Base storage. Orders are created as drafts by default.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryPurchaseOrderItems

    The method allows you to add items to an existing purchase order, or to update an existing item while the purchase order is in draft status. 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.

    POST /connector.php

  • Write

    setInventoryPurchaseOrderStatus

    The method allows you to change the status of a purchase order.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryTransferItems

    The method allows you to add planning items to an inventory transfer in draft status, or to update the quantity of an existing item by item_id. 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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryStocktakeItems

    The method allows you to add items to an existing stocktake in draft status, or to update the quantity of an existing item by item_id. 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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    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, bundles require the feature to be enabled for the account, and products must not be drafts or main products with variants.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventorySupplier

    The method allows you to add a new supplier or update an existing one in BaseLinker storage.

    POST /connector.php

  • Write

    addInventoryPayer

    The method allows you to add a new payer or update an existing one in BaseLinker storage.

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Write

    addInventoryPromotion

    Creates or updates an account-level catalog promotion.

    POST /connector.php

  • Write

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

    POST /connector.php

  • Write

    setConnectContractorCreditLimit

    The method allows you to set new trade credit limit for chosen contractor

    POST /connector.php

  • Write

    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.

    POST /connector.php

  • Destructive

    deleteOrders

    The method allows you to delete multiple orders from the Base order manager.

    POST /connector.php

  • Destructive

    setOrdersMerge

    Merges multiple orders into one, based on the selected merge mode.

    POST /connector.php

  • Destructive

    deleteOrderProduct

    The method allows you to remove a specific product from the order.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    deleteOrderReturnProduct

    The method allows you to remove a specific product from the return.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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

    POST /connector.php

  • Destructive

    deleteCrmClient

    The method allows you to remove a CRM client. Orders previously associated with the deleted client are not affected.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    deleteInventory

    The method allows you to delete a catalog from Base storage.

    POST /connector.php

  • Destructive

    deleteInventoryPriceGroup

    The method allows you to remove the price group from Base storage.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    deleteInventoryWarehouseLocationType

    The method allows you to delete a single warehouse location type. The default location type cannot be deleted.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    deleteInventoryWarehouseRack

    The method allows you to delete a warehouse rack. All locations assigned to the rack are unassigned.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

  • Destructive

    deleteInventoryManufacturer

    The method allows you to remove manufacturer from Base catalog

    POST /connector.php

  • Destructive

    deleteInventoryProduct

    The method allows you to remove the product from Base catalog.

    POST /connector.php

  • Destructive

    deleteInventoryPurchaseOrderItems

    The deleteInventoryPurchaseOrderItems method removes selected items from an existing purchase order. Items can be removed only while the purchase order is in draft status.

    POST /connector.php

  • Destructive

    deleteInventorySupplier

    The method allows you to remove a supplier from BaseLinker storage.

    POST /connector.php

  • Destructive

    deleteInventoryPayer

    The method allows you to remove a payer from BaseLinker storage.

    POST /connector.php

  • Destructive

    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.

    POST /connector.php

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Baselinker API docs.