Получить поля заказа sale.order.getfields
Scope:
saleКто может выполнять метод: администратор
Метод sale.order.getfields получает доступные поля заказа.
Без параметров.
Примеры кода
Как использовать примеры в документации
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 -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
try
{
const response = await $b24.callMethod(
"sale.order.getfields", {}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
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.callMethod(
"sale.order.getfields", {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
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"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
order |
Объект в формате |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
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.get
- Получить список заказов sale.order.list
- Удалить заказ и связанные объекты sale.order.delete