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

Delete a basket item property

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

Deletes an existing basket item property by its ID when its data is no longer needed. A deleted record cannot be restored through the API.

Parameters

Parameter Type Required Description
id (path) number yes Property ID. Source: GET /v1/basket-item-properties

Examples

curl — personal key

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

curl — OAuth application

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

if (res.status === 204) {
  console.log("Basket item property deleted")
}

JavaScript — OAuth application

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

if (res.status === 204) {
  console.log("Basket item property deleted")
}

Response

A successful deletion returns HTTP 204 No Content with an empty body. Check the status code to confirm success.

Response example

http 
HTTP/1.1 204 No Content

Error response example

404 — property not found:

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

Errors

HTTP Code Description
400 INVALID_PARAMS The path id is not a non-negative integer
404 ENTITY_NOT_FOUND No property exists with this id, or it has already been deleted
422 BITRIX_ERROR Bitrix24 rejected the operation. The reason is in message
403 WRITE_BLOCKED_READONLY_KEY The key is in read-only mode
403 SCOPE_DENIED The API key does not have the sale scope
401 MISSING_API_KEY The X-Api-Key header is missing
429 RATE_LIMITED The request limit was exceeded

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

See also