Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить поля заказа sale.order.getfields». Вы узнаете экспертные методики работы с sale.order.getfields и научитесь избегать типичных ошибок начинающих разработчиков.
Получить поля заказа sale.order.getfields
> Scope: sale
>
> Кто может выполнять метод: администратор
Метод sale.order.getfields получает доступные поля заказа.
Без параметров.
Примеры кода
- cURL (Webhook)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.getfields- cURL (OAuth)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.getfields- JS
try
{
const response = await $b24.callMethod(
"sale.order.getfields", {}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}- PHP
try {
$response = $b24Service
->core
->call(
'sale.order.getfields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Fields: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting order fields: ' . $e->getMessage();
}- BX24.js
BX24.callMethod(
"sale.order.getfields", {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);- PHP CRest
require_once('crest.php');
$result = CRest::call(
'sale.order.getfields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';Обработка ответа
HTTP-статус: 200
{
"result": {
"order": {
"accountNumber": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"additionalInfo": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"affiliateId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"canceled": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"comments": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"companyId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"currency": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"dateCanceled": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateInsert": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "datetime"
},
"dateLock": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateMarked": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateStatus": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateUpdate": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"deducted": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"discountValue": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "double"
},
"empCanceledId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"empMarkedId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"empStatusId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"externalOrder": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"id1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"lid": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"lockedBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"marked": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"orderTopic": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"payed": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"personTypeId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "integer"
},
"personTypeXmlId": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"price": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "double"
},
"reasonCanceled": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"reasonMarked": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"recountFlag": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"recurringId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"responsibleId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"statusId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"statusXmlId": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"taxValue": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "double"
},
"updated1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"userDescription": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"userId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"version": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"version1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"xmlId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
}
}
},
"time": {
"start": 1712825736.172681,
"finish": 1712825736.838046,
"duration": 0.6653649806976318,
"processing": 0.03579592704772949,
"date_start": "2024-04-11T11:55:36+03:00",
"date_finish": "2024-04-11T11:55:36+03:00"
}
}Возвращаемые данные
Названиетип | Описание |
|---|---|
resultobject | Корневой элемент ответа |
orderobject | Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}. Где field — идентификатор поля объекта sale_order, а value — объект типа rest_field_description |
timetime | Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}Возможные коды ошибок
| Код | Описание |
|---|---|
200040300010 | Недостаточно прав для чтения доступных полей заказа |
0 | Другие ошибки (например, фатальные ошибки) |
- [](./sale-order-add)
- [](./sale-order-update)
- [](./sale-order-get)
- [](./sale-order-list)
- [](./sale-order-delete)
💡 Экспертное мнение и рекомендации
Советы эксперта по интеграции:
- Всегда используйте кэширование при частых запросах к sale.order.getfields, чтобы разгрузить базу данных.
- Соблюдайте стандарты PSR при написании обработчиков для «Получить поля заказа sale.order.getfields».
- Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru