Loyverse is a point-of-sale (POS) and inventory management system designed for small and medium-sized businesses. It allows businesses to manage sales, track inventory, and analyze customer data through its mobile and web-based platform, providing a comprehensive solution for retail and hospitality establishments.
Refer to our website for the list of metrics and attributes available in Dataddo.
Refer to Loyverse's official documentation to see all available endpoints from the Loyverse API.
Authorize Connection to Loyverse
To authorize this service, use OAuth 2.0 to share specific data with Dataddo while keeping usernames, passwords, and other information private.
- On the Authorizers page, click on Authorize New Service and select your service.
- Follow the on-screen prompts to grant Dataddo the necessary permissions to access and retrieve your data.
- [Optional] Once your authorizer is created, click on it to change the label for easier identification.
Ensure that the account you're granting access to holds at least admin-level permissions. If necessary, assign a team member with the required permissions with the authorizer role to authenticate the service for you.
For more information, see our article on authorizers.
Data Coverage
Loyverse exposes the following datasets. Each dataset maps to a table you can extract. Example fields are a representative sample; each dataset returns more columns.
| Dataset | Description | Example fields | Date range |
|---|---|---|---|
| Categories | Get a list of categories | ID, Color, Created At, Deleted At, Name | No |
| Customers | Get a list of customers | ID, Address, City, Country Code, Created At, Customer Code (+12 more) | Yes |
| Discounts | Get a list of discounts | ID, Created At, Deleted At, Discount Amount, Discount Percent, Name (+3 more) | Yes |
| Employees | Get a list of employees | Employee ID, Created At, Deleted At, Email, Is Owner, Name (+2 more) | Yes |
| Inventory | Stock levels for item variants | Variant ID, In Stock, Store ID, Updated At | No |
| Items | Get a list of items | ID, Category ID, Color, Created At, Deleted At, Form (+13 more) | Yes |
| Modifiers | Get a list of modifiers | ID, Created At, Deleted At, Name, Position, Updated At | Yes |
| Payment types | Get a list of payment types | ID, Created At, Deleted At, Name, Type, Updated At | Yes |
| POS Devices | Get a list of POS devices | ID, Activated, Deleted At, Name, Store ID | No |
| Receipts | Get a list of receipts | Customer ID, Cancelled At, Created At, Dining Option, Employee ID, Note (+18 more) | Yes |
| Receipts Discounts | Get a list of receipts' discounts | Receipt number, Created At, Receipt type, Total Discount, Total Discounts Id, Total Discounts Money Amount (+3 more) | Yes |
| Receipts Line Items | Get a list of receipts' line items | Customer ID, Created At, Dining Option, Employee ID, Line item cost, Line item cost total (+30 more) | Yes |
| Receipts Payments | Get a list of receipts' payments | Receipt number, Created At, Money amount, Name, Paid at, Paymemt Type ID (+4 more) | Yes |
| Receipts Taxes | Get a list of receipts' taxes | Customer ID, Created At, Dining Option, Employee ID, Note, Order (+21 more) | Yes |
| Shifts | Get a list of Shifts | ID, Actual Cash, Cash Payments, Cash Refunds, Closed At, Closed By Employee (+14 more) | Yes |
| Stores | Get a list of stores | ID, Address, Created At, Deleted At, Description, Name (+2 more) | Yes |
| Suppliers | Get a list of suppliers | ID, Address 1, Address 2, City, Contact, Country Code (+10 more) | No |
| Taxes | Get a list of taxes | ID, Created At, Deleted At, Name, Rate, Type (+1 more) | Yes |
| Variants | Get a list of item variant | Item ID, Barcode, Cost, Created at, Default price, Default pricing type (+15 more) | Yes |
How Data Extraction Works
What each extraction pulls depends only on whether a dataset supports a date range (see the Date range column above):
- Date range supported (Yes): the source reads a relative window (for example "last 7 days"), and that window slides forward with the current date. Every run re-reads the window, so a range of "1 day ago" always pulls the previous day (D-1). Each run replaces the window's data rather than adding older history. To load records from before the window, run a full data re-sync with a wider range. See Data Backfilling.
- No date range (No): every run pulls all currently available data.
Set the relative date range when you create the source.
Metadata Columns
When you create a source, you can add these Dataddo metadata columns to the extracted data:
- dataddo_hash - a fingerprint built from each record's key fields. It works as a natural key, so it is ideal for upserts (updating existing rows in your destination instead of creating duplicates).
- dataddo_extraction_timestamp - the date and time the row was extracted. Use it to track how records change over time, for example to build slowly changing dimensions.
How to Create a Loyverse Data Source
Creating a data source takes you through six steps, shown in the progress bar at the top of the wizard. Each step is explained below.
1. Pick the connector
On the Sources page, click Create Source, then select the connector from the catalog. Use the search bar or the category tabs if you do not see it right away. You can rename the source at any time using the pencil icon next to its name.
2. Select the dataset
A dataset defines the shape of your data: which fields you get and how they relate. Select the dataset you want; you can still fine-tune the exact fields later.
- Each dataset has a short description of what it contains. Use the search box to find a dataset, attribute, or metric by name.
- The panel on the right previews the selected dataset's fields. For each field you can see its data type, whether it holds sensitive data (personal fields such as name or email are flagged), and which other datasets it links to, so you can see how the datasets relate.
3. Choose the account
This step selects what Dataddo reads from.
- Authorizer: Select an account you have already authorized from the drop-down. If you have none yet, choose Add new account and follow the prompts. If no authorizer is selected, Dataddo asks you to authorize before you continue.
- What to extract from: Select the exact entity you want to pull data from. Depending on the service this may be labelled an account, property, profile, workspace, or similar, sometimes with a sub-level to choose as well.
- Multiple accounts: To pull the same data from every entity you can access, turn on Automatically collect data from all .... This is multi-account extraction. Leave it off to choose them by hand.
4. Refine the attributes and metrics
The dataset already sets the structure. Here you fine-tune it: tick or untick the specific attributes and metrics you want to keep, and use the search box to find a field quickly. Click Test on Sample Data at any point to preview the result before you continue.
5. Add metadata columns (optional)
Two optional columns help your destination handle the data.
- Dataddo Hash (Include Row Hash): a fingerprint built from the columns you pick. It works as a natural key, so your destination can deduplicate rows and run upserts instead of creating duplicates. Turn it on, then select the columns that uniquely identify a row.
- Dataddo Extraction Timestamp: the time each row was extracted. Use it to watermark the data, for example to build slowly changing dimensions or to track when a value last changed.
6. Set the schedule
Decide how often Dataddo runs the extraction.
- Frequency: how often the pipeline runs, for example daily. Click Show advanced settings to also set the exact hour and minute (UTC).
- Date range: the relative window each run extracts, for example "Yesterday". The window moves forward on every run.
- Historical data: a new source starts from the current window. To load older data, run a full data re-sync after the source is created.
- Allow Empty Data Extractions: when on, a run that returns no data records zero rows instead of failing. Turn it on if the source can legitimately have periods with no data.
Click Save. Your data source is ready.
Troubleshooting
Data Preview Unavailable
No data preview when you click on Test Data might be caused by an issue with your source configuration. The most common causes are:
- Date range: Try a smaller date range. You can load the rest of your data afterward via manual data load.
- Insufficient permissions: Please make sure your authorized account has at least admin-level permissions.
Related Articles
Now that you have successfully created a data source, see how you can connect your data to a dashboarding app or a data storage.
Sending Data to Dashboarding Apps
Sending Data to Data Storages
Other Resources