Get Order Field Values and Related Objects sale.order.get
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:
saleWho can execute the method: administrator
The method sale.order.get is designed to retrieve values for all fields of an order and related objects.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Order identifier |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.get
// 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 OrderGetResult = {
order: {
id: number
accountNumber: string
currency: string
price: number
payed: string
canceled: string
statusId: string
userId: number
personTypeId: number
dateInsert: ISODate | null
dateUpdate: ISODate | null
basketItems: Record<string, unknown>[]
payments: Record<string, unknown>[]
shipments: Record<string, unknown>[]
propertyValues: Record<string, unknown>[]
}
}
try {
const response = await $b24.actions.v2.call.make<OrderGetResult>({
method: 'sale.order.get',
params: {
id: 6,
},
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('Order #' + result.order.accountNumber, 'status:', result.order.statusId, 'total:', result.order.price, result.order.currency)
}
} 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 getOrder() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.order.get',
params: {
id: 6,
},
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('Order #' + result.order.accountNumber, 'status:', result.order.statusId, 'total:', result.order.price, result.order.currency)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getOrder)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.order.get(
bitrix_id=6,
).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.get',
[
'id' => 6
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Order data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting order: ' . $e->getMessage();
}
BX24.callMethod(
"sale.order.get", {
"id": 6
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.order.get',
[
'id' => 6
]
);
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.get", b24.Params{
"id": 6,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.order.get: %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"`
Canceled string `json:"canceled"`
Comments string `json:"comments"`
CompanyID b24.ID `json:"companyId"`
Currency string `json:"currency"`
}
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": "392",
"additionalInfo": "",
"affiliateId": null,
"basketItems": [
{
"barcodeMulti": "N",
"basePrice": 980,
"canBuy": "Y",
"catalogXmlId": "cbc2957f-09fc-4b2a-b9de-6f925c4c9047",
"currency": "USD",
"customPrice": "N",
"dateInsert": "2024-02-28T17:35:06+02:00",
"dateRefresh": null,
"dateUpdate": "2024-02-28T17:37:08+02:00",
"detailPageUrl": "",
"dimensions": "a:3:{s:5:\u0022WIDTH\u0022;N;s:6:\u0022HEIGHT\u0022;N;s:6:\u0022LENGTH\u0022;N;}",
"discountCoupon": "",
"discountName": "",
"discountPrice": 0,
"discountValue": "",
"fuserId": 4,
"id": "255",
"lid": "s1",
"measureCode": "796",
"measureName": "pcs",
"module": "catalog",
"name": "Men's Fire T-Shirt",
"notes": "BASE",
"orderId": "236",
"price": 980,
"priceTypeId": 1,
"productId": 348,
"productPriceId": 112,
"productProviderClass": "\\Bitrix\\Catalog\\Product\\CatalogProvider",
"productXmlId": "1000000386",
"properties": [
{
"basketId": 255,
"code": "CATALOG.XML_ID",
"id": 139,
"name": "Catalog XML_ID",
"sort": 100,
"value": "cbc2957f-09fc-4b2a-b9de-6f925c4c9047",
"xmlId": "bx_65df52a9ac502"
},
{
"basketId": 255,
"code": "PRODUCT.XML_ID",
"id": 140,
"name": "Product XML_ID",
"sort": 100,
"value": "1000000386",
"xmlId": "bx_65df52a9ace55"
}
],
"quantity": 1,
"recommendation": "",
"reservations": [
{
"basketId": 255,
"dateReserve": "2024-02-28T17:36:51+02:00",
"dateReserveEnd": "2024-03-01T23:00:00+02:00",
"id": 39,
"quantity": 1,
"reservedBy": null,
"storeId": 1
}
],
"setParentId": "",
"sort": 100,
"subscribe": "N",
"type": "",
"vatIncluded": "Y",
"vatRate": 0.2,
"weight": 0,
"xmlId": "bx_65df52a9ab47f"
}
],
"canceled": "N",
"clients": [
{
"entityId": 6,
"entityTypeId": 3,
"id": 901,
"isPrimary": "Y",
"orderId": 236,
"roleId": 0,
"sort": 0
}
],
"comments": "",
"companyId": 0,
"currency": "USD",
"dateCanceled": null,
"dateInsert": "2024-02-28T17:36:55+02:00",
"dateLock": null,
"dateMarked": null,
"dateStatus": "2024-02-28T17:36:38+02:00",
"dateUpdate": "2024-02-28T17:37:11+02:00",
"deducted": "N",
"discountValue": 0,
"empCanceledId": null,
"empMarkedId": null,
"empStatusId": 1,
"externalOrder": "N",
"id": 236,
"id1c": "",
"lid": "s1",
"lockedBy": "",
"marked": "N",
"orderTopic": "",
"payed": "N",
"payments": [
{
"accountNumber": "392\/1",
"comments": "",
"companyId": 0,
"currency": "USD",
"dateBill": "2024-02-28T17:36:44+02:00",
"dateMarked": null,
"datePaid": null,
"datePayBefore": null,
"dateResponsibleId": null,
"empMarkedId": null,
"empPaidId": null,
"empResponsibleId": null,
"empReturnId": null,
"externalPayment": "N",
"id": 123,
"id1c": "",
"isReturn": "N",
"marked": "N",
"orderId": 236,
"paid": "N",
"payReturnComment": "",
"payReturnDate": null,
"payReturnNum": "",
"paySystemId": 48,
"paySystemIsCash": "N",
"paySystemName": "Card Payment",
"paySystemXmlId": "bx_65df3d512af59",
"payVoucherDate": null,
"payVoucherNum": "",
"priceCod": "0",
"psCurrency": "",
"psInvoiceId": 2,
"psResponseDate": null,
"psStatus": "",
"psStatusCode": "",
"psStatusDescription": "",
"psStatusMessage": "",
"psSum": null,
"reasonMarked": "",
"responsibleId": null,
"sum": 1480,
"updated1c": "N",
"version1c": "",
"xmlId": "bx_65df530c472fa"
}
],
"personTypeId": 3,
"personTypeXmlId": "",
"price": 1480,
"propertyValues": [
{
"code": "FIO",
"id": 1514,
"name": "First Last",
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "John Smith"
},
{
"code": "EMAIL",
"id": 1515,
"name": "E-Mail1",
"orderPropsId": 21,
"orderPropsXmlId": "bx_63a082af0d250",
"value": "email@mail.com"
},
{
"code": "PHONE",
"id": 1516,
"name": "Phone1",
"orderPropsId": 22,
"orderPropsXmlId": "bx_63a082a06864d",
"value": "14151234567"
},
{
"code": "CONTACT_ADDRESS",
"id": 1517,
"name": "Address",
"orderPropsId": 42,
"orderPropsXmlId": null,
"value": null
},
{
"code": "ADDRESS",
"id": 1518,
"name": "Delivery Address",
"orderPropsId": 26,
"orderPropsXmlId": null,
"value": "test"
}
],
"reasonCanceled": "",
"reasonMarked": "",
"recountFlag": "Y",
"recurringId": "",
"requisiteLink": {
"bankDetailId": 0,
"mcBankDetailId": 0,
"mcRequisiteId": 0,
"requisiteId": 3
},
"responsibleId": 1,
"shipments": [
{
"accountNumber": "392\/2",
"allowDelivery": "N",
"basePriceDelivery": 500,
"canceled": "N",
"comments": "",
"companyId": 0,
"currency": "USD",
"customPriceDelivery": "N",
"dateAllowDelivery": null,
"dateCanceled": null,
"dateDeducted": null,
"dateInsert": "2024-02-28T17:36:41+02:00",
"dateMarked": null,
"dateResponsibleId": null,
"deducted": "N",
"deliveryDocDate": null,
"deliveryDocNum": "",
"deliveryId": 1,
"deliveryName": "Courier Delivery",
"deliveryXmlId": "",
"discountPrice": 0,
"empAllowDeliveryId": null,
"empCanceledId": null,
"empDeductedId": null,
"empMarkedId": null,
"empResponsibleId": null,
"externalDelivery": "N",
"id": 338,
"id1c": "",
"marked": "N",
"orderId": 236,
"priceDelivery": 500,
"reasonMarked": "",
"reasonUndoDeducted": "",
"responsibleId": null,
"shipmentItems": [
{
"basketId": 255,
"dateInsert": "2024-02-28T17:36:53+02:00",
"id": 320,
"orderDeliveryId": 338,
"quantity": 1,
"reservedQuantity": 1,
"xmlId": "bx_65df5309cf490"
}
],
"statusId": "DN",
"statusXmlId": "",
"system": "N",
"trackingDescription": "",
"trackingLastCheck": "",
"trackingNumber": "",
"trackingStatus": "",
"updated1c": "N",
"version1c": "",
"xmlId": "bx_65df5309939b8"
}
],
"statusId": "N",
"statusXmlId": "",
"taxValue": 163.33,
"tradeBindings": [
{
"externalOrderId": "236",
"id": 224,
"orderId": 236,
"params": null,
"tradingPlatformId": "9",
"tradingPlatformXmlId": "bx_659ff72864c8f",
"xmlId": "bx_65df53067ac59"
}
],
"updated1c": "N",
"userDescription": "",
"userId": 1,
"version": 1,
"version1c": "",
"xmlId": "bx_65df53063d56d"
}
},
"time": {
"start": 1712938174.436428,
"finish": 1712938175.432068,
"duration": 0.9956400394439697,
"processing": 0.5710320472717285,
"date_start": "2024-04-12T19:09:34+02:00",
"date_finish": "2024-04-12T19:09:35+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
order |
Order information |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":200540400001,
"error_description":"order does not exist"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Order not found |
|
|
Insufficient permissions to read the order |
|
|
Parameter |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |