# Open
Source: https://docs.lomaplatform.com/integrations/open

Get up and running with LOMA's integration with Open.

## Introduction

LOMA can automatically sync your discount usage data with [Open](https://www.getopen.com/).

## Setup Guide

### Getting Started

To give LOMA access to your data on Open, you'll need to reach out to your Open representative and let them know you'd like to use the integration.
Once requested, Open will start pushing data to LOMA.

### Finishing Up

After Open has started sending data, enable the integration:

1. Log in to your [LOMA](https://console.lomaplatform.com) account.
2. Navigate to **Settings -> Open**.
3. Ensure **Enabled** is turned on and then click **Save**.

Once that's done, you're all set!
Discount usage data will start to flow through every day. This is not an immediate process, however.
Expect to wait at least a day before starting to see data in LOMA.

Your settings on LOMA should look like this:

<img alt="Open reference settings" />

## Limitations

* Historical data will not be automatically synced.
  Contact us if you would like to do a one-time pull for historical data.
* Currently, LOMA is not able to automatically sync the IDs for your locations between both platforms.
  Let us know if you add any locations and we will map them accordingly.

## Need Help?

If you are having issues, [contact us](mailto:support@lomaplatform.com).


# Restaurant365
Source: https://docs.lomaplatform.com/integrations/restaurant365

Get up and running with LOMA's integration with Restaurant365.

## Introduction

LOMA can automatically sync your sales data with Restaurant365.
It works by using R365's [OData API](https://docs.restaurant365.com/docs/restaurant365-odata-connector).
When configured, LOMA will pull and sync the available data on a daily basis.

## Setup Guide

### Granting Access

To give LOMA access to your data on Restaurant365, you'll need to create an account with access to their OData API.
Any active Restaurant365 user with the **Accounting Clerk** or **Full Access** role should have the necessary permissions.
Refer to their [documentation](https://docs.restaurant365.com/docs/restaurant365-odata-connector#authorized-users-r365-application) for more information.

### Finishing Up

Once you have a R365 account for LOMA to use, enable the integration:

1. Log in to your [LOMA](https://console.lomaplatform.com) account.
2. Navigate to **Settings -> Restaurant365**.
3. Enter your **username**, **password**, and **company** from Restaurant365.
4. Ensure **Enabled** is turned on and then click **Save**.

<Note>
  Your "company" on R365 is usually the same as your subdomain. <br />
  For example, if your subdomain is `example.restaurant365.com`, your company is `example`.
</Note>

Once that's done, you're all set!
Sales data will start to flow through every day. This is not an immediate process, however.
Expect to wait at least a day before starting to see data in LOMA.

Your settings on LOMA should look like this:

<img alt="Restaurant365 reference settings" />

## Notes

* Historical data will not be automatically synced.
  Contact us if you would like to do a one-time pull for historical data.
* If you did not provide us with an internal identifier for your locations, the integration will not be able to automatically sync any data.
  Contact us to work through mapping your locations between the two platforms.

## Need Help?

If you run into any issues with this process, refer to the [Restaurant365 documentation](https://docs.restaurant365.com/docs/restaurant365-odata-connector).

If you are still having issues, [contact us](mailto:support@lomaplatform.com).


# Toast
Source: https://docs.lomaplatform.com/integrations/toast

Get up and running with LOMA's integration with Toast.

## Introduction

LOMA can automatically sync your sales data with Toast.
It works by using Toast's [Data Exports](https://central.toasttab.com/s/article/Automated-Nightly-Data-Export-1492723819691) feature.
When configured, LOMA will pull and sync the available data on a daily basis.

### Quick Start

<img alt="Toast guide 1" />

<img alt="Toast guide 2" />

## Setup Guide

### Configuring Exports

Before we can start pulling data, you must first have exports configured on your Toast account:

<Note>Only users with the `Data Export Config` permission on Toast can modify these settings.</Note>

1. Log in to your [Toast](https://pos.toasttab.com/) account.
2. Navigate to **Reports → Settings → Data Exports**.
3. Select **Enabled** next to "Orders" and tick all **include** checkboxes.
4. **Save** your changes.
5. Click **view restaurant # mapping** and send us that file.
   We will use it to map your locations on LOMA to your locations in Toast.
   Without it, we won't be able to sync the data.
   You can also manually update the **Toast ID** of your locations via the [LOMA Console](https://console.lomaplatform.com).

### Granting Access

To give LOMA access to your data, add our public SSH key to your Toast account:

1. Log in to your [Toast](https://pos.toasttab.com/) account.
2. Navigate to **Reports → Settings → SSH Keys**.
3. Click **Add new key** and paste in our key:

```
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCU7ig51e5YvBaOQSN9OkW3/YmHWooYMxYeo9zF88kz4q1Z0NsLVYdM539Bj9cK+H1I5DCEQEIOLrn03/EmRnQfWooIo5HLy7SYzwImI5Pl/l54Q1gEw9ZoKz4iVl9HM6A9AgvC2tKlLbMX/0aRgqTLT6g0ejNGhlJn3XdbGaNazpcRN3tCmTqd/2mlqdcY/qGtfH3uvF5F0z5qXPgy9085wPJFjT7M0AXPGG7KXwrEEQ7uzkiEip5XZOB4DL8ElQEzQ5RcQYoPnM2Mnmw8exXZ25lu/WWxq6fgC5yLXoTXIvNqF+3rX3iMi3FYoHEZN7k0ytC8CoXXdQuscyII4hQ4KSJ1KD+4pr5FUbMO8/sAhKNqC/6x5KiYTjwQhot+u3+ngL0880RHqMPm6MsDxKld/xCftY2E1x5PodrRp9JVhNlvOKlft9UnNbUyP7DEhXn8XKHo3LssGQChJdmhcnAK4CHF2CCaX+qxnpRnmY3wdH+FjYT3IHrpkSEY781TmZbO+Y99Jxuy9k8SH3ZnCvAt5YLilTHT/IdcBdgPC6CFcVbDn5Uqomhbm0EJu/c2jX9behe0RGKYn9nmSulS3QZEyINy3w+S7xNAqq6nckxPPazELS6JHHpH0ZoBcRCEizyT6oaqCwehylB8Tszqs1PuRF/IzrPmRscfZ+oQx0rgnw==
```

### Finishing Up

Once your exports are set up and LOMA has been granted access, enable the integration:

1. Log in to your [Toast](https://pos.toasttab.com/) account.
2. Navigate to **Reports → Settings → SSH Keys**.
3. In a separate tab, log in to your [LOMA](https://console.lomaplatform.com) account.
4. Navigate to **Settings -> Toast**.
5. Copy and paste the **SFTP Username** and **Server URL** from Toast.
6. Ensure **Enabled** is turned on and then click **Save**.

Once that's done, you're all set!
Sales data will start to flow through every day. This is not an immediate process, however.
Expect to wait at least a day before starting to see data in LOMA.

Your settings on LOMA should look like this:

<img alt="Toast reference" />

## Need Help?

If you run into any issues with this process, refer to the [Toast documentation](https://central.toasttab.com/s/article/Automated-Nightly-Data-Export-1492723819691).

If you are still having issues, [contact us](mailto:support@lomaplatform.com).

## Limitations

Toast only keeps data for the past 7 days in the data export server.
You'll need to use a different source if you want to import historical sales data.
We are able to ingest historical data from data warehouses, spreadsheets, or other sources.
[Contact us](mailto:support@lomaplatform.com) to find a solution that works for you.


# Introduction
Source: https://docs.lomaplatform.com/introduction

Welcome to LOMA's documentation.

## New to LOMA?

LOMA is the platform designed to validate and scale local marketing for multi-unit brands. With LOMA, you can easily manage and optimize your local marketing efforts across multiple locations. Using our platform, you can streamline your marketing processes, improve efficiency, and achieve better results.

## Getting started

After signing up, you can start using LOMA right away:

1. Add your locations
2. Choose your marketing vendors
3. Analyze your results


# Get Activity
Source: https://docs.lomaplatform.com/organization-api/activities/get-activity

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/activities/{id}
Gets an activity for an organization



# List Activities
Source: https://docs.lomaplatform.com/organization-api/activities/list-activities

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/activities
Lists activities for an organization



# Get Activity Preset
Source: https://docs.lomaplatform.com/organization-api/activity-presets/get-activity-preset

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/activity-presets/{id}
Gets an activity preset for an organization



# List Activity Presets
Source: https://docs.lomaplatform.com/organization-api/activity-presets/list-activity-presets

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/activity-presets
Lists all activity presets for an organization



# Get Location
Source: https://docs.lomaplatform.com/organization-api/locations/get-location

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/locations/{id}
Gets a location for an organization



# List Locations
Source: https://docs.lomaplatform.com/organization-api/locations/list-locations

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/locations
Lists locations for an organization



# Get Order
Source: https://docs.lomaplatform.com/organization-api/orders/get-order

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/orders/{id}
Gets an order for an organization



# List Orders
Source: https://docs.lomaplatform.com/organization-api/orders/list-orders

https://console.lomaplatform.com/api/org/v1/openapi get /api/org/v1/orders
Lists orders for an organization



# Quickstart
Source: https://docs.lomaplatform.com/organization-api/quickstart

Getting started with LOMA's organization API

The LOMA organization API is a RESTful API that allows you to manage several aspects of your organization, including locations, sales data, and tracking activities.

## Authentication

To authenticate requests made to the API, your API Key should be passed in the `API-Key` header formatted as `KEY_ID:KEY_SECRET`.

```ts theme={null}
headers: {
  "API-Key": "KEY_ID:KEY_SECRET"
}
```

### Creating API Keys

Organization admins can create API keys by navigation to the "API Keys" section in the settings page.

<img />

## API Endpoints

Check out the available API endpoints, or you can view the OpenAPI specification file.

<Note>
  The base URL for all endpoints is [https://console.lomaplatform.com](https://console.lomaplatform.com)
</Note>

<CardGroup>
  <Card title="API Endpoints" icon="server" href="/organization-api/locations/list-locations">
    Check out the API endpoints.
  </Card>

  <Card title="OpenAPI Specification" icon="leaf" href="https://console.lomaplatform.com/api/org/v1/openapi">
    View the OpenAPI specification file.
  </Card>
</CardGroup>


# Upsert Daily Sales
Source: https://docs.lomaplatform.com/organization-api/sales/upsert-daily-sales

https://console.lomaplatform.com/api/org/v1/openapi put /api/org/v1/sales/daily
Upserts daily sales data by location and date.



# Get KPI
Source: https://docs.lomaplatform.com/vendor-api/kpis/get-kpi

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/kpis/{kpiId}
Retrieves a specific KPI.



# List all KPIs
Source: https://docs.lomaplatform.com/vendor-api/kpis/list-all-kpis

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/kpis
Lists all KPIs available for use.



# Get KPI
Source: https://docs.lomaplatform.com/vendor-api/order-kpis/get-kpi

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{orderId}/kpis/{kpiId}
Retrieves a KPI for an order.



# List KPIs
Source: https://docs.lomaplatform.com/vendor-api/order-kpis/list-kpis

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{orderId}/kpis
Lists all KPIs for an order.



# Upsert KPI
Source: https://docs.lomaplatform.com/vendor-api/order-kpis/upsert-kpi

https://console.lomaplatform.com/api/vendor/v1/openapi put /api/vendor/v1/orders/{orderId}/kpis
Upserts a KPI for an order.



# Create a result from JSON
Source: https://docs.lomaplatform.com/vendor-api/order-results/create-a-result-from-json

https://console.lomaplatform.com/api/vendor/v1/openapi post /api/vendor/v1/orders/{orderId}/results/json
Creates a CSV result file from JSON data.



# Delete a result
Source: https://docs.lomaplatform.com/vendor-api/order-results/delete-a-result

https://console.lomaplatform.com/api/vendor/v1/openapi delete /api/vendor/v1/orders/{orderId}/results/{resultId}
Deletes a result for an order.



# Get a result
Source: https://docs.lomaplatform.com/vendor-api/order-results/get-a-result

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{orderId}/results/{resultId}
Retrieves a single result for an order.



# Get a result URL
Source: https://docs.lomaplatform.com/vendor-api/order-results/get-a-result-url

https://console.lomaplatform.com/api/vendor/v1/openapi post /api/vendor/v1/orders/{orderId}/results/{resultId}/url
Retrieves a signed URL for a result file.

### Notes

 The URL will expire after 1 hour.



# List results
Source: https://docs.lomaplatform.com/vendor-api/order-results/list-results

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{orderId}/results
Lists all results for an order.

### Notes

Results are ordered by creation date.



# Rename a result
Source: https://docs.lomaplatform.com/vendor-api/order-results/rename-a-result

https://console.lomaplatform.com/api/vendor/v1/openapi post /api/vendor/v1/orders/{orderId}/results/{resultId}/rename
Renames a single result for an order.



# Get an order
Source: https://docs.lomaplatform.com/vendor-api/orders/get-an-order

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders/{id}
Retrieves a single order for a vendor.

### Notes

All orders returned have been paid for.



# List orders
Source: https://docs.lomaplatform.com/vendor-api/orders/list-orders

https://console.lomaplatform.com/api/vendor/v1/openapi get /api/vendor/v1/orders
Lists orders for a vendor.

### Notes

Orders are sorted by payment date. The most recent orders are shown first. All orders returned have been paid for.



# Quickstart
Source: https://docs.lomaplatform.com/vendor-api/quickstart

Getting started with LOMA's vendor API

The LOMA vendor API is a RESTful API for vendors that allows you to manage orders and their resulting KPIs and files.

## Authentication

To authenticate requests made to the API, your API Key should be passed in the `API-Key` header formatted as `KEY_ID:KEY_SECRET`.

```ts theme={null}
headers: {
  "API-Key": "KEY_ID:KEY_SECRET"
}
```

### Creating API Keys

Vendors can create API keys by navigating to the "API Keys" section in the settings page.

<img />

## API Endpoints

Check out the available API endpoints, or you can view the OpenAPI specification file.

<Note>
  The base URL for all endpoints is [https://console.lomaplatform.com](https://console.lomaplatform.com)
</Note>

<CardGroup>
  <Card title="API Endpoints" icon="server" href="/vendor-api/orders/list-orders">
    Check out the API endpoints.
  </Card>

  <Card title="OpenAPI Specification" icon="leaf" href="https://console.lomaplatform.com/api/vendor/v1/openapi">
    View the OpenAPI specification file.
  </Card>
</CardGroup>