Supplier

INFO

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

GET /supplier/get-by-id/{id}

Get supplier using its _id

Yo‘l parametrlari

Parametr	Tur	Majburiy	Tavsif
id	string	Ha

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Maydon	Tur	Tavsif
name	string
number	number
type	string
parent_id	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "name": "string",
    "number": 0,
    "type": "string",
    "parent_id": "string"
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /supplier/get-paging

Get suppliers by paging

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
page	number	Ha	Standart: 1
limit	number	Ha	Standart: 20
search	string	Yo‘q
category_id	string	Yo‘q
updated_at	string (date-time)	Yo‘q

{
  "page": 1,
  "limit": 20,
  "search": "string",
  "category_id": "63f8b0c4e4b0d3a2f8e4b0c4",
  "updated_at": "2024-07-20T10:30:00Z"
}

Javob

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

Maydon	Tur	Tavsif
completely_deleted	boolean
is_deleted	boolean
created_at	string (date-time)
director_name	string
name	string
phone_number	string
refund_count	number
sale_count	number
total_sale	number
first_sale_at	string (date-time)
last_sale_at	string (date-time)
type	string
updatedAt	string (date-time)
updated_at	string (date-time)
total_balance	number
balance	number
balance_currency_id	string
address	string
inn	string
comment	string
avg_product	number
avg_sale	number
total_spent	number
category	object
category._id	string
category.name	string
note	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "completely_deleted": false,
        "is_deleted": false,
        "created_at": "2025-05-01T12:00:00Z",
        "director_name": "string",
        "name": "string",
        "phone_number": "string",
        "refund_count": 0,
        "sale_count": 0,
        "total_sale": 0,
        "first_sale_at": "2025-05-01T12:00:00Z",
        "last_sale_at": "2025-05-01T12:00:00Z",
        "type": "string",
        "updatedAt": "2025-05-01T12:00:00Z",
        "updated_at": "2025-05-01T12:00:00Z",
        "total_balance": 0,
        "balance": 0,
        "balance_currency_id": "string",
        "address": "string",
        "inn": "string",
        "comment": "string",
        "avg_product": 0,
        "avg_sale": 0,
        "total_spent": 0,
        "category": {
          "_id": "string",
          "name": "string"
        },
        "note": "string"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /supplier/update

Update a supplier.

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
_id	string	Ha
name	string	Yo‘q
type	string	Yo‘q	Mumkin qiymatlar: legal, natural
phone_number	string	Yo‘q
phone_numbers	string[]	Yo‘q
email	string	Yo‘q
inn	string	Yo‘q
address	string	Yo‘q
note	string	Yo‘q
category_id	string	Yo‘q
responsible_id	string	Yo‘q
organization_ids	string[]	Yo‘q

{
  "_id": "64b7f4d9e2b3b6a0b7c5d80a",
  "name": "string",
  "type": "legal",
  "phone_number": "string",
  "phone_numbers": [
    "string"
  ],
  "email": "string",
  "inn": "string",
  "address": "string",
  "note": "string",
  "category_id": "string",
  "responsible_id": "string",
  "organization_ids": [
    "string"
  ]
}

Javob

Javob tuzilishi quyidagi bilan bir xil: GET /supplier/get-by-id/{id}.

GET /supplier/get-by-phone/{phone_number}

Find a supplier by phone number.

Yo‘l parametrlari

Parametr	Tur	Majburiy	Tavsif
phone_number	string	Ha

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: GET /supplier/get-by-id/{id}.

POST /supplier/create

Create a supplier. name and organization_ids (at least one) are required. Conditional fields depend on type: legal persons use short_name / web_site / code / postal_code / owner_id / manager_id, natural persons use last_name / middle_name / birth_date / gender / legal_person_id. Returns the created supplier.

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
name	string	Ha	Supplier name (required). For a legal person this is the company name; for a natural person the display name.
type	string	Yo‘q	Person type. Drives which of the conditional field groups below apply. Defaults to the backend default when omitted.. Mumkin qiymatlar: legal, natural
organization_ids	string[]	Ha	Organizations the supplier is available in (required, at least one).
first_name	string	Yo‘q
last_name	string	Yo‘q	Natural persons only.
middle_name	string	Yo‘q	Natural persons only.
birth_date	string (date-time)	Yo‘q	Natural persons only.
gender	string	Yo‘q	Natural persons only.. Mumkin qiymatlar: male, female
short_name	string	Yo‘q	Legal persons only.
web_site	string	Yo‘q	Legal persons only.
code	string	Yo‘q	Legal persons only.
postal_code	string	Yo‘q	Legal persons only.
owner_id	string	Yo‘q	Legal persons only — owning person ObjectId.
manager_id	string	Yo‘q	Legal persons only — manager person ObjectId.
phone_number	string	Yo‘q	Primary phone number in international format.
phone_numbers	string[]	Yo‘q	Additional phone numbers. Must be unique.
fax	string	Yo‘q
email	string	Yo‘q
telegram_link	string	Yo‘q
inn	string	Yo‘q	Taxpayer INN. Validated for format.
qqs_number	string	Yo‘q	VAT registration number.
oked	string	Yo‘q
director_name	string	Yo‘q
bank_name	string	Yo‘q
mfo	string	Yo‘q
card_number	string	Yo‘q	Validated as a credit-card number.
address	string	Yo‘q
delivery_address	object	Yo‘q	Location object (lat/lng + address).
category_id	string	Yo‘q
person_id	string	Yo‘q	Link to an existing person record instead of creating a new one.
responsible_id	string	Yo‘q
legal_person_id	string	Yo‘q	Natural persons only — the legal person they represent.
status	string	Yo‘q	Mumkin qiymatlar: active, inactive
is_customer	boolean	Yo‘q	Also register this person as a customer.
locale	string	Yo‘q	Mumkin qiymatlar: uz, ru, en, kk, ky, tg
comment	string	Yo‘q
note	string	Yo‘q
image	string	Yo‘q
tag_ids	string[]	Yo‘q
attachments	object[]	Yo‘q	Attached files: { name, path, size, note }.

{
  "name": "string",
  "type": "legal",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "birth_date": "2025-05-01T12:00:00Z",
  "gender": "male",
  "short_name": "string",
  "web_site": "string",
  "code": "string",
  "postal_code": "string",
  "owner_id": "string",
  "manager_id": "string",
  "phone_number": "string",
  "phone_numbers": [
    "string"
  ],
  "fax": "string",
  "email": "string",
  "telegram_link": "string",
  "inn": "string",
  "qqs_number": "string",
  "oked": "string",
  "director_name": "string",
  "bank_name": "string",
  "mfo": "string",
  "card_number": "string",
  "address": "string",
  "delivery_address": {},
  "category_id": "string",
  "person_id": "string",
  "responsible_id": "string",
  "legal_person_id": "string",
  "status": "active",
  "is_customer": false,
  "locale": "uz",
  "comment": "string",
  "note": "string",
  "image": "string",
  "tag_ids": [
    "string"
  ],
  "attachments": [
    {}
  ]
}

Javob

Javob tuzilishi quyidagi bilan bir xil: GET /supplier/get-by-id/{id}.

---

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.