Get

[POST] .../v1/setpriceoperation/get

Returns information about operations document setting prices. Use this method to retrieve item price rows of one price setting document before editing, copying, filling, posting or comparing the intended price changes. The response returns paged SetPriceOperation records with next_offset and total, supports filters over document_id, id, item_id and item.name, supports limit and offset and supports sort_orders with the documented enum column values. The request must provide exactly one document through the document_id filter; id and item_id filter selections are limited by the controller validation and the current request user must have price setting operation select permission. Missing body, missing document selection, more than one document id, denied access, invalid filters or sort_orders, database failures or item lookup failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Required Filters by fields available for this API method. Required filter fields: document_id.
limit Int32 Optional Maximum number of records to return. Server settings define the effective maximum.
offset Int32 Optional Offset from the beginning of the result set. Negative values are treated as 0.
search String Optional Search by Item.name, Item.articul, Item.code and Item.barcodes.
sort_orders Array of SetPriceOperationSortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Required Description
document_id int Required
id int Optional
item.name string Optional
item_id int Optional

Sortable Fields

Field
base_value
document_id
id
item.articul
item.code
item.id
item.name
last_update
new_value
performed

Request Example

{
  "filters": [
    {
      "Field": "document_id",
      "Operator": "Equal",
      "Value": "6101"
    },
    {
      "Field": "item_id",
      "Operator": "In",
      "Value": "1001"
    }
  ],
  "sort_orders": [
    {
      "column": "item.name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of SetPriceOperation Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 8101,
      "document_id": 6101,
      "item": {
        "id": 1001,
        "name": "Arabica Coffee 1 kg",
        "code": "COF-001"
      },
      "base_value": 42000,
      "new_value": 48000,
      "current_value": 45000,
      "performed": false,
      "last_update": 1767225600
    }
  ],
  "next_offset": 0,
  "total": 1
}