### Get Inventory Integrations Source: https://api.base.com/?method=getInventoryIntegrations&tester= Retrieves a list of all configured inventory integrations. ```APIDOC ## GET getInventoryIntegrations ### Description Retrieves a list of all configured inventory integrations. ### Method GET ### Endpoint /getInventoryIntegrations ### Parameters #### Query Parameters - **token** (string) - Required - Your API token for authentication. ### Response #### Success Response (200) - **integrations** (array) - A list of inventory integration objects. - **id** (string) - The unique identifier for the integration. - **name** (string) - The name of the integration. - **type** (string) - The type of integration (e.g., 'api', 'plugin'). - **status** (string) - The current status of the integration (e.g., 'active', 'inactive'). ### Response Example { "integrations": [ { "id": "integration_123", "name": "Example Integration", "type": "api", "status": "active" } ] } ``` -------------------------------- ### Get Connect Integrations Source: https://api.base.com/?method=getConnectIntegrations&tester= Retrieves a list of all available connect integrations. ```APIDOC ## GET getConnectIntegrations ### Description Retrieves a list of all available connect integrations. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getConnectIntegrations** (string) - Required - Specifies the method to call. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **data** (object) - Contains the integration data. - **[integration_key]** (object) - Details of a specific integration. - **id** (integer) - The unique identifier for the integration. - **name** (string) - The name of the integration. - **description** (string) - A description of the integration. - **enabled** (boolean) - Whether the integration is enabled. - **logo** (string) - URL to the integration's logo. - **contractors** (array) - List of contractors associated with the integration. - **id** (integer) - The unique identifier for the contractor. - **name** (string) - The name of the contractor. - **active** (boolean) - Whether the contractor is active. - **credit_limit** (number) - The credit limit for the contractor. - **credit_balance** (number) - The current credit balance for the contractor. ### Response Example ```json { "status": "success", "data": { "example_integration": { "id": 1, "name": "Example Integration", "description": "An example integration", "enabled": true, "logo": "https://example.com/logo.png", "contractors": [ { "id": 101, "name": "Example Contractor", "active": true, "credit_limit": 1000.00, "credit_balance": 500.00 } ] } } } ``` ``` -------------------------------- ### Get Inventory Product Logs Source: https://api.base.com/?method=getInventoryProductLogs&tester= Retrieves logs for a specific inventory product. ```APIDOC ## GET /getInventoryProductLogs ### Description Retrieves logs associated with inventory products. This endpoint allows you to view the history and activity related to specific products within your inventory. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryProductLogs** (string) - Required - Specifies the action to retrieve inventory product logs. ### Request Example ```json { "getInventoryProductLogs": "sample_product_id" } ``` ### Response #### Success Response (200) - **logs** (array) - Contains a list of log entries for the inventory product. - **log_id** (integer) - Unique identifier for the log entry. - **timestamp** (string) - The date and time when the log entry was created. - **user** (string) - The user who performed the action. - **action** (string) - The action performed. - **details** (string) - Additional details about the action. #### Response Example ```json { "status": "success", "data": { "logs": [ { "log_id": 123, "timestamp": "2023-10-27 10:00:00", "user": "admin", "action": "update_stock", "details": "Stock updated from 10 to 15" } ] } } ``` ``` -------------------------------- ### Get Product List Source: https://api.base.com/?method=getProductsList&tester= Retrieves a list of products from the inventory. This is a common operation for synchronizing product data. ```APIDOC ## GET getInventoryProductsList ### Description Retrieves a list of products from the inventory. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **token** (string) - Required - Your Baselinker API token. - **method** (string) - Required - The method to call, which is 'getInventoryProductsList'. ### Request Example ``` GET https://api.baselinker.com/connector.php?token=YOUR_API_TOKEN&method=getInventoryProductsList ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **data** (object) - Contains the list of products if successful. - **products** (array) - An array of product objects. - **product_id** (string) - The unique identifier for the product. - **name** (string) - The name of the product. - **price** (string) - The price of the product. - **stock** (string) - The current stock level of the product. #### Response Example ```json { "status": "OK", "data": { "products": [ { "product_id": "123", "name": "Example Product", "price": "19.99", "stock": "100" } ] } } ``` ``` -------------------------------- ### Get Storages List Source: https://api.base.com/?method=getStoragesList&tester= Retrieves a list of all available storages. This is a read-only operation. ```APIDOC ## GET getStoragesList ### Description Retrieves a list of all available storages. This is a read-only operation. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The method name, which is 'getStoragesList'. ### Request Example ``` GET https://api.baselinker.com/connector.php?method=getStoragesList ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the storage data if the status is 'OK'. - **storage_id** (integer) - The unique identifier for the storage. - **name** (string) - The name of the storage. #### Response Example ```json { "status": "OK", "data": [ { "storage_id": 1, "name": "Main Warehouse" }, { "storage_id": 2, "name": "Secondary Storage" } ] } ``` ``` -------------------------------- ### Get Inventory Products List Source: https://api.base.com/?method=getInventoryProductsList&tester= Retrieves a list of inventory products. This is a read-only operation. ```APIDOC ## GET getInventoryProductsList ### Description Retrieves a list of inventory products from the Baselinker system. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryProductsList** (string) - Required - Specifies the method to call. - **token** (string) - Required - Your Baselinker API token for authentication. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryProductsList&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the list of inventory products if successful. #### Response Example ```json { "status": "OK", "data": [ { "product_id": "123", "name": "Sample Product", "price": "10.00" } ] } ``` ``` -------------------------------- ### Get Order Return Reasons List Source: https://api.base.com/?method=getOrderReturnReasonsList&tester= Retrieves a list of predefined reasons that can be associated with order returns. ```APIDOC ## GET getOrderReturnReasonsList ### Description Retrieves a list of available reasons for order returns. ### Method POST ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Request Body - **token** (string) - Required - Your Baselinker API token. - **method** (string) - Required - The API method to call, which is 'getOrderReturnReasonsList'. ### Request Example ```json { "token": "YOUR_API_TOKEN", "method": "getOrderReturnReasonsList" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **return_reasons** (array) - A list of order return reason objects. - Each object contains: - **id** (integer) - The unique identifier for the return reason. - **name** (string) - The name or description of the return reason. #### Response Example ```json { "status": "OK", "return_reasons": [ { "id": 1, "name": "Damaged item" }, { "id": 2, "name": "Wrong item received" } ] } ``` ``` -------------------------------- ### Get Inventory Tags Source: https://api.base.com/?method=getInventoryTags&tester= Retrieves a list of all available inventory tags. ```APIDOC ## GET getInventoryTags ### Description Retrieves a list of all available inventory tags. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryTags** (string) - Required - Specifies the action to retrieve inventory tags. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryTags ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **data** (array) - An array of inventory tag objects. - **tag_id** (integer) - The unique identifier for the tag. - **tag_name** (string) - The name of the tag. #### Response Example ```json { "status": "success", "data": [ { "tag_id": 1, "tag_name": "New Arrivals" }, { "tag_id": 2, "tag_name": "On Sale" } ] } ``` ``` -------------------------------- ### Get External Storage Products List Source: https://api.base.com/?method=getExternalStorageProductsList&tester= Retrieves a list of products from an external storage. This method is useful for synchronizing product data between Baselinker and external storage systems. ```APIDOC ## GET getExternalStorageProductsList ### Description Retrieves a list of products from an external storage. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The name of the method to call, which is 'getExternalStorageProductsList'. #### Request Body This method does not require a request body. Authentication is handled via the 'X-BLToken' header. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the list of products from external storage. The structure of this object depends on the specific external storage integration. #### Response Example ```json { "status": "OK", "data": [ { "product_id": "123", "name": "Sample Product", "price": "19.99" } ] } ``` ``` -------------------------------- ### Get Inventory Products Stock Source: https://api.base.com/?method=getInventoryProductsStock&tester= Retrieves the stock levels for specified inventory products. ```APIDOC ## GET /getInventoryProductsStock ### Description Retrieves the stock levels for specified inventory products. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryProductsStock** (string) - Required - The method name to retrieve stock information. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` https://api.baselinker.com/connector.php?getInventoryProductsStock&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **data** (object) - Contains the stock information for each product. - **product_id** (object) - Stock details for a specific product. - **warehouse_id** (integer) - The ID of the warehouse. - **stock** (integer) - The available stock quantity. #### Response Example ```json { "status": "OK", "data": { "123": { "1": { "stock": 100 } } } } ``` ``` -------------------------------- ### Get Inventory Printout Templates Source: https://api.base.com/?method=getInventoryPrintoutTemplates&tester= Retrieves a list of available inventory printout templates. ```APIDOC ## GET getInventoryPrintoutTemplates ### Description Retrieves a list of available inventory printout templates. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryPrintoutTemplates** (string) - Required - Specifies the action to retrieve inventory printout templates. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryPrintoutTemplates ``` ### Response #### Success Response (200) - **templates** (array) - A list of available inventory printout templates. #### Response Example ```json { "templates": [ "template1.pdf", "template2.docx" ] } ``` ``` -------------------------------- ### Making a POST Request to BaseLinker API Source: https://api.base.com/ This example demonstrates how to make a POST request to the BaseLinker API connector using curl. Ensure you replace '1-23-ABC' with your actual API token and adjust the 'method' and 'parameters' as needed. The parameters should be URL-encoded JSON. ```bash curl 'https://api.baselinker.com/connector.php' -H 'X-BLToken: 1-23-ABC' --data-raw 'method=getOrders¶meters=%7B%22date_from%22%3A+1407341754%7D' ``` -------------------------------- ### Get Inventory Products Prices Source: https://api.base.com/?method=getInventoryProductsPrices&tester= Retrieves the prices for products in the inventory. This method allows you to fetch pricing information for specific products. ```APIDOC ## GET getInventoryProductsPrices ### Description Retrieves the prices for products in the inventory. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryProductsPrices** (string) - Required - The name of the method to call. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` https://api.baselinker.com/connector.php?getInventoryProductsPrices&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **data** (object) - Contains the product prices if successful. #### Response Example ```json { "status": "OK", "data": { "product_id_1": { "price": "10.00", "currency": "USD" }, "product_id_2": { "price": "25.50", "currency": "EUR" } } } ``` ``` -------------------------------- ### Get Product Prices Source: https://api.base.com/?method=getProductsPrices&tester= Retrieves the prices for specified products. This method allows you to fetch current pricing information for your inventory items. ```APIDOC ## GET getInventoryProductsPrices ### Description Retrieves the prices for specified products. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryProductsPrices** (string) - Required - The name of the method to call. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryProductsPrices&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **data** (object) - Contains the product price information if successful. #### Response Example ```json { "status": "OK", "data": { "product_id_1": { "price": "100.00", "currency": "USD" }, "product_id_2": { "price": "25.50", "currency": "EUR" } } } ``` ``` -------------------------------- ### Get Inventory Purchase Order Items Source: https://api.base.com/?method=getInventoryPurchaseOrderItems&tester= Retrieves a list of items for a given inventory purchase order. ```APIDOC ## GET getInventoryPurchaseOrderItems ### Description Retrieves a list of items associated with an inventory purchase order. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryPurchaseOrderItems** (string) - Required - Specifies the action to retrieve purchase order items. ### Request Example ```json { "getInventoryPurchaseOrderItems": "sample_value" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success or failure of the operation. - **data** (object) - Contains the retrieved purchase order items if successful. #### Response Example ```json { "status": "success", "data": { "items": [ { "order_item_id": "123", "product_id": "456", "quantity": "10" } ] } } ``` ``` -------------------------------- ### Get External Storage Products Prices Source: https://api.base.com/?method=getExternalStorageProductsPrices&tester= Retrieves the prices for products within an external storage. This method is part of the external storage management functionalities. ```APIDOC ## GET getExternalStorageProductsPrices ### Description Retrieves the prices for products within an external storage. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The name of the method to call, which is 'getExternalStorageProductsPrices'. #### Request Body This method does not require a request body. Parameters are sent as POST parameters to the API address. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the product prices if the operation is successful. - **product_id** (string) - The ID of the product. - **price** (string) - The price of the product. #### Response Example ```json { "status": "OK", "data": { "123": { "price": "19.99" }, "456": { "price": "25.50" } } } ``` ``` -------------------------------- ### Get External Storage Products Quantity Source: https://api.base.com/?method=getExternalStorageProductsQuantity&tester= Retrieves the quantity of products available in external storage. This method is useful for inventory management and stock checks. ```APIDOC ## GET getExternalStorageProductsQuantity ### Description Retrieves the quantity of products in external storage. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **token** (string) - Required - Your Baselinker API token. - **method** (string) - Required - The method name, which is `getExternalStorageProductsQuantity`. ### Request Example ``` https://api.baselinker.com/connector.php?token=YOUR_API_TOKEN&method=getExternalStorageProductsQuantity ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the product quantities. - **product_id** (integer) - The ID of the product. - **quantity** (integer) - The available quantity of the product in external storage. #### Response Example ```json { "status": "OK", "data": { "123": 50, "456": 100 } } ``` ``` -------------------------------- ### Get Series Source: https://api.base.com/?method=getSeries&tester= Retrieves a list of series. This is a GET request to the API. ```APIDOC ## GET getSeries ### Description Retrieves a list of series. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The API method to call, in this case, 'getSeries'. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` GET https://api.baselinker.com/connector.php?method=getSeries&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **error_message** (string) - If status is 'ERROR', this contains the error message. - **data** (object) - Contains the series data if the request was successful. ``` -------------------------------- ### Sample createPackage Output Data Source: https://api.base.com/index.php?method=createPackage This JSON object shows the successful response from the createPackage method. It includes the status, package ID, and tracking numbers. ```json { "status": "SUCCESS", "package_id": 77014696, "package_number": "622222044730624327700198", "courier_inner_number": "12387890" } ``` -------------------------------- ### getInvoiceFile Source: https://api.base.com/ The method allows you to get the invoice file from BaseLinker. ```APIDOC ## getInvoiceFile ### Description Retrieves the file content of a specific invoice. ### Method GET ### Endpoint /getInvoiceFile ### Parameters #### Query Parameters - **invoice_id** (integer) - Required - The ID of the invoice for which to retrieve the file. ``` -------------------------------- ### createPackage Source: https://api.base.com/?method=createPackage&tester= Creates a package. This method sends POST parameters to the API address. ```APIDOC ## POST createPackage ### Description Creates a package within the Baselinker system. ### Method POST ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Request Body - **token** (string) - Required - Authorization token. - **method** (string) - Required - The method to call, which is 'createPackage'. - **parameters** (object) - Optional - Parameters specific to the createPackage method. ### Request Example ```json { "token": "YOUR_API_TOKEN", "method": "createPackage", "parameters": {} } ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the operation was successful ('OK' or 'ERROR'). - **data** (object) - Contains the response data from the API. #### Response Example ```json { "status": "OK", "data": { "package_id": "12345" } } ``` ``` -------------------------------- ### Get Inventory Suppliers Source: https://api.base.com/?method=getInventorySuppliers&tester= Retrieves a list of inventory suppliers. ```APIDOC ## GET getInventorySuppliers ### Description Retrieves a list of inventory suppliers. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventorySuppliers** (string) - Required - Specifies the action to retrieve inventory suppliers. ### Request Example ``` https://api.baselinker.com/connector.php?getInventorySuppliers ``` ### Response #### Success Response (200) - **suppliers** (array) - A list of inventory supplier objects. - **supplier_id** (integer) - The unique identifier for the supplier. - **name** (string) - The name of the supplier. - **contact_person** (string) - The contact person for the supplier. - **email** (string) - The email address of the supplier. - **phone** (string) - The phone number of the supplier. - **address** (string) - The address of the supplier. - **notes** (string) - Additional notes about the supplier. #### Response Example ```json { "status": "success", "data": { "suppliers": [ { "supplier_id": 1, "name": "Supplier A", "contact_person": "John Doe", "email": "john.doe@example.com", "phone": "123-456-7890", "address": "123 Main St, Anytown, USA", "notes": "Preferred supplier for electronics." } ] } } ``` ``` -------------------------------- ### Add Product Source: https://api.base.com/?method=addProduct&tester= Adds a new product to the inventory. This operation requires product details to be sent as POST parameters. ```APIDOC ## POST https://api.baselinker.com/connector.php ### Description Adds a new product to the inventory. ### Method POST ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Request Body - **token** (string) - Required - Your Baselinker API token. - **method** (string) - Required - The API method to call, in this case, `addProduct`. - **parameters** (object) - Optional - An object containing parameters specific to the `addProduct` method. ### Request Example ```json { "token": "YOUR_API_TOKEN", "method": "addProduct", "parameters": { "product_code": "SKU123", "name": "Example Product", "price": "19.99", "stock": "100" } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the operation was successful ('OK' or 'ERROR'). - **data** (object) - Contains the result of the operation, if successful. #### Response Example ```json { "status": "OK", "data": { "product_id": "12345" } } ``` ``` -------------------------------- ### Get Inventory Warehouses Source: https://api.base.com/?method=getInventoryWarehouses&tester= Retrieves a list of all available inventory warehouses. ```APIDOC ## GET /getInventoryWarehouses ### Description Retrieves a list of all available inventory warehouses. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryWarehouses** (string) - Required - Specifies the method to call. ### Request Example ``` https://api.baselinker.com/connector.php?getInventoryWarehouses ``` ### Response #### Success Response (200) - **warehouses** (array) - A list of warehouse objects, each containing: - **warehouse_id** (integer) - The unique identifier for the warehouse. - **name** (string) - The name of the warehouse. - **active** (boolean) - Indicates if the warehouse is active. #### Response Example ```json { "status": "success", "data": { "warehouses": [ { "warehouse_id": 1, "name": "Main Warehouse", "active": true }, { "warehouse_id": 2, "name": "Secondary Warehouse", "active": false } ] } } ``` ``` -------------------------------- ### Sample createPackage Request Data Source: https://api.base.com/index.php?method=createPackage This JSON object represents the parameters required to create a package. Ensure all required fields like order_id, courier_code, and package details are provided. ```json { "order_id": 6910995, "courier_code": "dhl", "account_id": 33, "fields": [ { "id": "service", "value": "dhl" }, { "id": "cod", "value": "101" }, { "id": "insurance", "value": "55" }, { "id": "package_description", "value": "Shipment description" } ], "packages": [ { "length": 11, "height": 12, "width": 13, "weight": 4, "size_custom": 1 } ] } ``` -------------------------------- ### getInventoryPrintoutTemplates Source: https://api.base.com/ Returns a list of all configured printout templates available for inventory (products). ```APIDOC ## GET getInventoryPrintoutTemplates ### Description Retrieves a list of available printout templates for inventory items (products). ### Method GET ### Endpoint /getInventoryPrintoutTemplates ### Response #### Success Response (200) - **templates** (array) - A list of template objects. - **template_id** (string) - The technical identifier for the template. - **template_name** (string) - The name of the template. #### Response Example { "templates": [ { "template_id": "tpl_inv_label", "template_name": "Inventory Label" } ] } ``` -------------------------------- ### Get Orders By Phone Source: https://api.base.com/?method=getOrdersByPhone&tester= Retrieves orders based on the provided phone number. ```APIDOC ## GET Orders By Phone ### Description Retrieves orders associated with a specific phone number. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getOrdersByPhone** (string) - Required - The phone number to search for orders. - **token** (string) - Required - Your Baselinker API token. ### Request Example ```http GET https://api.baselinker.com/connector.php?getOrdersByPhone=1234567890&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **orders** (array) - A list of orders matching the phone number. - **order_id** (integer) - The unique identifier for the order. - **phone** (string) - The phone number associated with the order. - ... (other order details) #### Response Example ```json { "status": "success", "data": { "orders": [ { "order_id": 1001, "phone": "1234567890", "..." } ] } } ``` ``` -------------------------------- ### Get Inventory Purchase Orders Source: https://api.base.com/?method=getInventoryPurchaseOrders&tester= Retrieves a list of inventory purchase orders. ```APIDOC ## GET getInventoryPurchaseOrders ### Description Retrieves a list of inventory purchase orders. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryPurchaseOrders** (string) - Required - The name of the method to call. ### Request Example ``` https://api.baselinker.com/connector.php?getInventoryPurchaseOrders ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful. - **data** (object) - Contains the purchase order data. #### Response Example ```json { "status": "success", "data": [ { "purchase_order_id": "123", "supplier_id": "456", "order_date": "2023-10-27", "status": "received" } ] } ``` ``` -------------------------------- ### createPackageManual Source: https://api.base.com/?method=createPackageManual&tester= Creates a package manually by sending POST parameters to the API address. ```APIDOC ## POST https://api.baselinker.com/connector.php ### Description Creates a package manually. ### Method POST ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Request Body - **token** (string) - Required - API token for authorization. - **method** (string) - Required - The API method to call, which is 'createPackageManual'. - **parameters** (object) - Optional - Additional parameters for the method. ### Request Example ```json { "token": "YOUR_API_TOKEN", "method": "createPackageManual", "parameters": {} } ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful. - **data** (object) - Contains the response data from the API. #### Response Example ```json { "status": "success", "data": { "package_id": "12345" } } ``` ``` -------------------------------- ### Get Inventory Manufacturers Source: https://api.base.com/?method=getInventoryManufacturers&tester= Retrieves a list of all manufacturers associated with your inventory in Baselinker. ```APIDOC ## GET getInventoryManufacturers ### Description Retrieves a list of all manufacturers associated with your inventory in Baselinker. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryManufacturers** (string) - Required - The method name to call. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryManufacturers ``` ### Response #### Success Response (200) - **manufacturers** (array) - A list of manufacturer objects. - **manufacturer_id** (integer) - The unique identifier for the manufacturer. - **name** (string) - The name of the manufacturer. #### Response Example ```json { "manufacturers": [ { "manufacturer_id": 1, "name": "Example Manufacturer" } ] } ``` ``` -------------------------------- ### getProductsList Source: https://api.base.com/ Downloads detailed data of selected products from BaseLinker storage or connected shop/wholesaler storage. ```APIDOC ## getProductsList ### Description Downloads detailed data of selected products from the BaseLinker storage or a shop/wholesaler storage connected to BaseLinker. ### Method GET ### Endpoint /storage/products/list ``` -------------------------------- ### runRequestParcelPickup Source: https://api.base.com/?method=runRequestParcelPickup&tester= Initiates a parcel pickup request. This method requires specific parameters to be set for the request to be processed correctly. ```APIDOC ## POST https://api.baselinker.com/connector.php ### Description Initiates a parcel pickup request. ### Method POST ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Request Body - **method** (string) - Required - The API method to call, which is 'runRequestParcelPickup' for this operation. - **parameters** (object) - Optional - An object containing parameters specific to the 'runRequestParcelPickup' method. Refer to the API documentation for the exact structure and required fields for parcel pickup requests. ``` -------------------------------- ### Get Inventory Price Groups Source: https://api.base.com/?method=getInventoryPriceGroups&tester= Retrieves a list of inventory price groups. ```APIDOC ## GET getInventoryPriceGroups ### Description Retrieves a list of inventory price groups. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The API method to call, in this case 'getInventoryPriceGroups'. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` https://api.baselinker.com/connector.php?method=getInventoryPriceGroups&token=YOUR_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates if the request was successful ('OK' or 'ERROR'). - **data** (object) - Contains the price groups data if successful. - **price_groups** (array) - An array of price group objects. - **id** (string) - The ID of the price group. - **name** (string) - The name of the price group. #### Response Example ```json { "status": "OK", "data": { "price_groups": [ { "id": "1", "name": "Default" }, { "id": "2", "name": "Wholesale" } ] } } ``` ``` -------------------------------- ### Get Inventory Fulfillment Deliveries Source: https://api.base.com/?method=getInventoryFulfillmentDeliveries&tester= Retrieves a list of inventory fulfillment deliveries. ```APIDOC ## GET getInventoryFulfillmentDeliveries ### Description Retrieves a list of inventory fulfillment deliveries. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryFulfillmentDeliveries** (string) - Required - This parameter is used to call the getInventoryFulfillmentDeliveries method. ### Request Example ```json { "getInventoryFulfillmentDeliveries": "" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the operation. - **data** (object) - Contains the fulfillment delivery data. #### Response Example ```json { "status": "success", "data": {} } ``` ``` -------------------------------- ### updateProductsQuantity Source: https://api.base.com/ Bulk updates product stock (and/or variants) in BaseLinker storage or connected shop/wholesaler storage. Maximum 1000 products. ```APIDOC ## updateProductsQuantity ### Description Bulk updates the product stock (and/or variants) in BaseLinker storage or in a shop/wholesaler storage connected to BaseLinker. Maximum 1000 products at a time. ### Method PUT ### Endpoint /storage/products/quantity ### Parameters #### Request Body - **products** (array) - Required - An array of product objects, each with product_id and quantity. ``` -------------------------------- ### Get Inventory Categories Source: https://api.base.com/?method=getInventoryCategories&tester= Retrieves a list of all inventory categories available in the system. ```APIDOC ## GET getInventoryCategories ### Description Retrieves a list of all inventory categories. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInventoryCategories** (string) - Required - Specifies the action to retrieve inventory categories. ### Request Example ``` GET https://api.baselinker.com/connector.php?getInventoryCategories ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the inventory categories if the operation was successful. - **category_id** (string) - The unique identifier for the category. - **name** (string) - The name of the category. - **parent_id** (string) - The identifier of the parent category, if any. #### Response Example ```json { "status": "OK", "data": [ { "category_id": "1", "name": "Electronics", "parent_id": null }, { "category_id": "2", "name": "Computers", "parent_id": "1" } ] } ``` ``` -------------------------------- ### Get Contractor Credit History Source: https://api.base.com/?method=getConnectContractorCreditHistory&tester= Retrieves the credit history for a specific contractor. ```APIDOC ## GET ConnectContractorCreditHistory ### Description Retrieves the credit history for a specific contractor. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The API method to call, which is 'getConnectContractorCreditHistory'. - **token** (string) - Required - Your Baselinker API token. ### Request Example ``` GET https://api.baselinker.com/connector.php?method=getConnectContractorCreditHistory&token=YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation ('OK' or 'ERROR'). - **data** (object) - Contains the credit history details if the operation is successful. #### Response Example ```json { "status": "OK", "data": { "contractor_id": "123", "credit_history": [ { "date": "2023-10-27", "description": "Invoice #INV-001", "amount": "-50.00" }, { "date": "2023-10-20", "description": "Payment Received", "amount": "100.00" } ] } } ``` ``` -------------------------------- ### getProductsQuantity Source: https://api.base.com/ Retrieves stock levels for products from BaseLinker storage or connected shop/wholesaler storage. ```APIDOC ## getProductsQuantity ### Description Retrieves stock from the BaseLinker storage or the shop/wholesaler storage connected to BaseLinker. ### Method GET ### Endpoint /storage/products/quantity ``` -------------------------------- ### Get Order Printout Templates Source: https://api.base.com/?method=getOrderPrintoutTemplates&tester= Retrieves a list of available order printout templates. ```APIDOC ## GET /getOrderPrintoutTemplates ### Description Retrieves a list of available order printout templates. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **method** (string) - Required - The API method to call, which is 'getOrderPrintoutTemplates'. ### Request Example ```json { "method": "getOrderPrintoutTemplates" } ``` ### Response #### Success Response (200) - **templates** (array) - A list of available printout templates. Each template object may contain properties like 'id', 'name', etc. #### Response Example ```json { "templates": [ { "id": "1", "name": "Default Invoice Template" }, { "id": "2", "name": "Shipping Label Template" } ] } ``` ``` -------------------------------- ### getCategories Source: https://api.base.com/ Downloads a list of categories for a BaseLinker storage or a connected shop storage. ```APIDOC ## getCategories ### Description Downloads a list of categories for a BaseLinker storage or a shop storage connected to BaseLinker. ### Method GET ### Endpoint /storage/categories ``` -------------------------------- ### getProductsPrices Source: https://api.base.com/ Fetches prices of products from BaseLinker storage or connected shop/wholesaler storage. ```APIDOC ## getProductsPrices ### Description Fetches prices of products from the BaseLinker storage or the shop/wholesaler storage connected to BaseLinker. ### Method GET ### Endpoint /storage/products/prices ``` -------------------------------- ### Get Invoices Source: https://api.base.com/?method=getInvoices&tester= Retrieves a list of invoices. This method is part of the order management functionalities. ```APIDOC ## GET getInvoices ### Description Retrieves a list of invoices from the system. ### Method GET ### Endpoint https://api.baselinker.com/connector.php ### Parameters #### Query Parameters - **getInvoices** (string) - Required - Specifies the method to call. #### Request Body No request body is specified for this method. Parameters are sent as POST parameters to the API address. ### Request Example ``` { "token": "YOUR_API_TOKEN", "getInvoices": "" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the operation (e.g., "ok"). - **invoice_id** (integer) - The ID of the invoice. - **invoice_number** (string) - The number of the invoice. - **invoice_date** (string) - The date the invoice was issued. #### Response Example ```json { "status": "ok", "invoices": [ { "invoice_id": 123, "invoice_number": "INV-001", "invoice_date": "2023-10-27" } ] } ``` ```