Price

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

GET /price/get-all

Get all prices

Query parameters

Parameter	Type	Required	Description
status	string	No	One of: active, inactive
type	string	No	One of: sale, income
currency_id	string	No
search	string	No

Request body

No request body.

Response

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

POST /price/items/get-paging

Price items

Request body

Field	Type	Required	Description
page	number	Yes	Default: 1
limit	number	Yes	Default: 20
organization_id	string	No
price_id	string	No
product_id	string	No

{
  "page": 1,
  "limit": 20,
  "organization_id": "string",
  "price_id": "string",
  "product_id": "string"
}

Response

Same response shape as GET /price/get-all.

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

Get a price by its _id.

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

Field	Type	Description
_id	string	The ID of the price
code	string	The code of the price
short_name	string	The short name of the price
name	string	The name of the price
currency_id	string	The currency ID of the price
status	string	The status of the price. One of: active, inactive
type	string	The type of the price. One of: sale, income
updated_by	string	The ID of the user who updated the price
is_default	boolean	Whether the price is the default price
can_be_updated	boolean	Whether the price can be updated
is_main	boolean	Whether the price is the main price
has_access	boolean	Whether the price has access
employee_ids	string[]	The IDs of the employees who have access to the price

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "code": "string",
    "short_name": "string",
    "name": "string",
    "currency_id": "string",
    "status": "active",
    "type": "sale",
    "updated_by": "string",
    "is_default": false,
    "can_be_updated": false,
    "is_main": false,
    "has_access": false,
    "employee_ids": [
      "string"
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

---

This page is generated from the OpenAPI spec.