User authentication and session management for B2B integrations
- Search for product transactions
Get location inventories
Create an inventory operation
Create document
Get document
Update Document
Delete document
Create Transaction
Get a transaction
Transaction update
Deleting a transaction
Get Product Transactions of a Document
Retrieve a list of bill of materials and consumables
Get the Bill of Materials for a Team Member’s Service
Retrieve a list of bill of materials and consumables
Update Consumables for the Appointment-Service Association
Unlink Appointment-Service Association
Search for product transa...
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
Request
The location inventory object has the following fields:
| Field | Type | Description |
|---|---|---|
| id | number | Inventory ID |
| title | string | Title |
| for_services | number | 1 - if used for automatic write-off of consumables |
| for_sale | number | 1 - if the default inventory for selling products |
| comment | string | Description of the inventory |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/storages/{location_id}
- Productionhttps://api.alteg.io/api/v1/storages/{location_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/storages/{location_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects with data
Example: [{"id":1,"title":"Consumables","for_service":1,"for_sale":0,"comment":"To account for consumables"},{"id":2,"title":"Products","for_service":0,"for_sale":1,"comment":"To record store sales"},{"id":23061,"title":"Ors","for_service":0,"for_sale":1,"comment":"Nz"}]
Response
application/json
{ "success": true, "data": [ { … }, { … }, { … } ], "meta": [] }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/storages/transactions/{location_id}
- Productionhttps://api.alteg.io/api/v1/storages/transactions/{location_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/storages/transactions/{location_id}?page=1&count=20&start_date=%27%27&end_date=%27%27&document_id=string&changed_after=string&changed_before=string' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects with data
Example: [{"id":123456789,"document_id":22256643,"type_id":987654321,"type":"Something","good":{"id":111222333,"title":"Something"},"storage":{"id":333222111,"title":"Storage 1"},"unit":{"id":333222111,"title":"milliliter"},"operation_unit_type":1,"create_date":"2026-12-21T19:08:00-0500","last_change_date":"2026-02-01T12:00:00-0500","cost_per_unit":1.07,"cost":0,"discount":10,"master":{"id":112233445,"title":"James Smith"},"supplier":{"id":11112222,"title":"Best Supplier Ever"},"record_id":1,"service":{"id":1234321,"title":"Service 4"},"clients":{"id":4321234,"name":"George Smith","phone":13155550176}}]
Response
application/json
{ "success": true, "data": [ { … } ], "meta": [] }
Request
An inventory operation is created by submitting a document along with multiple product transactions in a single API request. If a payment type is specified, the corresponding financial transactions will be generated automatically.
Security
BearerPartnerUser
An array of objects containing transaction parameters, similar to a request to create a product transaction
Document type (Sale 1, Usage / Material Consumption 2, Product Receipt / Incoming 3, Inventory Write-off / Product Disposal 4, Internal Transfer 5)
Example: 1
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/storage_operations/operation/{location_id}
- Productionhttps://api.alteg.io/api/v1/storage_operations/operation/{location_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/storage_operations/operation/{location_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: */*' \
-d '[object Object]'OK
Object with data
Example: {"document":{"id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":91271,"user_id":999290,"company_id":4564,"number":1254,"comment":"test document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":91271,"title":"Secret place"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"transactions":[{"id":3428012,"document_id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":91271,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":91271,"title":"Secret place"},"supplier":[],"client":[],"master":[],"unit":{"id":1,"title":"Thing"}}]}
Response
application/json
{ "success": true, "data": { "document": { … }, "transactions": [ … ] }, "meta": [] }