Get

[POST] .../v1/brand/get

Returns information about brand. Use this method to retrieve brands for item cards, product filtering and reference selectors. The response returns paged Brand records with next_offset and total and supports filters, sort_orders, search, limit and offset for brand id, name and update-date selection. The caller must have brand select permission; missing body, denied access, invalid filters or sorting and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of returned records. The value is limited by server settings, for example query_limit.
offset Int32 Optional Offset from the beginning of the result set. If the value is less than 0, 0 is used.
search String Optional Search string for the name field. Search is applied when the string length exceeds the threshold defined by server settings.
sort_orders Array of BrandSortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
id int Brand IDs.
last_update int
name string

Sortable Fields

Field
id
last_update
name

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Acme"
    }
  ],
  "sort_orders": [
    {
      "column": "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 Brand Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 12,
      "name": "Acme",
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}