Skip to content
/
Remove a Loyalty Card

Business Management (1.0.0)

Full-featured B2B API for business operations.

Base URL: https://api.alteg.io/api

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Online Booking Settings

Configure online booking behavior and forms

Operations

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Issue a Loyalty Card

Request

| Attribute | Type | Description | |----------------------|--------|----------------- ------------------------------| | loyalty_card_number | number | Loyalty card number | | loyalty_card_type_id | number | Loyalty card type identifier | | phone | number | Customer phone number (e.g., 13155550175 for +13155550175) |

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
loyalty_card_numberstring

Loyalty card number

Example: "9090909"
loyalty_card_type_idstring

Loyalty card type identifier

Example: "8230"
phonenumber

Customer phone number (e.g., 13155550175 for +13155550175)

Example: 13155550175
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{location_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "loyalty_card_number": "9090909",
    "loyalty_card_type_id": "8230",
    "phone": 13155550175
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)

Loyalty card ID

Example: 9210520
balancenumber(float)

Loyalty card balance

Example: 100
pointsinteger(int32)
paid_amountnumber(float)

Amount Paid

Example: 1000
sold_amountnumber(float)

Amount "Sold"

Example: 1000
visits_countinteger(int32)

Number of visits

Example: 1
numberstring

Card number

Example: 14507109210520
type_idinteger(int32)

Loyalty card type identifier

Example: 10992
salon_group_idinteger(int32)

ID of the chain where the card was created

Example: 145071
typeobject

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}
salon_groupobject

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."}
programsArray of objects

An array with information about promotions linked to a loyalty card

Example: [{"id":18005,"title":"5+2","value":0,"loyalty_type_id":13,"item_type_id":3,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":13,"title":"Discount for a given number of accumulated services","is_discount":true,"is_cashback":false,"is_static":false,"is_accumulative":false},"rules":[{"id":72803,"loyalty_program_id":18005,"loyalty_type_id":13,"value":20,"parameter":0},{"id":72804,"loyalty_program_id":18005,"loyalty_type_id":13,"value":10,"parameter":0},{"id":72805,"loyalty_program_id":18005,"loyalty_type_id":13,"value":100,"parameter":0}]}]
Response
application/json
{
  "id": 9250498,
  "balance": 0,
  "points": 0,
  "paid_amount": 16300,
  "sold_amount": 19320,
  "visits_count": 5,
  "number": 1010101,
  "type_id": 8230,
  "salon_group_id": 145071,
  "type": {
    "id": 8230,
    "title": "cashmesh",
    "salon_group_id": 145071
  },
  "salon_group": {
    "id": 145071,
    "title": "Dough chain1."
  },
  "programs": [
    { … }
  ]
}

Remove a Loyalty Card

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

card_idnumberrequired

loyalty card ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
curl -i -X DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/cards/{location_id}/{card_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

No Content

Response
No content

Manual withdraw/deposit to loyalty card in location

Request

Manual withdraw/deposit to loyalty card in location

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
card_idnumberrequired

Loyalty card ID

Headers
Acceptstringrequired

Should be equal to application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

Should be equal to application/json

Example: application/json
Bodyapplication/json
amountnumberrequired

Withdraw/deposit amount. Positive for deposit, negative for withdraw.

Example: 100.5
titlestring

Optional comment

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/loyalty/cards/{card_id}/manual_transaction' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100.5,
    "title": "string"
  }'

Responses

OK

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(loyalty_card)

Loyalty card

metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "balance": 0,
    "points": 0,
    "paid_amount": 0,
    "sold_amount": 0,
    "visits_count": 0,
    "number": "string",
    "type_id": 0,
    "salon_group_id": 0,
    "max_discount_percent": 0,
    "max_discount_amount": 0
  },
  "meta": {}
}

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations