Skip to content

Get a List of Loyalty Programs Active in the Location

Request

The method allows you to get a list of loyalty programs that are active for the specified location.

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Query
includestring

The first_transaction_date value adds the date of the first stock transaction to the response.

typestring

Loyalty program type

Enum:"discount_static""discount_accumulative_visits""discount_accumulative_sold""discount_accumulative_paid""cashback_static_sold""cashback_static_paid""cashback_accumulative_paid""cashback_accumulative_sold""cashback_accumulative_paid_visits""cashback_accumulative_sold_visits"
Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer bearer_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/loyalty/programs/search?include=string&type=discount_static' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status.

Example:true
dataArray of objects

An array of data objects.

Example:
[
  {
    "id": 53591,
    "title": "100 USD discount on Altegio Implementation Consultation",
    "type": "discount_static",
    "loyalty_type_id": 1,
    "item_type_id": 4,
    "service_item_type": "custom_allowed",
    "good_item_type": "any_allowed",
    "value_unit_id": 2,
    "value_unit": "amount",
    "group_id": 502054,
    "usage_limit": 0,
    "visit_multiplicity": 1,
    "sold_items_multiplicity": 1,
    "current_package_progress": 0,
    "allowed_usages_amount": 0,
    "expiration_timeout": 0,
    "expiration_timeout_unit": "day",
    "expiration_notification_timeout": 0,
    "params_source_type": "loyalty_card",
    "on_changed_notification_template_id": 0,
    "on_expiration_notification_template_id": 0
  }
]
metaobject

Metadata (contains the number of objects found)

Example:
{
  "count": 1
}
Response
{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}