For AI agents: markdown of this page — /docs-content-en/entities/order-properties/list.md documentation index — /llms.txt

List order properties

GET /v1/order-properties

Retrieves online store order property definitions with filtering, sorting, and pagination.

Parameters

Parameter Type Default Description
Parameterfilter (query) Typeobject Default— DescriptionFilter by fields from GET /v1/order-properties/fields.
Filtering syntax. Example: ?filter[id]=125
Parameterselect (query) Typestring | string[] | object Default— DescriptionComma-separated fields: ?select=id,name,type. Array: ?select[]=id&select[]=name. Object values are used: ?select[id]=id&select[name]=name. Only selected fields remain in data. Unknown names are reported in meta.warnings with the code UNKNOWN_SELECT_FIELD
Parametersort (query) Typestring | object | string[] Default— DescriptionSort: ?sort=id, ?sort=-sort,id, object ?sort[id]=desc, or array ?sort[]=id&sort[]=-name
Parameterorder (query) Typeobject Default— DescriptionSort using an object: ?order[id]=desc. If sort is also set, it takes precedence
Parameterlimit (query) Typenumber Default50 DescriptionNumber of records, from 1 to 5000. Values above 5000 are capped at 5000
Parameteroffset (query) Typenumber Default0 DescriptionNumber of records to skip
ParameterwithTotal (query) Typestring Default— DescriptionAccepts true or false, but does not change counting or the presence of meta.total for order properties

Pagination. When limit > 50, Vibecode automatically reads multiple pages of 50 records and combines them into one response. To fetch the next set, increase offset by the number of records received. Continue while meta.hasMore is true.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-properties?filter[id]=125&select=id,name,personTypeId,propsGroupId,type,active&limit=10&sort=id&offset=0&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of order property definitions. All fields: Order property fields
Fieldmeta.total Typenumber DescriptionTotal properties matching the filter. Omitted on an empty page when offset > 0
Fieldmeta.hasMore Typeboolean DescriptionWhether more records exist beyond the current page
Fieldmeta.warnings Typearray DescriptionParameter warnings with code, message, and field. Included only when warnings exist
Fieldmeta.pageErrorSample Typeobject DescriptionCode and message of an error that interrupted automatic pagination. data then contains the records read before the interruption

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 125,
      "name": "Comment for the courier",
      "personTypeId": 5,
      "propsGroupId": 9,
      "type": "STRING",
      "active": false
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Error response example

400 — filtering by an unknown field:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'unknownField' for entity 'order-properties'. Available: id, personTypeId, type, name, propsGroupId, code, sort, defaultValue, description, settings, xmlId, inputFieldLocation, active, required, multiple, userProps, util, isAddress, isAddressFrom, isAddressTo, isEmail, isFiltered, isLocation, isLocation4tax, isPayer, isPhone, isProfileName, isZip"
  }
}

Errors

HTTP Code Description
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionA filter field is not in the schema. Fields: GET /v1/order-properties/fields
HTTP400 CodeINVALID_FILTER_FIELD DescriptionA filter field name starts with the unsupported prefix @ or !@
HTTP400 CodeINVALID_FILTER_OPERATOR DescriptionAn unknown operator, an empty condition object, or a logical $or or $and condition
HTTP400 CodeINVALID_DUPLICATE_FILTER_FIELD DescriptionTwo conditions resolve to the same filter condition. Send one of them
HTTP400 CodeINVALID_SORT_FIELD DescriptionSorting contains the forbidden name __proto__, constructor, or prototype
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSorting by an unknown field
HTTP400 CodeINVALID_SORT_DIRECTION DescriptionThe sort direction specified in an object is not one of asc, desc, ASC, DESC
HTTP400 CodeINVALID_FILTER Descriptionfilter is not an object or a JSON string containing an object, or two filter forms are mixed
HTTP422 CodeBITRIX_ERROR DescriptionThe key's user does not have permission in Bitrix24. The Bitrix24 code is in error.b24Code: 200040300010
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe portal credentials do not have the sale scope (insufficient_scope)
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejects the request. The reason is in error.message
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the sale scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 access tokens are configured
HTTP429 CodeRATE_LIMITED DescriptionThe request rate limit was exceeded. The effective limit is in the x-ratelimit-limit header. Retry after the interval in the Retry-After header

Full list of common API errors: Error codes.

See also