Add Order sale.order.add

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

The method sale.order.add is designed for adding an order.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values for creating an order

Parameter fields

Required parameters are marked with *

Name `type`	Description
lid* `string`	Identifier of the site where this payer type will be used. Has a constant value 's1'
personTypeId* `sale_person_type.id`	Identifier of the payer type
currency* `string`	Currency. The list of currencies can be obtained via the method crm.currency.list
price `double`	Price
discountValue `double`	Discount value
statusId `sale_status.id`	Identifier of the order status
empStatusId `user.id`	Identifier of the user who changed the order status
dateInsert `datetime`	Order creation date
marked `string`	Marking flag. Indicates whether the shipment is marked as problematic. The value `Y` is set automatically if an error occurred during saving. `Y` — yes `N` — no Defaults to `N`
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
responsibleId `user.id`	Identifier of the user responsible for the order
recurringId `integer`	Identifier for subscription renewal
lockedBy `user.id`	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 Defaults to `Y`
affiliateId `integer`	Relevant only for on-premise. Identifier of the affiliate
updated1c `string`	Updated via QuickBooks and other similar platforms. `Y` — yes `N` — no Defaults to `N`
orderTopic `string`	Deprecated. Order topic
xmlId `string`	External identifier
id1c `string`	Identifier in QuickBooks and other similar platforms
version1c `string`	Version in QuickBooks and other similar platforms
externalOrder `string`	Whether the order is from an external system. `Y` — yes `N` — no Defaults to `N`
canceled `string`	Whether the order was canceled. `Y` — yes `N` — no Defaults to `N`
empCanceledId `user.id`	Identifier of the user who canceled the order
reasonCanceled `string`	Reason for cancellation
userId `user.id`	Identifier of the client

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"lid":"s1","personTypeId":1,"currency":"USD","price":100,"discountValue":10,"statusId":"N","empStatusId":1,"dateInsert":"2024-03-01T14:00:00","marked":"Y","empMarkedId":1,"reasonMarked":"","userDescription":"","additionalInfo":"","comments":"","companyId":1,"responsibleId":1,"recurringId":1,"lockedBy":1,"recountFlag":"N","affiliateId":1,"updated1c":"N","orderTopic":"","xmlId":"","id1c":"","version1c":"","externalOrder":"N","canceled":"Y","empCanceledId":1,"reasonCanceled":"","userId":1}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.add

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"lid":"s1","personTypeId":1,"currency":"USD","price":100,"discountValue":10,"statusId":"N","empStatusId":1,"dateInsert":"2024-03-01T14:00:00","marked":"Y","empMarkedId":1,"reasonMarked":"","userDescription":"","additionalInfo":"","comments":"","companyId":1,"responsibleId":1,"recurringId":1,"lockedBy":1,"recountFlag":"N","affiliateId":1,"updated1c":"N","orderTopic":"","xmlId":"","id1c":"","version1c":"","externalOrder":"N","canceled":"Y","empCanceledId":1,"reasonCanceled":"","userId":1},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.order.add

