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

Get a basket item property

GET /v1/basket-item-properties/:id

Retrieves a basket item property by ID to check its value before updating or deleting it.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionProperty ID. Source: GET /v1/basket-item-properties
Parameterselect (query) Typestring Requiredno DescriptionComma-separated fields. Only selected fields remain in data. Fields: GET /v1/basket-item-properties/fields

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/basket-item-properties/1007" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/basket-item-properties/1007" \
  -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/basket-item-properties/1007', {
  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/basket-item-properties/1007', {
  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 DescriptionBasket item property
Fielddata.id Typenumber DescriptionProperty ID. Source: GET /v1/basket-item-properties
Fielddata.basketId Typenumber DescriptionBasket item ID. Source: GET /v1/basket-items
Fielddata.name Typestring DescriptionProperty name
Fielddata.value Typestring | null DescriptionProperty value
Fielddata.code Typestring | null DescriptionProperty symbolic code
Fielddata.sort Typenumber DescriptionSort order of the property within the item
Fielddata.xmlId Typestring | null DescriptionExternal ID

Response example

JSON 
{
  "success": true,
  "data": {
    "basketId": 1001,
    "code": "PRODUCT.XML_ID",
    "id": 1007,
    "name": "Product XML_ID",
    "sort": 100,
    "value": "6967",
    "xmlId": "bx_69e72bbf34260"
  }
}

Error response example

404 — the property was not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "basket 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
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe request completed, but no property object was returned
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The reason is in error.message
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 could not be reached
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks 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. Retry after the interval in the Retry-After header

For the full list of common API errors, see Error codes.

See also