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

Get an order property

GET /v1/order-properties/:id

Retrieves an order property definition by its ID.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionOrder property ID. List: GET /v1/order-properties
Parameterselect (query) Typestring Requiredno DescriptionComma-separated fields, for example ?select=id,name,type. Fields: GET /v1/order-properties/fields. Only selected fields remain in data

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/order-properties/125" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/order-properties/125" \
  -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/125', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-properties/125', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionOrder property definition. All fields: Order property fields
Fieldmeta.warnings Typearray DescriptionWarnings about unknown field names in select, with code, message, and field. Included only when warnings exist

Response example

Main fields are shown. Full field list: Order property fields.

JSON 
{
  "success": true,
  "data": {
    "id": 125,
    "personTypeId": 5,
    "type": "STRING",
    "name": "Comment for the courier",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "defaultValue": "Call before delivery",
    "settings": {
      "maxlength": 200,
      "multiline": "N",
      "size": 40
    },
    "active": false,
    "required": false
  }
}

Error response example

404 — the order property was not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "property is not exists"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo property exists with this id. Error message: property is not exists
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe request completed, but no object was returned. Error message: orderProperty <id> not found
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

Full list of common API errors: Error codes.

See also