Report distribution

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 /reports/distribution/get-summary

Aggregate distribution KPIs for the window (orders, deliveries, revenue).

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
date_from	string (date-time)	Yo‘q	Start of the reporting window.
date_to	string (date-time)	Yo‘q	End of the reporting window.
organization_ids	string[]	Yo‘q
warehouse_ids	string[]	Yo‘q
currency_id	string	Yo‘q
responsible_ids	string[]	Yo‘q
customer_ids	string[]	Yo‘q
supplier_ids	string[]	Yo‘q
product_ids	string[]	Yo‘q
category_ids	string[]	Yo‘q
payment_method_ids	string[]	Yo‘q
sort_by	string	Yo‘q	Field name to sort by.
sort_order	string	Yo‘q	Mumkin qiymatlar: asc, desc. Standart: "desc"

{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Javob

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

POST /reports/distribution/get-by-product-category

Distribution volume grouped by product category.

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
page	number	Ha	Standart: 1
limit	number	Ha	Standart: 20
date_from	string (date-time)	Yo‘q	Start of the reporting window.
date_to	string (date-time)	Yo‘q	End of the reporting window.
organization_ids	string[]	Yo‘q
warehouse_ids	string[]	Yo‘q
currency_id	string	Yo‘q
responsible_ids	string[]	Yo‘q
customer_ids	string[]	Yo‘q
supplier_ids	string[]	Yo‘q
product_ids	string[]	Yo‘q
category_ids	string[]	Yo‘q
payment_method_ids	string[]	Yo‘q
sort_by	string	Yo‘q	Field name to sort by.
sort_order	string	Yo‘q	Mumkin qiymatlar: asc, desc. Standart: "desc"
search	string	Yo‘q

{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Javob

Maydon	Tur	Tavsif
list	object[]
total	number

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

POST /reports/distribution/get-by-agent-and-type

Distribution metrics grouped by (agent, distribution type).

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
page	number	Ha	Standart: 1
limit	number	Ha	Standart: 20
date_from	string (date-time)	Yo‘q	Start of the reporting window.
date_to	string (date-time)	Yo‘q	End of the reporting window.
organization_ids	string[]	Yo‘q
warehouse_ids	string[]	Yo‘q
currency_id	string	Yo‘q
responsible_ids	string[]	Yo‘q
customer_ids	string[]	Yo‘q
supplier_ids	string[]	Yo‘q
product_ids	string[]	Yo‘q
category_ids	string[]	Yo‘q
payment_method_ids	string[]	Yo‘q
sort_by	string	Yo‘q	Field name to sort by.
sort_order	string	Yo‘q	Mumkin qiymatlar: asc, desc. Standart: "desc"
search	string	Yo‘q

{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /reports/distribution/get-by-product-category.

POST /reports/distribution/get-by-agent

Distribution metrics aggregated by agent (sales rep).

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
page	number	Ha	Standart: 1
limit	number	Ha	Standart: 20
date_from	string (date-time)	Yo‘q	Start of the reporting window.
date_to	string (date-time)	Yo‘q	End of the reporting window.
organization_ids	string[]	Yo‘q
warehouse_ids	string[]	Yo‘q
currency_id	string	Yo‘q
responsible_ids	string[]	Yo‘q
customer_ids	string[]	Yo‘q
supplier_ids	string[]	Yo‘q
product_ids	string[]	Yo‘q
category_ids	string[]	Yo‘q
payment_method_ids	string[]	Yo‘q
sort_by	string	Yo‘q	Field name to sort by.
sort_order	string	Yo‘q	Mumkin qiymatlar: asc, desc. Standart: "desc"
search	string	Yo‘q

{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /reports/distribution/get-by-product-category.

---

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.