# Venues

## What is the Venues module?

The Venues module allows you to add entries representing physical locations to your loyalty tenant which can then be retrieved using the [WLL Rewards API](https://docs.whitelabel-loyalty.com/rewards.html#venues-venues-collection-get).

You can use venues to:

* Create a directory of locations participating in your loyalty program.
* Associate users with a particular venue (useful for recording a venue they signed up at).
* Associate [rewards with particular venues](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/rewards-and-points/rewards/reward-availability#venue_availability) (useful for showing rewards available at a particular location).
* Ensure voucher codes issued by the WLL voucher management system can only be validated at particular venues.
* Associate [transactions](https://docs.whitelabel-loyalty.com/receipts.html#orders-orders-collection-post) or receipts submitted using the [Receipts module](https://kbase.whitelabel-loyalty.com/product/modules/receipts-and-products) with a particular venue.

{% hint style="info" %}
Modules are sold separately and **not included** in the Loyalty Engine core platform licence. For pricing and details, contact your account manager.&#x20;
{% endhint %}

***

## Venues use cases <a href="#use_cases" id="use_cases"></a>

### B2C

If you have a B2C loyalty program, venues will typically represent your own retail outlets that your customers visit, or retail outlets of your partners where offers are available to them.

In this use case venues allow you to:

* List and display venue information to help your customers find your venues and get information about them in your customer interface  (either your own, or our Loyalty Microsite and Loyalty Mobile App)
* Associate [rewards](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/rewards-and-points) with specific venues to highlight venue-specific availability
* View how your loyalty program is performing by individual venue with reporting on a venue-by-venue basis

### B2B

If you are using the system in a B2B configuration, venues will typically represent the retail locations of your customers.

In this use case venues allow you to:

* Link a user to a specific venue
* Record data about your clients at both a user and location level

***

## Managing venues

### Creating a venue

When you create or edit a venue, you can specify the following information:

<table><thead><tr><th width="136.05859375" valign="top">Field</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Name*</strong></td><td valign="top">A name to represent the venue, visible to both administrators and end-users</td></tr><tr><td valign="top"><strong>Address*</strong></td><td valign="top">Enter the full postal address of the venue including street address, town, city, region/state, postcode and country.</td></tr><tr><td valign="top"><strong>Postcode*</strong></td><td valign="top">Enter the zipcode or postcode of the address.</td></tr><tr><td valign="top"><strong>Latitude &#x26; longitude*</strong></td><td valign="top">Enter the latitude &#x26; longitude of the address.<br><br><em>If adding a venue using the Loyalty Console, when 'Calculate coordinates from address' is turned on, the latitude and longitude</em> <em>fields will auto-fill and the map on the right of the display will show the coordinates of the venue after you enter an address.</em></td></tr><tr><td valign="top"><strong>Type*</strong></td><td valign="top"><p>This defines the relationship between the venue and your program. The following types are supported:</p><ul><li><p><strong>Tenant - A venue directly related to your organization (most common)</strong></p><p>Use this for physical locations you own or control, such as retail stores or participating branches in your loyalty program.</p></li><li><p><strong>User - A venue associated with a specific user</strong></p><p>Common in B2B programs where users represent businesses. For example, this could be the head office address of user in your program.</p></li><li><p><strong>Merchant - A venue tied to a merchant in receipt-based loyalty flows</strong></p><p>Used when scanning receipts issued by third-party stores (e.g. Target). The merchant venue represents the location printed on the receipt.</p></li></ul></td></tr><tr><td valign="top"><strong>External identifier*</strong></td><td valign="top">A reference that is used for the venue (i.e. a store number or CRM ID).</td></tr><tr><td valign="top"><strong>Description</strong></td><td valign="top">Optionally add some text describing the venue, visible to both administrators and end-users.</td></tr><tr><td valign="top"><strong>Venue category</strong></td><td valign="top">Optionally specify a category for the venue.</td></tr><tr><td valign="top"><strong>Availability</strong></td><td valign="top">By default the venue will be active in your loyalty program immediately after it has been created. Toggle this setting to off to schedule this venue to become available at a later date</td></tr><tr><td valign="top"><strong>Attributes</strong></td><td valign="top">Specify additional data about your venue. This data must be entered in JSON format.</td></tr></tbody></table>

<details>

<summary><i class="fa-mobile">:mobile:</i> Displaying a phone number and opening times for a venue in the Loyalty Mobile App</summary>

If you're using our Loyalty Mobile App, you can display the telephone number and opening times for a venue by adding the following attribute set to a venue:

{% code title="Venue telephone number & opening times JSON" overflow="wrap" %}

```json
{
"telephoneNumber": "+44 01437 532812",
"openingTimes": {
"monday": "Closed",
"tuesday": "5 – 9.30pm",
"wednesday": "12 – 2.30pm & 5 – 9.30pm",
"friday": "12 – 2.30pm & 5 – 10pm",
"saturday": "12 – 2.30pm & 5 – 10pm",
"sunday": "3 – 8pm"
}
```

{% endcode %}

</details>

### Deleting a venue

Just like rewards and reactors, after a venue is deleted it is technically archived and will be listed in the *inactive* tab on venues screen. This is so historic data (including events and rewards) relating to the venue are still available in analytics and when auditing your loyalty data.

{% hint style="warning" %}
Once a venue has been archived it is not possible to make it active again.
{% endhint %}

### Venue categories

Venue categories work in a very similar way to [reward categories](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/rewards-and-points/rewards/reward-details#reward-presentation), allowing you to group venues into categories for easier browsing by your end-users.

You can create venue categories from the *create venue* screen, and you can edit and delete categories from the venue list on the right side.
