User authentication and session management for B2B integrations
- Gift Card/Membership Code Generation
Get a List of Promotions Active in the Location
Get loyalty transactions by visit
Apply Deduction from the Loyalty Card in the Visit
Cancel Withdrawal from the Loyalty Card During the Visit
Apply a Discount Promotion in a Visit
Cancel the Application of the Discount Promotion in the Visit
Apply Referral Program During a Visit
Gift Card/Membership Code...
Business Management (1.0.0)
Full-featured B2B API for business operations.
Base URL: https://api.alteg.io/api
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/transactions/{visit_id}
- Productionhttps://api.alteg.io/api/v1/visit/loyalty/transactions/{visit_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'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": { … } } ]
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/generate_code/{location_id}/{product_id}
- Productionhttps://api.alteg.io/api/v1/loyalty/generate_code/{location_id}/{product_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Response
application/json
{ "success": true, "data": { "code": 1 }, "meta": [] }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}
- Productionhttps://api.alteg.io/api/v1/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: */*' \
-d '[object Object]'OK
Array with information about the financial transactions of the appointment
Example: []
An array with information about applied loyalty transactions in a visit
Example: [{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"}}]
An object that holds details about transactions recorded by the POS system
Example: {"last_operation_type":1,"transactions":[]}
Array with information about products and services of the appointment
Example: [{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]
Response
application/json
{ "payment_transactions": [], "loyalty_transactions": [ { … } ], "kkm_transaction_details_container": { "last_operation_type": 1, "transactions": [] }, "items": [ { … }, { … } ] }