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

List order statuses

GET /v1/order-statuses

Returns a list of order and delivery statuses with filtering support.

Parameters

Parameter Type Default Description
limit number 50 Number of records (up to 5000)
select string — Field selection: ?select=id,type,sort,color
order object — Sorting: ?order[sort]=asc
filter object — Filtering by status fields.
Filtering syntax. Example: ?filter[type]=O

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/order-statuses?limit=3&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/order-statuses?limit=3&order[sort]=asc" \
  -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-statuses?limit=3&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Total statuses: ${meta.total}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-statuses?limit=3&order[sort]=asc', {
  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 statuses
data[].id string Status character code
data[].type string Status type: O — order, D — delivery
data[].sort number | null Sort order
data[].notify boolean Whether to send a notification to the customer
data[].color string | null HEX color code or null
data[].xmlId string | null External identifier or null
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    { "id": "D", "type": "O", "sort": 140, "notify": true, "color": "#FFBEBD", "xmlId": null },
    { "id": "DF", "type": "D", "sort": 400, "notify": true, "color": null, "xmlId": null },
    { "id": "DD", "type": "D", "sort": 500, "notify": true, "color": null, "xmlId": null }
  ],
  "meta": {
    "total": 9,
    "hasMore": true
  }
}

Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sale' scope"
  }
}

Errors

HTTP Code Description
400 UNKNOWN_FILTER_FIELD Filter by a field that is not in the status schema
403 SCOPE_DENIED The API key does not have the sale scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of general API errors — Errors.

Known specifics

Separation by type. By default the response includes statuses of both types — order and delivery. To get only order statuses, add filter[type]=O. For delivery — filter[type]=D.

See also