| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The BaseLinker modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) allow you to monitor, create, update, send, retrieve, list, and delete the orders, invoices, payments, and packages in your BaseLinker account.
Prerequisites
- A BaseLinker account – create an account at baselinker.com/en-US/home/.
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
| The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) dialog fields that are displayed in bold (in the Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect your BaseLinker account to Boost.space Integrator you need to obtain the API Key from your BaseLinker account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your BaseLinker account.
2. Click Your Profile Icon > My Account > API.
3. Enter a name for the API and click Generate TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. and copy the API Key to your clipboard.
4. Go to Boost.space Integrator and open the BaseLinker module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API Key copied in step 3 and click Continue.
The connection has been established.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a new order has been added.
Connection |
Establish a connection to your BaseLinker account. |
Limit |
Set the maximum number of new orders Boost.space Integrator should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Searches for orders or lists them all.
Connection |
Establish a connection to your BaseLinker account. |
Date Confirmed from |
Enter (map) the date to search the orders that were confirmed on or after the specified date. |
Date from |
Enter (map) the date to search the order from the specified date. |
Order ID from |
Select or map the Order ID whose details you want to search. |
Get Unconfirmed Orders |
Select whether you want to search for the unconfirmed orders. |
StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. ID |
Select or map the Status ID to list the orders with the specified status. |
Filter by Email |
Enter (map) the email address to list the orders that match the specified email address. |
Limit |
Set the maximum number of orders Boost.space Integrator should return during one execution cycle. |
Retrieves a single order specified by ID.
Connection |
Establish a connection to your BaseLinker account. |
Order ID |
Select or map the Order ID whose details you want to retrieve. |
Creates a new order.
Connection |
Establish a connection to your BaseLinker account. | ||||||||||||||||||||||
Order Status ID |
Select or map the status of the order. | ||||||||||||||||||||||
Phone |
Enter (map) the customer’s phone number. | ||||||||||||||||||||||
| Enter (map) the customer’s email address. | |||||||||||||||||||||||
Date Add |
Enter (map) the date on which the order is being created. | ||||||||||||||||||||||
UserCan use the system on a limited basis based on the rights assigned by the admin. Comments |
Enter (map) the notes for the order. | ||||||||||||||||||||||
AdminAdmins in Boost.space have exclusive access to system settings. They manage the overall system setup, including appearance, language, currency, user settings, and the availability of individual modules to users and teams. Comments |
Enter (map) the admin notes for the order. | ||||||||||||||||||||||
Currency |
Select or map the currency code applicable for the order. | ||||||||||||||||||||||
Payment Method |
Enter (map) the payment method for the order. | ||||||||||||||||||||||
Payment Method Code |
Select whether the payment method code is cash on delivery (payment on delivery). | ||||||||||||||||||||||
Paid |
Select whether the order is already paid. | ||||||||||||||||||||||
Delivery Method |
Enter (map) the delivery method of the order. | ||||||||||||||||||||||
Delivery Price |
Enter (map) the charges for the delivery of the order. | ||||||||||||||||||||||
Delivery Full Name |
Enter (map) the contact person’s full name to mention in the delivery address. | ||||||||||||||||||||||
Delivery Company |
Enter (map) the company name to mention in the delivery address. | ||||||||||||||||||||||
Delivery Address |
Enter (map) the order’s delivery address. | ||||||||||||||||||||||
Delivery City |
Enter (map) the city name to mention in the delivery address. | ||||||||||||||||||||||
Delivery Postal Code |
Enter (map) the delivery address postal code. | ||||||||||||||||||||||
Delivery Point ID |
Enter (map) the delivery pickup point ID. | ||||||||||||||||||||||
Delivery Point Name |
Enter (map) the delivery pickup point name. | ||||||||||||||||||||||
Delivery Point Address |
Enter (map) the delivery pickup point address. | ||||||||||||||||||||||
Delivery Point PostCode |
Enter (map) the delivery pickup point postal code. | ||||||||||||||||||||||
Delivery Point City |
Enter (map) the delivery pickup point city name. | ||||||||||||||||||||||
Invoice Full Name |
Enter (map) the billing address contact person’s full name. | ||||||||||||||||||||||
Invoice Company |
Enter (map) the billing address company name. | ||||||||||||||||||||||
Invoice NIP |
Enter (map) the billing address company’s VAT or tax number. | ||||||||||||||||||||||
Invoice Address |
Enter (map) the billing address. | ||||||||||||||||||||||
Invoice City |
Enter (map) the billing address city name. | ||||||||||||||||||||||
Invoice Country Code |
Select or map the billing address country code. | ||||||||||||||||||||||
Want Invoice |
Select whether the customer wants the invoice copy. | ||||||||||||||||||||||
Extra Field 1 |
Enter (map) any additional fields you want to add. | ||||||||||||||||||||||
Extra Field 2 |
Enter (map) any additional fields you want to add. | ||||||||||||||||||||||
Products |
Add the products to the order:
|
Triggers when a new invoice numeration series have been added.
Connection |
Establish a connection to your BaseLinker account. |
Limit |
Set the maximum number of series Boost.space Integrator should return during one execution cycle. |
Searches for invoices or lists them all.
Connection |
Establish a connection to your BaseLinker account. |
Invoice ID |
Select or map the Invoice ID whose details you want to search. |
Invoice ID from |
Select or map the option to search the invoices collected from the specified option. |
Date from |
Select or map the date to search the invoices collected from the specified date. |
Order ID |
Select or map the Order ID whose invoices you want to search. |
Get External Invoices |
Select whether you want to get the external invoices. |
Series ID |
Select or map the Series ID number to search the invoices with the specified ID. |
Limit |
Set the maximum number of invoices Boost.space Integrator should return during one execution cycle. |
Adds an invoice to an order specified by ID.
Connection |
Establish a connection to your BaseLinker account. |
Order ID |
Select or map the Order ID to which you want to add the invoice. |
Series ID |
Select or map the Series ID of the invoice you want to add. |
Adds a payment to an order specified by ID.
Connection |
Establish a connection to your BaseLinker account. |
Order ID |
Select or map the Order ID to which you want to add the payment information. |
Payment Done |
Enter (map) the payment deposit amount. The value replaces the current payment in the order (it is not added up with the previous value). If the amount matches the order value, the order will be marked as paid. |
Payment Date |
Enter (map) the date on which the payment for the invoice is made. |
Payment Comment |
Enter (map) any additional information or notes about the payment. |
Lists all order packages.
Connection |
Establish a connection to your BaseLinker account. |
Order ID |
Select or map the Order ID whose packages you want to list. |
Limit |
Set the maximum number of packages Boost.space Integrator should return during one execution cycle. |
Creates a new package.
Connection |
Establish a connection to your BaseLinker account. | ||||||||
Order ID |
Select or map the Order ID for which you want to create the package. | ||||||||
Courier Code |
Select or map the courier service through the package is being sent and enter the fields that auto-populate based on your selection. | ||||||||
Packages |
Add the package details:
|
Deletes a package.
Connection |
Establish a connection to your BaseLinker account. |
Courier Code |
Select or map the Order ID whose packages you want to delete. |
Order ID |
Select or map the order whose package you want to delete. |
Select Package By |
Select or map the options to choose the package you want to delete:
|
Package ID |
Select or map the Package ID you want to delete. |
Package Number |
Select or map the Package Number you want to delete. |
Force Delete |
Select whether you want to remove the parcel from the BaseLinker database in case of an errorService is unavailable due to a failure, a service responds with unexpected data or the validation of input data fails. with the removal of the parcel in the courier API. |
Performs an arbitrary authorized API call.
Connection |
Establish a connection to your BaseLinker account. |
Method |
Enter the method you want to call. For example: getOrders
For the list of available endpoints, refer to the BaseLinker API Documentation. |
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
Parameters |
Enter (map) the parameters you want to retrieve. |
Query String |
Enter the request query string. |
The following API call returns all the invoices from your BaseLinker account:
Method: getInvoices
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > invoices. In our example, 2 invoices were returned:
