Skip to content

Mahsulotlar ​

Sotuvchining katalogi.

List the merchant's products​

GET
/products

Scoped to the organization that issued your key — there is no parameter that widens it.

Authorizations​

apiKey

The key the merchant issued you, sent verbatim including its bik_ prefix. Bione stores only a hash, so a lost key cannot be recovered — it has to be reissued.

Type
API Key (header: api-key)

Parameters​

Query Parameters

page
Type
integer
Minimum
1
Default
1
pageSize
Type
integer
Minimum
1
Default
20
q

Free-text search.

Type
string
isActive

Sent as the string 'true' or 'false', not a boolean.

Type
string
Valid values
"true""false"
categoryId
Type
string
Format
"uuid"

Responses​

A page of products.

application/json
JSON
{
  
"code": 0,
  
"message": "string",
  
"data": {
  
  
"items": [
  
  
  
{
  
  
  
  
"lockedFields": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"id": "string",
  
  
  
  
"organizationId": "string",
  
  
  
  
"sku": "string",
  
  
  
  
"name": "string",
  
  
  
  
"description": "string",
  
  
  
  
"price": "string",
  
  
  
  
"currency": "string",
  
  
  
  
"isActive": true,
  
  
  
  
"images": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"barcode": "string",
  
  
  
  
"measureUnit": "string",
  
  
  
  
"category": {
  
  
  
  
  
"id": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"slug": "string"
  
  
  
  
},
  
  
  
  
"branches": [
  
  
  
  
  
{
  
  
  
  
  
  
"branchId": "string",
  
  
  
  
  
  
"branchName": "string",
  
  
  
  
  
  
"isSold": true,
  
  
  
  
  
  
"price": "string",
  
  
  
  
  
  
"stockQty": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"createdAt": "string",
  
  
  
  
"updatedAt": "string"
  
  
  
}
  
  
],
  
  
"total": 0,
  
  
"page": 0,
  
  
"pageSize": 0,
  
  
"totalPages": 0
  
},
  
"messages": {
  
  
"uz": "string",
  
  
"ru": "string",
  
  
"en": "string"
  
},
  
"status_code": 200,
  
"time": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Create a product​

POST
/products

Answers 200, not 201. Send an Idempotency-Key header so a retry replays rather than creating a second product.

Authorizations​

apiKey

The key the merchant issued you, sent verbatim including its bik_ prefix. Bione stores only a hash, so a lost key cannot be recovered — it has to be reissued.

Type
API Key (header: api-key)

Request Body​

application/json
JSON
{
  
"name": "string",
  
"sku": "string",
  
"price": "string",
  
"description": "string",
  
"categoryId": "string",
  
"currency": "UZS",
  
"images": [
  
  
"string"
  
],
  
"barcode": "string",
  
"isActive": true
}

Responses​

The created product.

application/json
JSON
{
  
"code": 0,
  
"message": "string",
  
"data": {
  
  
"lockedFields": [
  
  
  
"string"
  
  
],
  
  
"id": "string",
  
  
"organizationId": "string",
  
  
"sku": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"price": "string",
  
  
"currency": "string",
  
  
"isActive": true,
  
  
"images": [
  
  
  
"string"
  
  
],
  
  
"barcode": "string",
  
  
"measureUnit": "string",
  
  
"category": {
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"slug": "string"
  
  
},
  
  
"branches": [
  
  
  
{
  
  
  
  
"branchId": "string",
  
  
  
  
"branchName": "string",
  
  
  
  
"isSold": true,
  
  
  
  
"price": "string",
  
  
  
  
"stockQty": "string"
  
  
  
}
  
  
],
  
  
"createdAt": "string",
  
  
"updatedAt": "string"
  
},
  
"messages": {
  
  
"uz": "string",
  
  
"ru": "string",
  
  
"en": "string"
  
},
  
"status_code": 200,
  
"time": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI

Get one product​

GET
/products/{id}

Authorizations​

apiKey

The key the merchant issued you, sent verbatim including its bik_ prefix. Bione stores only a hash, so a lost key cannot be recovered — it has to be reissued.

Type
API Key (header: api-key)

Responses​

The product.

application/json
JSON
{
  
"code": 0,
  
"message": "string",
  
"data": {
  
  
"lockedFields": [
  
  
  
"string"
  
  
],
  
  
"id": "string",
  
  
"organizationId": "string",
  
  
"sku": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"price": "string",
  
  
"currency": "string",
  
  
"isActive": true,
  
  
"images": [
  
  
  
"string"
  
  
],
  
  
"barcode": "string",
  
  
"measureUnit": "string",
  
  
"category": {
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"slug": "string"
  
  
},
  
  
"branches": [
  
  
  
{
  
  
  
  
"branchId": "string",
  
  
  
  
"branchName": "string",
  
  
  
  
"isSold": true,
  
  
  
  
"price": "string",
  
  
  
  
"stockQty": "string"
  
  
  
}
  
  
],
  
  
"createdAt": "string",
  
  
"updatedAt": "string"
  
},
  
"messages": {
  
  
"uz": "string",
  
  
"ru": "string",
  
  
"en": "string"
  
},
  
"status_code": 200,
  
"time": "string"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

Update a product​

PATCH
/products/{id}

Only the fields you send change. A field named in the product's lockedFields is refused before anything is stored — read that property to see which fields this merchant's connected system owns.

Authorizations​

apiKey

The key the merchant issued you, sent verbatim including its bik_ prefix. Bione stores only a hash, so a lost key cannot be recovered — it has to be reissued.

Type
API Key (header: api-key)

Request Body​

application/json
JSON
{
  
"name": "string",
  
"sku": "string",
  
"price": "string",
  
"description": "string",
  
"categoryId": "string",
  
"currency": "UZS",
  
"images": [
  
  
"string"
  
],
  
"barcode": "string",
  
"isActive": true
}

Responses​

The updated product.

application/json
JSON
{
  
"code": 0,
  
"message": "string",
  
"data": {
  
  
"lockedFields": [
  
  
  
"string"
  
  
],
  
  
"id": "string",
  
  
"organizationId": "string",
  
  
"sku": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"price": "string",
  
  
"currency": "string",
  
  
"isActive": true,
  
  
"images": [
  
  
  
"string"
  
  
],
  
  
"barcode": "string",
  
  
"measureUnit": "string",
  
  
"category": {
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"slug": "string"
  
  
},
  
  
"branches": [
  
  
  
{
  
  
  
  
"branchId": "string",
  
  
  
  
"branchName": "string",
  
  
  
  
"isSold": true,
  
  
  
  
"price": "string",
  
  
  
  
"stockQty": "string"
  
  
  
}
  
  
],
  
  
"createdAt": "string",
  
  
"updatedAt": "string"
  
},
  
"messages": {
  
  
"uz": "string",
  
  
"ru": "string",
  
  
"en": "string"
  
},
  
"status_code": 200,
  
"time": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI

Delete a product​

DELETE
/products/{id}

A soft delete — the product stops being listed and its history is kept. Answers with the string "OK" in data, like every route that returns nothing.

Authorizations​

apiKey

The key the merchant issued you, sent verbatim including its bik_ prefix. Bione stores only a hash, so a lost key cannot be recovered — it has to be reissued.

Type
API Key (header: api-key)

Responses​

Deleted.

application/json
JSON
{
  
"code": 0,
  
"message": "string",
  
"data": "OK",
  
"messages": {
  
  
"uz": "string",
  
  
"ru": "string",
  
  
"en": "string"
  
},
  
"status_code": 200,
  
"time": "string"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI