| Active |
|---|
| This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
The Loyverse 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 watch, retrieve, and list the employees, itemsItems are rows in records (order/request/invoice/purchase...), payment types, stores, and receipts in your Loyverse account.
Prerequisites
-
A Loyverse account
In order to use Loyverse with 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., it is necessary to have a Loyverse account. If you do not have one, you can create a Loyverse account at loyverse.com/signup.
To connect your Loyverse account to Boost.space Integrator you need to obtain the API TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. from your Loyverse account and insert it in the Create a connection dialog in the Boost.space Integrator moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts).
1. To generate the API tokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications., click here.
2. Click Add API Token.
3. Enter a name for the API token, select the expiry date option if required, and click Save.
4. Copy the API Token to your clipboard.
5. Go to Boost.space Integrator and open the Loyverse module’s Create a connection dialog.
6. In the Connection name field, enter a name for the connection.
7. In the Access Token field, enter the API token copied in step 4 and click Continue.
The connection has been established successfully.
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 itemItems are rows in records (order/request/invoice/purchase...) is added, updated or deleted.
Required Permissions: ITEMS_READ
|
Connection |
|
|
Event Type |
Select the option to watch the items:
|
|
Limit |
Set the number of returned items Boost.space Integrator will 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).. |
Retrieves details for a list of items.
Required Permissions: ITEMS_READ
|
Connection |
|
|
Filter |
Select the filters to list the items. |
|
Item IDs |
Add the Item IDs you want to list. |
|
Show Deleted |
Select whether you want to list the deleted items:
|
|
Limit |
Set the number of returned items Boost.space Integrator will return during one execution cycle. |
Retrieves details for an item by item ID.
Required Permissions: ITEMS_READ
|
Connection |
|
|
Item ID |
Select the Item ID whose details you want to retrieve. |
Triggers when a new employee is added, updated, or deleted.
Required Permissions: EMPLOYEES_READ
|
Connection |
|
|
Event Type |
Select the option to watch the employees:
|
|
Limit |
Set the number of returned employees Boost.space Integrator will return during one execution cycle. |
Retrieves details for a list of employees.
Required Permissions: EMPLOYEES_READ
|
Connection |
|
|
Filter |
Select the filters to list the employees. |
|
Employee IDs |
Add the Employee IDs you want to list. |
|
Show Deleted |
Select whether you want to list the deleted employees:
|
|
Limit |
Set the number of returned employees Boost.space Integrator will return during one execution cycle. |
Retrieves details for an employee by employee ID.
Required Permissions: EMPLOYEES_READ
|
Connection |
|
|
Employee ID |
Select the Employee ID whose details you want to retrieve. |
Triggers when a new receipt is added, updated or deleted.
Required Permissions: RECEIPTS_READ, STORES_READ
|
Connection |
|
|
Event Type |
Select the option to watch the receipts:
|
|
Store ID |
Select the Store ID whose receipts you want to watch. |
|
Limit |
Set the number of returned receipts Boost.space Integrator will return during one execution cycle. |
Retrieves details for a list of receipts.
Required Permissions: RECEIPTS_READ, STORES_READ
|
Connection |
|
|
Filter |
Select the filters to list the employees. |
|
Receipt Numbers |
Add the receipt numbers you want to list. |
|
Store IDs |
Select the Store IDs whose receipt numbers you want to list. |
|
Limit |
Set the number of returned receipt numbers Boost.space Integrator will return during one execution cycle. |
Retrieves the details for a receipt by receipt number.
Required Permissions: RECEIPTS_READ
|
Connection |
|
|
Receipt Number |
Select the receipt number whose details you want to retrieve. |
Triggers when a new payment is added, updated, or deleted.
Required Permissions: PAYMENT_TYPES_READ
|
Connection |
|
|
Event Type |
Select the option to watch the payment types:
|
|
Limit |
Set the number of returned payment types Boost.space Integrator will return during one execution cycle. |
Triggers when a new store is added, updated, or deleted.
Required Permissions:STORES_READ
|
Connection |
|
|
Event Type |
Select the option to watch the stores:
|
|
Limit |
Set the number of returned stores Boost.space Integrator will return during one execution cycle. |
Retrieves details for a payment type by payment type ID.
Required Permissions: PAYMENT_TYPES_READ
|
Connection |
|
|
Filter |
Select the filters to list the payment types. |
|
Payment Type IDs |
Add the Payment Type IDs you want to list. |
|
Store IDs |
Select the Store IDs whose payment types you want to list. |
|
Show Deleted |
Select whether you list the deleted payment types:
|
|
Limit |
Set the number of returned payment types Boost.space Integrator will return during one execution cycle. |
Retrieves details for a payment type by payment type ID.
Required Permissions: PAYMENT_TYPES_READ
|
Connection |
|
|
Payment Type |
Select the Payment Type whose details you want to retrieve:
|
Retrieves details for a list of stores.
Required Permissions: STORES_READ
|
Connection |
|
|
Filter |
Select the filters to list the stores. |
|
Store IDs |
Add the Store IDs you want to list. |
|
Show Deleted |
Select whether you list the deleted stores:
|
|
Limit |
Set the number of returned stores Boost.space Integrator will return during one execution cycle. |
Retrieves details for a store by store ID.
Required Permissions: STORES_READ
|
Connection |
|
|
Store ID |
Select the Store ID whose details you want to retrieve. |
Performs an arbitrary authorized call.
|
Connection |
|
|
URL |
Enter a path relative to For the list of available endpoints, refer to the Loyverse API Documentation. |
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
Query String |
Enter the request query string. |
|
Body |
Enter the body content for your API call. |
The following API call returns all the categories from your Loyverse account:
URL: /v0.7/categories
Method: GET
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 > categories. In our example, 3 categories were returned:
