Обновить значения свойств отгрузки sale.shipmentpropertyvalue.modify
Scope:
saleКто может выполнять метод: администратор
Метод обновляет значения свойств отгрузки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Корневой элемент, в котором передаются параметры запроса |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
shipment* |
Объект, содержащий значения идентификатора отгрузки и значения свойств отгрузки (подробное описание приведено ниже) |
Параметр shipment
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор отгрузки |
|
|
propertyValues* |
Массив объектов, содержащих идентификатор свойства отгрузки и значение свойства (подробное описание приведено ниже) |
Параметр propertyValues
Обязательные параметры отмечены *
|
Название |
Описание |
|
shipmentPropsId* |
Идентификатор свойства отгрузки |
|
value* |
Значение свойства |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentpropertyvalue.modify
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"shipment":{"id":4120,"propertyValues":[{"shipmentPropsId":105,"value":"Comments value"},{"shipmentPropsId":106,"value":"Description value"}]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentpropertyvalue.modify
try
{
const response = await $b24.callMethod(
'sale.shipmentpropertyvalue.modify', {
fields: {
shipment: {
id: 4120,
propertyValues: [{
shipmentPropsId: 105,
value: 'Comments value'
},
{
shipmentPropsId: 106,
value: 'Description value'
},
],
},
}
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.shipmentpropertyvalue.modify',
[
'fields' => [
'shipment' => [
'id' => 4120,
'propertyValues' => [
[
'shipmentPropsId' => 105,
'value' => 'Comments value'
],
[
'shipmentPropsId' => 106,
'value' => 'Description value'
],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error modifying shipment property value: ' . $e->getMessage();
}
BX24.callMethod(
'sale.shipmentpropertyvalue.modify', {
fields: {
shipment: {
id: 4120,
propertyValues: [{
shipmentPropsId: 105,
value: 'Comments value'
},
{
shipmentPropsId: 106,
value: 'Description value'
},
],
},
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipmentpropertyvalue.modify',
[
'fields' => [
'shipment' => [
'id' => 4120,
'propertyValues' => [
[
'shipmentPropsId' => 105,
'value' => 'Comments value'
],
[
'shipmentPropsId' => 106,
'value' => 'Description value'
],
],
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"propertyValues":[
{
"code":null,
"id":38164,
"name":"Comments",
"value":"Comments value"
},
{
"code":null,
"id":38165,
"name":"Description",
"value":"Description value"
}
]
},
"time":{
"start":1718022201.149589,
"finish":1718022201.726496,
"duration":0.5769069194793701,
"processing":0.38397693634033203,
"date_start":"2024-06-10T15:23:21+03:00",
"date_finish":"2024-06-10T15:23:21+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
propertyValues |
Массив объектов, содержащих информацию о значениях свойств отгрузок |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":100,
"error_description":"Could not find value for parameter {fields}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для изменения значений свойств |
|
|
Не указаны обязательные параметры |
|
|
Некорректный идентификатор отгрузки |
|
|
Отгрузка не найдена |
|
|
Ошибка сохранения заказа |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить значения свойства отгрузки по id sale.shipmentpropertyvalue.get
- Получить список значений свойств отгрузки sale.shipmentpropertyvalue.list
- Удалить значения свойства отгрузки sale.shipmentpropertyvalue.delete
- Получить доступные поля значений свойств отгрузки sale.shipmentpropertyvalue.getfields