Member Registration Configuration

One of the main setup steps is choosing the registration method. See the sample example how this can be configured. Links to more detailed instructions can be found at the end of the article.

How this example works

OpenLoyalty supports multitenancy, allowing each tenant (store) to operate as a distinct database, complete with its own member list and campaigns. This guide outlines the initial step of the setup process: selecting the appropriate registration method for a member. A single unique identifier is required, which can be an email, phone number, or loyalty card number (that can serve as your own unique identifier).

---

Try yourself

• Input the previous saved token in the request header

• Retrieve a list of tenants (stores) Endpoint: GET /api/store

• Choose the required tenant and its code

• Retrieve member registration for the specified tenant Endpoint: GET /api/{storeCode}/settings

• Update identificationMethod Endpoint: PATCH /api/{storeCode}/settings

  
  {
      "settings": {
          "identificationMethod": "phone" // or "loyaltyCardNumber", "email"
      }
  }
  

Moving forward, the chosen method will be a required field for member registration.

Please ensure the proper configuration of the tenant. You can find out more in this article.

---

Endpoints used

Method will return complete list of stores.

This method returns a list of all created Stores in the system.

If sorting is not chosen, the rows will be returned in an unspecified order.
To sort a result, use an _orderBy parameter in query.

GEThttp://openloyalty.localhost/api/store

Query parameters

Response

200400401403

List of stores

Body

application/json

itemsarray of Store (object)

totalSearchableTotalResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/store', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403

{
  "items": [
    {
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "currency": "text",
      "name": "text",
      "active": false,
      "createdAt": "2024-11-21T08:44:04.211Z",
      "updatedAt": "2024-11-21T08:44:04.211Z",
      "createdBy": "text",
      "updatedBy": "text"
    }
  ],
  "total": {
    "estimated": false
  }
}

Method will return all system settings.

This method returns all system settings.

If sorting is not chosen, the rows will be returned in an unspecified order.
To sort a result, use an _orderBy parameter in query.

GEThttp://openloyalty.localhost/api/{storeCode}/settings

Path parameters

storeCode*string

Store code

Query parameters

Response

200403404

Body

application/json

settingsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "settings": []
}

Method allow to update system settings.

This method allows configuring system settings partially.

PATCHhttp://openloyalty.localhost/api/{storeCode}/settings

Path parameters

storeCode*string

Store code

Body

application/json

settingsobject

Response

200400403404

Returned when successful

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/settings', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400403404

{
  "code": 400,
  "message": "Validation failed",
  "errors": [
    {
      "message": "text",
      "parameters": [],
      "plural": null,
      "code": "text",
      "path": "text"
    }
  ]
}

---

More resources

For a detailed overview and description of the member registration configuration, please refer to these articles:

TenantsUser Guide

ConfigurationUser Guide

SettingsUser Guide