## List order properties

`GET /v1/order-properties`

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

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `filter` (query) | object | — | Filter by fields from [`GET /v1/order-properties/fields`](/docs/entities/order-properties/fields).<br>[Filtering syntax](/docs/filtering). Example: `?filter[id]=125` |
| `select` (query) | string \| string[] \| object | — | Comma-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` |
| `sort` (query) | string \| object \| string[] | — | Sort: `?sort=id`, `?sort=-sort,id`, object `?sort[id]=desc`, or array `?sort[]=id&sort[]=-name` |
| `order` (query) | object | — | Sort using an object: `?order[id]=desc`. If `sort` is also set, it takes precedence |
| `limit` (query) | number | `50` | Number of records, from 1 to 5000. Values above 5000 are capped at 5000 |
| `offset` (query) | number | `0` | Number of records to skip |
| `withTotal` (query) | string | — | Accepts `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

```bash
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

```bash
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 |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of order property definitions. All fields: [Order property fields](/docs/entities/order-properties/fields) |
| `meta.total` | number | Total properties matching the filter. Omitted on an empty page when `offset > 0` |
| `meta.hasMore` | boolean | Whether more records exist beyond the current page |
| `meta.warnings` | array | Parameter warnings with `code`, `message`, and `field`. Included only when warnings exist |
| `meta.pageErrorSample` | object | Code 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 |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | A filter field is not in the schema. Fields: [`GET /v1/order-properties/fields`](/docs/entities/order-properties/fields) |
| 400 | `INVALID_FILTER_FIELD` | A filter field name starts with the unsupported prefix `@` or `!@` |
| 400 | `INVALID_FILTER_OPERATOR` | An unknown operator, an empty condition object, or a logical `$or` or `$and` condition |
| 400 | `INVALID_DUPLICATE_FILTER_FIELD` | Two conditions resolve to the same filter condition. Send one of them |
| 400 | `INVALID_SORT_FIELD` | Sorting contains the forbidden name `__proto__`, `constructor`, or `prototype` |
| 400 | `UNKNOWN_SORT_FIELD` | Sorting by an unknown field |
| 400 | `INVALID_SORT_DIRECTION` | The sort direction specified in an object is not one of `asc`, `desc`, `ASC`, `DESC` |
| 400 | `INVALID_FILTER` | `filter` is not an object or a JSON string containing an object, or two filter forms are mixed |
| 422 | `BITRIX_ERROR` | The key's user does not have permission in Bitrix24. The Bitrix24 code is in `error.b24Code`: `200040300010` |
| 403 | `BITRIX_ACCESS_DENIED` | The portal credentials do not have the `sale` scope (`insufficient_scope`) |
| 422 | `BITRIX_ERROR` | Bitrix24 rejects the request. The reason is in `error.message` |
| 403 | `SCOPE_DENIED` | The API key does not have the `sale` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `TOKEN_MISSING` | No Bitrix24 access tokens are configured |
| 429 | `RATE_LIMITED` | The 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](/docs/errors).

## See also

- [Search order properties](/docs/entities/order-properties/search)
- [Get an order property](/docs/entities/order-properties/get)
- [Create an order property](/docs/entities/order-properties/create)
- [Order property fields](/docs/entities/order-properties/fields)
- [Order properties](/docs/entities/order-properties)
- [Filtering syntax](/docs/filtering)
- [Limits and optimization](/docs/optimization)