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

Get order status

GET /v1/order-statuses/:id

Returns a single order or delivery status by character code.

Parameters

Parameter Type Required Description
Parameterid (path) Typestring Requiredyes DescriptionStatus character code, for example N, IP, DT. List: GET /v1/order-statuses

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data } = await res.json()
console.log('Status:', data.id, '— type:', data.type)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-statuses/D', {
  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 DescriptionThe status with all fields
Fielddata.id Typestring DescriptionStatus character code
Fielddata.type Typestring DescriptionStatus type: O — order, D — delivery
Fielddata.sort Typenumber | null DescriptionSort order
Fielddata.notify Typeboolean DescriptionWhether to send a notification to the customer
Fielddata.color Typestring | null DescriptionHEX color code or null
Fielddata.xmlId Typestring | null DescriptionExternal identifier or null

Response example

JSON 
{
  "success": true,
  "data": {
    "id": "D",
    "type": "O",
    "sort": 140,
    "notify": true,
    "color": "#FFBEBD",
    "xmlId": null
  }
}

Error response example

404 — status not found:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionA status with this id was not found
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the sale scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of general API errors — Errors.

See also