Skip to content

Customer category ​

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /customer-category/create ​

This method allows adding customer-category into the account.

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHa
parent_idstringYo‘q
organization_idsstring[]Yo‘q
imagestringYo‘q
json
{
  "name": "string",
  "parent_id": "string",
  "organization_ids": [
    "string"
  ],
  "image": "string"
}

Javob

MaydonTurTavsif
_idstringid of customer-category
namestring
child_countnumber
item_countnumber
imagestring
organization_idsstring[]
parentobject
parent._idstring
parent.namestring
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "child_count": 0,
    "item_count": 0,
    "image": "string",
    "organization_ids": [
      "string"
    ],
    "parent": {
      "_id": "string",
      "name": "string"
    }
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /customer-category/update ​

This method allows updating customer-category in the account.

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHa
parent_idstringYo‘q
organization_idsstring[]Yo‘q
imagestringYo‘q
_idstringHaid of customer-category
json
{
  "name": "string",
  "parent_id": "string",
  "organization_ids": [
    "string"
  ],
  "image": "string",
  "_id": "string"
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /customer-category/create.

DELETE /customer-category/delete/{id} ​

Delete a customer-category

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /customer-category/get-by-id/{id} ​

Get customer-category using its _id

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /customer-category/create.

POST /customer-category/get-paging ​

Get customer-categories by paging

So‘rov tanasi

MaydonTurMajburiyTavsif
pagenumberHaStandart: 1
limitnumberHaStandart: 20
updated_atstringYo‘q
organization_idstringYo‘q
organization_idsstring[]Yo‘q
json
{
  "page": 1,
  "limit": 20,
  "updated_at": "string",
  "organization_id": "string",
  "organization_ids": [
    "string"
  ]
}

Javob

data.total — jami yozuvlar soni, data.data[] — joriy sahifadagi yozuvlar. Quyidagi jadval bitta yozuvni tavsiflaydi.

MaydonTurTavsif
_idstringid of customer-category
namestring
child_countnumber
item_countnumber
imagestring
organization_idsstring[]
parentobject
parent._idstring
parent.namestring
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "string",
        "name": "string",
        "child_count": 0,
        "item_count": 0,
        "image": "string",
        "organization_ids": [
          "string"
        ],
        "parent": {
          "_id": "string",
          "name": "string"
        }
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

GET /customer-category/get-deleted ​

Get deleted customer-category ids

So‘rov parametrlari

ParametrTurMajburiyTavsif
deleted_atstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API