Quick Start

REGOS API is designed for integrating a website, application, or service with REGOS. It can automate work with items, orders, stock balances, purchases, retail operations, and related business data. This guide explains the main request flow, how access is organized, and which API areas are most useful when starting an integration.

Getting an endpoint and integration key

To start using the API, create an integration in REGOS.Online. The system generates an endpoint and a connected_integration_id. The endpoint is the base URL used for API calls, and connected_integration_id identifies your integration.

An endpoint has the following format:

https://integration.regos.uz/gateway/out/{integrationKey}/v1/{method}

For example, an account request can look like this:

https://integration.regos.uz/gateway/out/11v5929ba236415hb31346ede021bdi4/v1/Account/Get

Request principles

REGOS API methods are called with POST and exchange data as JSON. Request bodies contain the method parameters. Responses follow a common shape with ok and result, while business errors are returned as ErrorResult inside the standard response contract.

Each request must include the required headers and use Content-Type: application/json;charset=utf-8. See Making API Requests for the request and response contract.

Review the error list before implementation so your integration can handle validation, authorization, rate limit, and business-rule errors consistently.

Batch requests

Use batch requests when several API calls must be executed in sequence or when one step depends on the result of another. A batch request can contain up to 50 API calls in a single HTTP request and returns a structured array of step responses.

Request limits

REGOS API applies rate limits per application or integration. The limit is based on a replenishing request counter: integrations can send short bursts while staying within the accumulated capacity, and requests are rejected when that capacity is exhausted.

Main API structure

REGOS API is organized around business entities. The main catalog entity is Item. Documents use Doc* names, and document line operations use *Operation names.

The usual workflow is:

1. Create the document header, for example a purchase, sale, movement, or order.
2. Add operations with item IDs, quantities, prices, discounts, VAT, and other line-level data.
3. Lock, unlock, perform, or cancel the document depending on the workflow.

This keeps the document as the aggregate root and keeps line-level changes explicit.

Many selection methods support filters and sort_orders. The English method pages are generated from public Swagger and include method-specific Filterable Fields and Sortable Fields tables where the endpoint supports them.

Working with items

Items are the central catalog entity in REGOS. They are used in orders, reports, retail receipts, stock operations, returns, and integrations with external stores or applications.

Use Item/Get for the basic item list. Use Item/GetExt when the integration also needs prices, stock quantities, and image URLs. Use Item/GetQuantity when only current stock quantities are required.

For item images, prefer downloading images to your own server and serving them locally. This reduces CDN usage and lowers the risk of hitting resource limits.

Purchase documents

Purchase documents are represented by DocPurchase. They record goods received from suppliers. The workflow starts with the document header and then adds line operations with item, quantity, and price data.

Use DocPurchase/Get to retrieve purchase documents. To create a purchase, add the document first and then add its lines through purchase operation methods.

Retail orders

Retail customer orders are represented by DocOrderDelivery. They are commonly used when a website or application sends customer orders to REGOS.

Where the simplified workflow is available, create a complete order in a single call with DocOrderDelivery/AddFull, passing the customer, item list, quantities, and prices.

Webhooks

Webhooks are used to receive asynchronous notifications from REGOS. When a subscribed event occurs, REGOS sends a POST request to your service. This avoids polling and lets your integration react to changes such as order status updates.

To use webhooks, set the handler URL in the local integration and subscribe to the events your service needs.

Recommendation

Start with simple requests in Postman or a similar tool, using the endpoint generated for your integration. After the request shape is clear, move the same payloads into your application code and handle ok, result, and ErrorResult consistently.