- Get Visit Details
Get list of appointments
Create a New Appointment
Get an Appointment
Edit Appointment
Delete Appointment
Change Appointment attendance status
Get Appointment change history
Get Appointment payment link
Send Appointment payment link to the client
Repeat an Appointment
List Appointment repeat templates
Create Appointment repeat template
Get Appointment repeat template
Update Appointment repeat template
List Appointment statuses
Get a List of Partner Appointments
Get a visit
Edit Visit
Receipt PDF for the visit
Get Visit Details
Block "kkm_transaction_details_container"
Flag "last_operation_type"
| Meaning | Description |
|---|---|
| 0 | Print return receipt |
| 1 | Print sales receipt |
Types of all transactions with location account
| Meaning | Description |
|---|---|
| 0 | Sales operation – Active for documents of type Visit |
| 1 | Sale return operation – Active for documents of type Visit |
| 2 | Correction operation |
| 4 | Shift opening operation – Opens a new POS shift |
| 5 | Shift closing operation – Closes the current POS shift |
| 9 | Get POS status – Retrieves the current status of the POS device |
| 11 | Get POS team status – Retrieves the status of all POS devices connected to the team |
| 12 | Correction operation |
| 13 | Print X-report – Prints a non-fiscal summary report of the current shift |
| 6 | Cash deposit – Registers a cash-in transaction in the POS |
| 7 | Cash withdrawal – Registers a cash-out transaction in the POS |
Statuses of All POS Operations
| Meaning | Description |
|---|---|
| 0 | Connection error with POS – Unable to establish a connection with the POS device |
| 1 | Success – Operation completed successfully |
| 2 | Sent for printing – The request has been sent to the POS and is waiting for print completion |
| 3 | Runtime error – An error occurred while processing the operation on the POS device |
| 4 | Status check error – Failed to retrieve the current status of the POS |
| 5 | Waiting for POS readiness – Operation is pending until the POS device becomes ready |
Document Types
| Meaning | Description |
|---|---|
| 1 | Sale of products |
| 2 | Provision of services |
| 3 | Arrival of products |
| 4 | Products write-off |
| 5 | Transfer of products |
| 6 | Inventory |
| 7 | Visit |
| 8 | Consumables write-off |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/details/{location_id}/{record_id}/{visit_id}
- Productionhttps://api.alteg.io/api/v1/visit/details/{location_id}/{record_id}/{visit_id}
curl -i -X GET \
https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/details/12345/67890/11111 \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Object with data
Example:
{ "payment_transactions": [ { … } ], "loyalty_transactions": [ { … } ], "kkm_transaction_details_container": { "last_operation_type": 0, "transactions": [ … ] }, "items": [ { … } ] }
Response
{ "success": true, "data": { "payment_transactions": [ … ], "loyalty_transactions": [ … ], "kkm_transaction_details_container": { … }, "items": [ … ] }, "meta": [] }