Skip to content
/
Get certificate type

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

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

Create certificate type

Request

Creates a new certificate type at the chain level.

Certificate types define gift certificate templates that can be sold across multiple locations.

Item Type Restrictions:

  • 0 = All services and products
  • 1 = Any services (no products)
  • 2 = Any products (no services)
  • 3 = Specific services only (no products)
  • 4 = Specific services + any products

Expiration Types:

  • 0 = No expiration
  • 1 = Fixed date for all instances
  • 2 = Fixed period from sale date

Expiration Units:

  • 1 = day
  • 2 = week
  • 3 = month
  • 4 = year

Balance Edit Types:

  • 1 = Can be edited
  • 2 = Cannot be edited

Note: After creation, certificate products are automatically created in inventory.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
titlestringrequired

Certificate type name

Example: "Gift Certificate 1000"
balancenumberrequired

Certificate face value

Example: 1000
is_multibooleanrequired

true = multiple use, false = single use

Example: true
item_type_idintegerrequired

Usage restrictions (0-4)

Enum01234
Example: 0
is_allow_empty_codebooleanrequired

Allow selling without code?

Example: false
balance_edit_type_idintegerrequired

Balance editability (1 = editable, 2 = not editable)

Enum12
Example: 1
service_idsArray of integersrequired

Specific service IDs (empty if no restriction)

Example: []
salon_idsArray of integersrequired

Location IDs where certificate is valid

Example: [720441]
expirationobjectrequired

Expiration settings

expiration.​type_idintegerrequired

Expiration type: 0 = none, 1 = fixed date, 2 = period from sale

Enum012
Example: 2
expiration.​datestring(date-time)

Fixed expiration date (ISO 8601, required if type_id = 1)

Example: "2026-12-31T23:59:59+00:00"
expiration.​timeoutinteger

Duration value (required if type_id = 2)

Example: 6
expiration.​timeout_unit_idinteger

Duration unit (required if type_id = 2): 1 = day, 2 = week, 3 = month, 4 = year

Enum1234
Example: 3
online_saleobjectrequired

Online sale settings

online_sale.​is_enabledbooleanrequired

Enable online purchase?

Example: false
online_sale.​titlestring

Title for online store

Example: "Gift Certificate"
online_sale.​descriptionstring

Description for online store

Example: "Perfect gift for any occasion"
online_sale.​pricenumber

Online sale price

Example: 1000
category_idinteger or null

Service category restriction (null = no restriction)

Example: null
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/certificate_types \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Gift Certificate 1000",
    "balance": 1000,
    "is_multi": true,
    "item_type_id": 0,
    "is_allow_empty_code": false,
    "category_id": null,
    "balance_edit_type_id": 1,
    "service_ids": [],
    "salon_ids": [
      720441
    ],
    "expiration": {
      "type_id": 2,
      "date": "2026-12-31T23:59:59+00:00",
      "timeout": 6,
      "timeout_unit_id": 3
    },
    "online_sale": {
      "is_enabled": false,
      "title": "Gift Certificate",
      "description": "Perfect gift for any occasion",
      "price": 1000
    }
  }'

Responses

Certificate type created successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 289056,
    "title": "Gift Certificate 1000",
    "balance": 1000,
    "is_multi": true,
    "company_group_id": 706028,
    "category_id": null,
    "weight": 1,
    "item_type_id": 0,
    "expiration_type_id": 2,
    "expiration_date": null,
    "expiration_timeout": 6,
    "expiration_timeout_unit_id": 3,
    "balance_edit_type_id": 1,
    "is_allow_empty_code": false,
    "is_serial_number_limited": false,
    "is_archived": false,
    "date_archived": null,
    "online_sale_is_enabled": false,
    "online_sale_title": "Gift Certificate 1000",
    "online_sale_description": "",
    "online_sale_price": 0,
    "online_sale_image": null,
    "released_total": 0,
    "item_type": { … },
    "service_ids": [],
    "salon_ids": [ … ]
  },
  "meta": []
}

Get certificate type

Request

Retrieves a specific certificate type by ID at the chain level.

Returns complete certificate type configuration including expiration rules, restrictions, and online sale settings.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
type_idintegerrequired

Certificate type ID