// 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 OrderResult = {
          order: {
            accountNumber: string
            additionalInfo: string
            affiliateId: number
            canceled: string
            clients: unknown[]
            comments: string
            companyId: number
            currency: string
            dateCanceled: ISODate | null
            dateInsert: ISODate | null
            dateMarked: ISODate | null
            dateStatus: ISODate | null
            dateUpdate: ISODate | null
            deducted: string
            discountValue: number
            empCanceledId: number
            empMarkedId: number
            empStatusId: number
            externalOrder: string
            id: number
            id1c: string
            lid: string
            lockedBy: string
            marked: string
            orderTopic: string
            payed: string
            personTypeId: number
            personTypeXmlId: string
            price: number
            reasonCanceled: string
            reasonMarked: string
            recountFlag: string
            recurringId: string
            requisiteLink: unknown[]
            responsibleId: number
            statusId: string
            statusXmlId: string
            updated1c: string
            userDescription: string
            userId: number
            version1c: string
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<OrderResult>({
            method: 'sale.order.add',
            params: {
              fields: {
                lid: 's1',
                personTypeId: 1,
                currency: 'USD',
                price: 100,
                discountValue: 10,
                statusId: 'N',
                empStatusId: 1,
                dateInsert: '2024-03-01T14:00:00',
                marked: 'Y',
                empMarkedId: 1,
                reasonMarked: '',
                userDescription: '',
                additionalInfo: '',
                comments: '',
                companyId: 1,
                responsibleId: 1,
                recurringId: 1,
                lockedBy: 1,
                recountFlag: 'N',
                affiliateId: 1,
                updated1c: 'N',
                orderTopic: '',
                xmlId: '',
                id1c: '',
                version1c: '',
                externalOrder: 'N',
                canceled: 'Y',
                empCanceledId: 1,
                reasonCanceled: '',
                userId: 1,
              },
            },
            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.accountNumber)
          }
        } 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 addOrder() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.order.add',
                params: {
                  fields: {
                    lid: 's1',
                    personTypeId: 1,
                    currency: 'USD',
                    price: 100,
                    discountValue: 10,
                    statusId: 'N',
                    empStatusId: 1,
                    dateInsert: '2024-03-01T14:00:00',
                    marked: 'Y',
                    empMarkedId: 1,
                    reasonMarked: '',
                    userDescription: '',
                    additionalInfo: '',
                    comments: '',
                    companyId: 1,
                    responsibleId: 1,
                    recurringId: 1,
                    lockedBy: 1,
                    recountFlag: 'N',
                    affiliateId: 1,
                    updated1c: 'N',
                    orderTopic: '',
                    xmlId: '',
                    id1c: '',
                    version1c: '',
                    externalOrder: 'N',
                    canceled: 'Y',
                    empCanceledId: 1,
                    reasonCanceled: '',
                    userId: 1,
                  },
                },
                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.accountNumber)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addOrder)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "lid": "s1",
            "personTypeId": 1,
            "currency": "USD",
            "price": 100,
            "discountValue": 10,
            "statusId": "N",
            "empStatusId": 1,
            "dateInsert": "2024-03-01T14:00:00",
            "marked": "Y",
            "empMarkedId": 1,
            "reasonMarked": "",
            "userDescription": "",
            "additionalInfo": "",
            "comments": "",
            "companyId": 1,
            "responsibleId": 1,
            "recurringId": 1,
            "lockedBy": 1,
            "recountFlag": "N",
            "affiliateId": 1,
            "updated1c": "N",
            "orderTopic": "",
            "xmlId": "",
            "id1c": "",
            "version1c": "",
            "externalOrder": "N",
            "canceled": "Y",
            "empCanceledId": 1,
            "reasonCanceled": "",
            "userId": 1,
        }
        
        try:
            bitrix_response = client.sale.order.add(
                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.add',
                    [
                        'fields' => [
                            'lid'            => 's1',
                            'personTypeId'   => 1,
                            'currency'       => 'USD',
                            'price'          => 100,
                            'discountValue'  => 10,
                            'statusId'       => 'N',
                            'empStatusId'    => 1,
                            'dateInsert'     => '2024-03-01T14:00:00',
                            'marked'         => 'Y',
                            'empMarkedId'    => 1,
                            'reasonMarked'   => '',
                            'userDescription' => '',
                            'additionalInfo' => '',
                            'comments'       => '',
                            'companyId'      => 1,
                            'responsibleId'  => 1,
                            'recurringId'    => 1,
                            'lockedBy'       => 1,
                            'recountFlag'    => 'N',
                            'affiliateId'    => 1,
                            'updated1c'      => 'N',
                            'orderTopic'     => '',
                            'xmlId'          => '',
                            'id1c'           => '',
                            'version1c'      => '',
                            'externalOrder'  => 'N',
                            'canceled'       => 'Y',
                            'empCanceledId'  => 1,
                            'reasonCanceled' => '',
                            'userId'         => 1,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding order: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.order.add',
            {
                fields: {
                    lid: 's1',
                    personTypeId: 1,
                    currency: 'USD',
                    price: 100,
                    discountValue: 10,
                    statusId: 'N',
                    empStatusId: 1,
                    dateInsert: '2024-03-01T14:00:00',
                    marked: 'Y',
                    empMarkedId: 1,
                    reasonMarked: '',
                    userDescription: '',
                    additionalInfo: '',
                    comments: '',
                    companyId: 1,
                    responsibleId: 1,
                    recurringId: 1,
                    lockedBy: 1,
                    recountFlag: 'N',
                    affiliateId: 1,
                    updated1c: 'N',
                    orderTopic: '',
                    xmlId: '',
                    id1c: '',
                    version1c: '',
                    externalOrder: 'N',
                    canceled: 'Y',
                    empCanceledId: 1,
                    reasonCanceled: '',
                    userId: 1,
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.order.add',
            [
                'fields' => [
                    'lid' => 's1',
                    'personTypeId' => 1,
                    'currency' => 'USD',
                    'price' => 100,
                    'discountValue' => 10,
                    'statusId' => 'N',
                    'empStatusId' => 1,
                    'dateInsert' => '2024-03-01T14:00:00',
                    'marked' => 'Y',
                    'empMarkedId' => 1,
                    'reasonMarked' => '',
                    'userDescription' => '',
                    'additionalInfo' => '',
                    'comments' => '',
                    'companyId' => 1,
                    'responsibleId' => 1,
                    'recurringId' => 1,
                    'lockedBy' => 1,
                    'recountFlag' => 'N',
                    'affiliateId' => 1,
                    'updated1c' => 'N',
                    'orderTopic' => '',
                    'xmlId' => '',
                    'id1c' => '',
                    'version1c' => '',
                    'externalOrder' => 'N',
                    'canceled' => 'Y',
                    'empCanceledId' => 1,
                    'reasonCanceled' => '',
                    'userId' => 1,
                ]
            ]
        );
        
        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.add", b24.Params{
        	"fields": b24.Params{
        		"lid":             "s1",
        		"personTypeId":    1,
        		"currency":        "EUR",
        		"price":           100,
        		"discountValue":   10,
        		"statusId":        "N",
        		"empStatusId":     1,
        		"dateInsert":      "2024-03-01T14:00:00",
        		"marked":          "Y",
        		"empMarkedId":     1,
        		"reasonMarked":    "",
        		"userDescription": "",
        		"additionalInfo":  "",
        		"comments":        "",
        		"companyId":       1,
        		"responsibleId":   1,
        		"recurringId":     1,
        		"lockedBy":        1,
        		"recountFlag":     "N",
        		"affiliateId":     1,
        		"updated1c":       "N",
        		"orderTopic":      "",
        		"xmlId":           "",
        		"id1c":            "",
        		"version1c":       "",
        		"externalOrder":   "N",
        		"canceled":        "Y",
        		"empCanceledId":   1,
        		"reasonCanceled":  "",
        		"userId":          1,
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.order.add: %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 {
        	AccountNumber  string `json:"accountNumber"`
        	AdditionalInfo string `json:"additionalInfo"`
        	AffiliateID    b24.ID `json:"affiliateId"`
        	Canceled       string `json:"canceled"`
        	Comments       string `json:"comments"`
        	CompanyID      b24.ID `json:"companyId"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.AccountNumber, item.AdditionalInfo)

Response Handling

HTTP Status: 200

{
            "result": {
                "order": {
                    "accountNumber": "455",
                    "additionalInfo": "",
                    "affiliateId": 1,
                    "canceled": "Y",
                    "clients": [],
                    "comments": "",
                    "companyId": 1,
                    "currency": "USD",
                    "dateCanceled": "2024-04-12T13:50:21+02:00",
                    "dateInsert": "2024-03-01T13:00:00+02:00",
                    "dateMarked": "2024-04-12T13:50:21+02:00",
                    "dateStatus": "2024-04-12T13:50:21+02:00",
                    "dateUpdate": "2024-04-12T13:50:21+02:00",
                    "deducted": "N",
                    "discountValue": 10,
                    "empCanceledId": 1,
                    "empMarkedId": 1,
                    "empStatusId": 1,
                    "externalOrder": "N",
                    "id": 299,
                    "id1c": "",
                    "lid": "s1",
                    "lockedBy": "1",
                    "marked": "Y",
                    "orderTopic": "",
                    "payed": "N",
                    "personTypeId": 1,
                    "personTypeXmlId": "",
                    "price": 100,
                    "reasonCanceled": "",
                    "reasonMarked": "",
                    "recountFlag": "N",
                    "recurringId": "1",
                    "requisiteLink": [],
                    "responsibleId": 1,
                    "statusId": "N",
                    "statusXmlId": "",
                    "updated1c": "N",
                    "userDescription": "",
                    "userId": 1,
                    "version1c": "",
                    "xmlId": ""
                }
            },
            "time": {
                "start": 1712922620.724857,
                "finish": 1712922623.393783,
                "duration": 2.6689260005950928,
                "processing": 2.210068941116333,
                "date_start": "2024-04-12T14:50:20+02:00",
                "date_finish": "2024-04-12T14:50:23+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
order `sale_order`	Object containing information about the added order
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error":200040300020,
            "error_description":"Access Denied"
        }

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

Code	Description
`200040300020`	Insufficient permissions to add an order
`100`	Parameter `fields` is not specified or is empty
`0`	Required fields are not provided
`0`	Other errors (e.g., fatal errors)

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

Was the article helpful?

Overview of methods

Update order

Add Order sale.order.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning