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

Delete an order property

DELETE /v1/order-properties/:id

Deletes the order field definition with the specified ID from the online store's list of order properties. A deleted definition cannot be restored through the API; create a new one if needed.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionOrder property ID. List: GET /v1/order-properties

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl -X DELETE "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', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Order property deleted')
}

JavaScript — OAuth application

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

if (res.status === 204) {
  console.log('Order 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 — the property has already been deleted:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionThe path id is not a non-negative integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo property exists with this id, or it has already been deleted. Message: property is not exists
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the operation. The reason is in message
HTTP422 CodeBITRIX_ERROR DescriptionThe key's user does not have permission in Bitrix24. The Bitrix24 code is in error.b24Code: 200040300020
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe portal credentials do not have the sale scope (insufficient_scope)
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is in read-only mode
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 DescriptionThe API key has no configured tokens

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

Known specifics

Values in existing orders are preserved, but their link to the property definition is removed. List options, values in buyer profiles, and the property definition's links to payment systems and delivery services are deleted.

To deactivate your property instead of deleting it, pass active: false to PATCH /v1/order-properties/:id.

See also