- Get a List of Customer Cards by Phone Number
Get a List of Customer Cards by ID
Get a list of card types available at the location
Get a List of Card Types Available for Issuance to the Client
Get a List of Card Types Available at the Chain
Issue a Loyalty Card
Remove a Loyalty Card
Manual withdraw/deposit to loyalty card in location
Manual withdraw/deposit to loyalty card in chain
Apply Deduction from the Loyalty Card in the Visit
Cancel Withdrawal from the Loyalty Card During the Visit
Get a List of Customer Ca...
Returns a list of customer cards with programs that are active in this location
| Attribute | Type | Description |
|---|---|---|
| id | int | Loyalty card ID |
| balance | decimal | Loyalty card balance |
| paid_amount | decimal | Amount "Paid" |
| sold_amount | decimal | Amount "Sold" |
| visits_count | int | Number of visits |
| number | string | Card number |
| type_id | int | Loyalty card type identifier |
| salon_group_id | int | ID of the chain where the card was created |
| type | object | Object that contains the "id" and "title" fields: card type identifier and name |
| salon_group | object | Object that contains the "id" and "title" fields: identifier of the chain where the card type was created and the name of this chain |
| programs | array | Array with information about loyalty programs linked to a loyalty card |
| rules | array | Array with information about the rules configured in the action |
The programs array consists of objects with the following fields:
| Attribute | Type | Description |
|---|---|---|
| id | int | Loyalty Program ID |
| title | string | Action name |
| loyalty_type_id | int | Loyalty program type ID |
| item_type_id | int | Is cashback accrued from products |
| value_unit_id | int | Bonus field — Discount % or Fixed amount |
| group_id | int | ID of the chain where the action was created |
| loyalty_type | object | Object with information about the action |
The rules array consists of objects with the following fields:
| Attribute | Type | Description |
|---|---|---|
| id | int | Rule ID |
| loyalty_program_id | int | Identifier of the loyalty program to which the rule is attached |
| loyalty_type_id | int | Loyalty program type ID |
| value | decimal | Value from which the rule will work |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{phone}/{chain_id}/{location_id}
- Productionhttps://api.alteg.io/api/v1/loyalty/cards/{phone}/{chain_id}/{location_id}
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{phone}/{chain_id}/{location_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
An object that contains the "id" and "title" fields: card type identifier and card type name, respectively
Example:
{ "id": 10992, "title": "5+2", "salon_group_id": 145071 }
An object that contains the "id" and "title" fields: the identifier of the chain where the card type was created and the name of this chain
Example:
{ "id": 145071, "title": "Dough chain1." }
Response
{ "id": 9210520, "balance": 100, "points": 0, "paid_amount": 1000, "sold_amount": 1000, "visits_count": 1, "number": 14507109210520, "type_id": 10992, "salon_group_id": 145071, "type": { "id": 10992, "title": "5+2", "salon_group_id": 145071 }, "salon_group": { "id": 145071, "title": "Dough chain1." }, "programs": [ { … } ] }