#Order statuses

Entity: orderStatus | Scope: sale | Base path: /v1/order-statuses

SPA entity (camelCase field names) — field names pass through without transformation.

#Operations

Method Path Description Bitrix24 Method
GET /v1/order-statuses List all (with filter, sort, pagination) sale.status.list
GET /v1/order-statuses/:id Get by ID sale.status.get
POST /v1/order-statuses Create new sale.status.add
PATCH /v1/order-statuses/:id Update by ID sale.status.update
DELETE /v1/order-statuses/:id Delete by ID sale.status.delete

#Fields

API Name Bitrix24 Name Type Readonly Description
id id string yes Идентификатор записи
type type string
sort sort number
notify notify boolean
color color string
xmlId xmlId string

#Examples

#List

Terminal 
curl -X GET '/v1/order-statuses?limit=10' \
  -H 'X-Api-Key: YOUR_KEY'

#Get by ID

Terminal 
curl -X GET '/v1/order-statuses/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal 
curl -X POST '/v1/order-statuses' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"type":"value","sort":1,"notify":"true"}'

#Update

Terminal 
curl -X PATCH '/v1/order-statuses/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal 
curl -X DELETE '/v1/order-statuses/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal 
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"order-statuses","action":"list","params":{"limit":5}}]}'