Skip to content

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

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Get a List of Promotions Active in the Location

Request

The method allows you to get a list of promotions 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

Promotion 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/company/{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
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}

Get loyalty transactions by visit

Request

List of transactions for loyalty promotions for this visit

Security
BearerPartnerUser
Path
visit_idnumberrequired

Visit ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/transactions/{visit_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int32)

Loyalty transaction ID

status_idinteger(int32)

Status ID

amountnumber(float)

Transaction amount

type_idinteger(int32)

Transaction type identifier

program_idinteger(int32)

Loyalty program ID

card_idinteger(int32)

Loyalty card ID

salon_group_idinteger(int32)

ID of the chain to which the loyalty belongs

item_idinteger(int32)

Identifier of the product/service to which the promotion applies

item_type_idinteger(int32)

Operation type identifier

item_record_idinteger(int32)

Identifier of the appointment to which the service/product belongs

goods_transaction_idinteger(int32)

Commodity transaction ID

is_discountboolean

Is a discount

is_loyalty_withdrawboolean

Is the application of loyalty canceled

typeobject

Loyalty type

programobject

Promotion Information

]
Response
application/json
[
  {
    "id": 22989715,
    "status_id": 1,
    "amount": 100,
    "type_id": 1,
    "program_id": 12705,
    "card_id": 0,
    "salon_group_id": 145071,
    "item_id": 5048371,
    "item_type_id": 7,
    "item_record_id": 0,
    "goods_transaction_id": 96082477,
    "is_discount": true,
    "is_loyalty_withdraw": false,
    "type": { … },
    "program": { … }
  },
  {
    "id": 22994127,
    "status_id": 1,
    "amount": 100,
    "type_id": 4,
    "program_id": 19044,
    "card_id": 9234863,
    "salon_group_id": 145071,
    "item_id": 0,
    "item_type_id": 0,
    "item_record_id": 0,
    "goods_transaction_id": 0,
    "is_discount": false,
    "is_loyalty_withdraw": false,
    "type": { … },
    "program": { … }
  }
]

Gift Card/Membership Code Generation

Request

  • Options
    • location_id (required, number, 1) - location ID
    • product_id (required, number, 1) - product ID (gift card/ membership)
Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

product_idnumberrequired

Product ID (membership/gift card)

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/generate_code/{location_id}/{product_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
dataobject(loyalty_generate_code200_data_option)required
data.​codestringrequired

Generated code

metaArray of objectsrequired
successbooleanrequired
LoyaltyGenerateCode200Optionobject(loyalty_generate_code200_option)
Response
application/json
{
  "success": true,
  "data": {
    "code": 1
  },
  "meta": []
}

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