Update Order sale.order.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: administrator

Updates order fields and returns the updated order.

The method does not change basket items, payments, or shipments — use the sale.basketitem.*, sale.payment.*, and sale.shipment.* methods for them.

The method skips fields that cannot be changed without returning an error: the response is successful, but the values remain unchanged. There are two groups of such fields:

  • lid, personTypeId, currency, userId — set only when the order is created
  • id, accountNumber, payed, deducted, and other read-only fields — generated by Bitrix24

To find out which fields can be changed, check the isImmutable and isReadOnly attributes in the sale.order.getFields response.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_order.id

Order identifier. It is returned by the sale.order.add and sale.order.list methods

fields*
object

Fields to change. Fields that are not passed keep their current values; an empty object returns the order unchanged (detailed description)

Parameter fields

Name
type

Description

price
double

Order amount including delivery

discountValue
double

Discount value

statusId
sale_status.id

Order status identifier. The list of statuses is returned by the sale.status.list method

empStatusId
user.id

Identifier of the user who changed the order status

dateInsert
datetime

Order creation date

marked
string

Indicates whether the order is marked as problematic. Bitrix24 sets Y automatically if a warning occurred while the order was being saved. Bitrix24 writes the reason to the reasonMarked field.

  • Y — yes
  • N — no

empMarkedId
user.id

Identifier of the user who set the marking

reasonMarked
string

Reason for marking the order

userDescription
string

Customer's comment on the order

additionalInfo
string

Deprecated.

Additional information

comments
string

Manager's comment on the order

companyId
integer

Identifier of the company from the Online Store module

responsibleId
user.id

Identifier of the user responsible for the order

recurringId
string

Subscription renewal identifier

lockedBy
string

Relevant only for on-premise.

Identifier of the user who locked the order. The order is locked in the admin panel when the user opens the detail form of the order

recountFlag
string

Deprecated.

Recount flag.

  • Y — yes
  • N — no

affiliateId
integer

Relevant only for on-premise.

Affiliate identifier

updated1c
string

Whether the order was updated via an ERP system.

  • Y — yes
  • N — no

orderTopic
string

Deprecated.

Order topic

xmlId
string

External identifier

id1c
string

Identifier in the ERP system

version1c
string

Version in the ERP system

externalOrder
string

Whether the order is from an external system.

  • Y — yes
  • N — no

canceled
string

Whether the order was canceled.

  • Y — yes
  • N — no

empCanceledId
user.id

Identifier of the user who canceled the order

reasonCanceled
string