Example: 289056
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/certificate_types/289056 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Certificate type details

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 289056,
    "title": "Gift Certificate 1000",
    "balance": 1000,
    "is_multi": true,
    "company_group_id": 706028,
    "category_id": null,
    "weight": 1,
    "item_type_id": 0,
    "expiration_type_id": 2,
    "expiration_date": null,
    "expiration_timeout": 6,
    "expiration_timeout_unit_id": 3,
    "balance_edit_type_id": 1,
    "is_allow_empty_code": false,
    "is_serial_number_limited": false,
    "is_archived": false,
    "date_archived": null,
    "online_sale_is_enabled": false,
    "online_sale_title": "Gift Certificate 1000",
    "online_sale_description": "",
    "online_sale_price": 0,
    "online_sale_image": null,
    "released_total": 0,
    "item_type": { … },
    "service_ids": [],
    "salon_ids": [ … ]
  },
  "meta": []
}

Update certificate type

Request

Updates an existing certificate type at the chain level.

All fields from creation are required. Use GET first to retrieve current values, then modify needed fields and send complete object.

Note: Cannot update certificate types that have already been issued.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
type_idintegerrequired

Certificate type ID

Example: 289056
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
titlestringrequired

Certificate type name

Example: "Gift Certificate 1500"
balancenumberrequired

Certificate face value

Example: 1500
is_multibooleanrequired

true = multiple use, false = single use

Example: true
item_type_idintegerrequired

Usage restrictions (0-4)

Enum01234
Example: 0
is_allow_empty_codebooleanrequired

Allow selling without code?

Example: false
balance_edit_type_idintegerrequired

Balance editability (1 = editable, 2 = not editable)

Enum12
Example: 1
service_idsArray of integersrequired

Specific service IDs (empty if no restriction)

Example: []
salon_idsArray of integersrequired

Location IDs where certificate is valid

Example: [720441]
expirationobjectrequired

Expiration settings

expiration.​type_idintegerrequired

Expiration type: 0 = none, 1 = fixed date, 2 = period from sale

Enum012
Example: 2
expiration.​datestring(date-time)

Fixed expiration date (ISO 8601, required if type_id = 1)

Example: "2026-12-31T23:59:59+00:00"
expiration.​timeoutinteger

Duration value (required if type_id = 2)

Example: 6
expiration.​timeout_unit_idinteger

Duration unit (required if type_id = 2): 1 = day, 2 = week, 3 = month, 4 = year

Enum1234
Example: 3
online_saleobjectrequired

Online sale settings

online_sale.​is_enabledbooleanrequired

Enable online purchase?

Example: false
online_sale.​titlestring

Title for online store

Example: "Gift Certificate"
online_sale.​descriptionstring

Description for online store

Example: "Perfect gift for any occasion"
online_sale.​pricenumber

Online sale price

Example: 1500
category_idinteger or null

Service category restriction (null = no restriction)

Example: null
curl -i -X PUT \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/certificate_types/289056 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Gift Certificate 1500",
    "balance": 1500,
    "is_multi": true,
    "item_type_id": 0,
    "is_allow_empty_code": false,
    "category_id": null,
    "balance_edit_type_id": 1,
    "service_ids": [],
    "salon_ids": [
      720441
    ],
    "expiration": {
      "type_id": 2,
      "date": "2026-12-31T23:59:59+00:00",
      "timeout": 6,
      "timeout_unit_id": 3
    },
    "online_sale": {
      "is_enabled": false,
      "title": "Gift Certificate",
      "description": "Perfect gift for any occasion",
      "price": 1500
    }
  }'

Responses

Certificate type updated successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 289056,
    "title": "Gift Certificate 1500",
    "balance": 1500,
    "is_multi": true,
    "company_group_id": 706028,
    "category_id": null,
    "weight": 1,
    "item_type_id": 0,
    "expiration_type_id": 2,
    "expiration_date": null,
    "expiration_timeout": 6,
    "expiration_timeout_unit_id": 3,
    "balance_edit_type_id": 1,
    "is_allow_empty_code": false,
    "is_serial_number_limited": false,
    "is_archived": false,
    "date_archived": null,
    "online_sale_is_enabled": false,
    "online_sale_title": "Gift Certificate 1500",
    "online_sale_description": "",
    "online_sale_price": 0,
    "online_sale_image": null,
    "released_total": 0,
    "item_type": { … },
    "service_ids": [],
    "salon_ids": [ … ]
  },
  "meta": []
}

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations