Получить значения полей заказа и связанных объектов sale.order.get
Scope:
saleКто может выполнять метод: администратор
Метод sale.order.get получает предназначен для получения значений всех полей заказа и связанных объектов.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор заказа |
Примеры кода
Как использовать примеры в документации
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
try
{
const response = await $b24.callMethod(
"sale.order.get", {
"id": 6
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.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>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"order": {
"accountNumber": "392",
"additionalInfo": "",
"affiliateId": null,
"basketItems": [
{
"barcodeMulti": "N",
"basePrice": 980,
"canBuy": "Y",
"catalogXmlId": "cbc2957f-09fc-4b2a-b9de-6f925c4c9047",
"currency": "RUB",
"customPrice": "N",
"dateInsert": "2024-02-28T17:35:06+03:00",
"dateRefresh": null,
"dateUpdate": "2024-02-28T17:37:08+03: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": "шт",
"module": "catalog",
"name": "Футболка Мужской Огонь",
"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+03:00",
"dateReserveEnd": "2024-03-01T23:00:00+03: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": "RUB",
"dateCanceled": null,
"dateInsert": "2024-02-28T17:36:55+03:00",
"dateLock": null,
"dateMarked": null,
"dateStatus": "2024-02-28T17:36:38+03:00",
"dateUpdate": "2024-02-28T17:37:11+03: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": "RUB",
"dateBill": "2024-02-28T17:36:44+03: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": "Оплата картой",
"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": "Имя Фамилия",
"orderPropsId": 20,
"orderPropsXmlId": null,
"value": "Иван Иванов"
},
{
"code": "EMAIL",
"id": 1515,
"name": "E-Mail1",
"orderPropsId": 21,
"orderPropsXmlId": "bx_63a082af0d250",
"value": "email@mail.ru"
},
{
"code": "PHONE",
"id": 1516,
"name": "Телефон1",
"orderPropsId": 22,
"orderPropsXmlId": "bx_63a082a06864d",
"value": "79814561312"
},
{
"code": "CONTACT_ADDRESS",
"id": 1517,
"name": "Адрес",
"orderPropsId": 42,
"orderPropsXmlId": null,
"value": null
},
{
"code": "ADDRESS",
"id": 1518,
"name": "Адрес доставки",
"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": "RUB",
"customPriceDelivery": "N",
"dateAllowDelivery": null,
"dateCanceled": null,
"dateDeducted": null,
"dateInsert": "2024-02-28T17:36:41+03:00",
"dateMarked": null,
"dateResponsibleId": null,
"deducted": "N",
"deliveryDocDate": null,
"deliveryDocNum": "",
"deliveryId": 1,
"deliveryName": "Доставка курьером",
"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+03: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+03:00",
"date_finish": "2024-04-12T19:09:35+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
order |
Информация о заказе |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200540400001,
"error_description":"order is not exists"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Заказ не найден |
|
|
Недостаточно прав для чтения заказа |
|
|
Не указан параметр |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить заказ sale.order.add
- Изменить заказ sale.order.update
- Получить список заказов sale.order.list
- Удалить заказ и связанные объекты sale.order.delete
- Получить поля заказа sale.order.getfields