Terms Reference

To assist with the easy lookup of names and IDs via the endpoints.

API Naming	Description	Endpoint
baseUrl	The URL to your environment instance, e.g. https://demo-1.eu-west-1.openloyalty-stage.io/
storeCode	Unique code created for the tenant. Store is referred to as Tenant in the admin panel.	GET /api/store
customerId	Unique ID created for the member profile. Customer is referred to as Member in the admin panel. Most of the endpoints accept other member identifications, such as email/phone/loyalty card number in the API requests. Some endpoints still require the customerId to be provided in the payload.	GET /api/{storeCode}/member
segmentId	Unique ID created for the segment.	GET /api/{storeCode}/segment
rewardId	Unique ID created for the reward.	GET /api/{storeCode}/reward