Reason for cancellation

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":300,"fields":{"statusId":"P","responsibleId":1,"comments":"Payment received, the order has been sent for picking"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":300,"fields":{"statusId":"P","responsibleId":1,"comments":"Payment received, the order has been sent for picking"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.order.update
        
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type OrderUpdateResult = {
          order: {
            accountNumber: string
            additionalInfo: string
            affiliateId: number | null
            canceled: string
            clients: Record<string, unknown>[]
            comments: string
            companyId: number | null
            currency: string
            dateCanceled: ISODate | null
            dateInsert: ISODate | null
            dateLock: ISODate | null
            dateMarked: ISODate | null
            dateStatus: ISODate | null
            dateUpdate: ISODate | null
            deducted: string
            discountValue: number
            empCanceledId: number | null
            empMarkedId: number | null
            empStatusId: number
            externalOrder: string
            id: number
            id1c: string
            lid: string
            lockedBy: string
            marked: string
            orderTopic: string
            payed: string
            personTypeId: number
            personTypeXmlId: string
            price: number
            propertyValues: Record<string, unknown>[]
            reasonCanceled: string
            reasonMarked: string
            recountFlag: string
            recurringId: string
            requisiteLink: Record<string, number>
            responsibleId: number
            statusId: string
            statusXmlId: string
            taxValue: number
            updated1c: string
            userDescription: string
            userId: number
            version: number
            version1c: string
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<OrderUpdateResult>({
            method: 'sale.order.update',
            params: {
              id: 300,
              fields: {
                statusId: 'P',
                responsibleId: 1,
                comments: 'Payment received, the order has been sent for picking',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.order.id, result.order.statusId, result.order.price)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateOrder() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.order.update',
                params: {
                  id: 300,
                  fields: {
                    statusId: 'P',
                    responsibleId: 1,
                    comments: 'Payment received, the order has been sent for picking',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.order.id, result.order.statusId, result.order.price)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateOrder)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "statusId": "P",
            "responsibleId": 1,
            "comments": "Payment received, the order has been sent for picking",
        }
        
        try:
            bitrix_response = client.sale.order.update(
                bitrix_id=300,
                fields=fields,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.order.update',
                    [
                        'id' => 300,
                        'fields' => [
                            'statusId'      => 'P',
                            'responsibleId' => 1,
                            'comments'      => 'Payment received, the order has been sent for picking',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating sale order: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.order.update',
            {
                id: 300,
                fields: {
                    statusId: 'P',
                    responsibleId: 1,
                    comments: 'Payment received, the order has been sent for picking',
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.order.update',
            [
                'id' => 300,
                'fields' => [
                    'statusId' => 'P',
                    'responsibleId' => 1,
                    'comments' => 'Payment received, the order has been sent for picking',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.order.update", b24.Params{
        	"id": 300,
        	"fields": b24.Params{
        		"statusId":      "P",
        		"responsibleId": 1,
        		"comments":      "Payment received, the order has been sent for picking",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.order.update: %w", err)
        }
        
        // The method wraps the response in an object with the "order" key.
        raw, ok := b24.Unwrap(res.Result, "order")
        if !ok {
        	return fmt.Errorf("no order key in the response")
        }
        
        var item struct {
        	ID            b24.ID `json:"id"`
        	AccountNumber string `json:"accountNumber"`
        	StatusID      string `json:"statusId"`
        	Comments      string `json:"comments"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.AccountNumber, item.StatusID, item.Comments)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "order": {
                    "accountNumber": "300",
                    "additionalInfo": "",
                    "affiliateId": null,
                    "canceled": "N",
                    "clients": [
                        {
                            "entityId": 2819,
                            "entityTypeId": 3,
                            "id": 1717,
                            "isPrimary": "Y",
                            "orderId": 300,
                            "roleId": 0,
                            "sort": 0
                        }
                    ],
                    "comments": "Payment received, the order has been sent for picking",
                    "companyId": null,
                    "currency": "USD",
                    "dateCanceled": null,
                    "dateInsert": "2026-09-28T08:02:16+02:00",
                    "dateLock": null,
                    "dateMarked": null,
                    "dateStatus": "2026-09-28T08:02:16+02:00",
                    "dateUpdate": "2026-09-28T08:02:16+02:00",
                    "deducted": "N",
                    "discountValue": 0,
                    "empCanceledId": null,
                    "empMarkedId": null,
                    "empStatusId": 1,
                    "externalOrder": "N",
                    "id": 300,
                    "id1c": "",
                    "lid": "s1",
                    "lockedBy": "",
                    "marked": "N",
                    "orderTopic": "",
                    "payed": "N",
                    "personTypeId": 1,
                    "personTypeXmlId": "",
                    "price": 0,
                    "propertyValues": [
                        {
                            "code": "EMAIL",
                            "id": 11287,
                            "name": "E-Mail",
                            "orderPropsId": 41,
                            "orderPropsXmlId": "bx_60b605ba1d082",
                            "value": null
                        },
                        {
                            "code": "FIO",
                            "id": 11289,
                            "name": "Full name",
                            "orderPropsId": 39,
                            "orderPropsXmlId": "bx_609bec7cc794c",
                            "value": null
                        }
                    ],
                    "reasonCanceled": "",
                    "reasonMarked": "",
                    "recountFlag": "Y",
                    "recurringId": "",
                    "requisiteLink": {
                        "bankDetailId": 0,
                        "mcBankDetailId": 0,
                        "mcRequisiteId": 0,
                        "requisiteId": 467
                    },
                    "responsibleId": 1,
                    "statusId": "P",
                    "statusXmlId": "",
                    "taxValue": 0,
                    "updated1c": "N",
                    "userDescription": "Call before delivery",
                    "userId": 1,
                    "version": 1,
                    "version1c": "",
                    "xmlId": "bx_6aba02e7a86af"
                }
            },
            "time": {
                "start": 1790575336,
                "finish": 1790575336.994123,
                "duration": 0.9941229820251465,
                "processing": 0,
                "date_start": "2026-09-28T09:02:16+02:00",
                "date_finish": "2026-09-28T09:02:16+02:00",
                "operating_reset_at": 1790575936,
                "operating": 0.22028803825378418
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response (detailed description)

time
time

Information about the request execution time

Object result

Name
type

Description

order
sale_order

The order after the update. In addition to the order fields, it contains clients, requisiteLink, propertyValues, and, if the order has them, basketItems and shipments. The related objects are described on the sale.order.get page

Error Handling

HTTP Status: 400

{
            "error": "200540400001",
            "error_description": "order is not exists"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

200540400001

order is not exists

There is no order with this id

400

100

Could not find value for parameter {fields}

The fields parameter is not passed

400

100

Bitrix\Sale\Order constructor must be is public

The id parameter is not passed

400

200040300020

Access Denied

Insufficient permissions to update the order

400

0

Save error text

The order was not saved for another reason, which is given in error_description

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning