Получить список свойств отгрузки sale.shipmentproperty.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод получает список свойств отгрузки.
Параметры метода
|
Название |
Описание |
|
select |
Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_shipment_property). Если не передан или передан пустой массив, то будут выбраны все доступные поля свойств |
|
filter |
Объект для фильтрации выбранных свойств отгрузки в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных свойств отгрузки в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","active","code","defaultValue","description","inputFieldLocation","isAddress","isAddressFrom","isAddressTo","isEmail","isFiltered","isLocation","isLocation4tax","isPayer","isPhone","isProfileName","isZip","multiple","name","personTypeId","propsGroupId","required","settings","sort","type","userProps","util","xmlId"],"filter":{"@type":"STRING","%code":"EMAIL"},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipmentproperty.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","active","code","defaultValue","description","inputFieldLocation","isAddress","isAddressFrom","isAddressTo","isEmail","isFiltered","isLocation","isLocation4tax","isPayer","isPhone","isProfileName","isZip","multiple","name","personTypeId","propsGroupId","required","settings","sort","type","userProps","util","xmlId"],"filter":{"@type":"STRING","%code":"EMAIL"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.shipmentproperty.list
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ShipmentPropertyListResult = {
properties: {
id: number
active: string
code: string
defaultValue: string
description: string
inputFieldLocation: string
isAddress: string
isAddressFrom: string
isAddressTo: string
isEmail: string
isFiltered: string
isLocation: string
isPayer: string
isPhone: string
isProfileName: string
isZip: string
multiple: string
name: string
personTypeId: number
propsGroupId: number
required: string
settings: Record<string, unknown> | unknown[]
sort: number
type: string
userProps: string
util: string
xmlId: string
}[]
}
try {
// sale.shipmentproperty.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<ShipmentPropertyListResult>({
method: 'sale.shipmentproperty.list',
params: {
select: [
'id',
'active',
'code',
'defaultValue',
'description',
'inputFieldLocation',
'isAddress',
'isAddressFrom',
'isAddressTo',
'isEmail',
'isFiltered',
'isLocation',
'isLocation4tax',
'isPayer',
'isPhone',
'isProfileName',
'isZip',
'multiple',
'name',
'personTypeId',
'propsGroupId',
'required',
'settings',
'sort',
'type',
'userProps',
'util',
'xmlId',
],
filter: {
'@type': 'STRING',
'%code': 'EMAIL',
},
order: {
id: 'desc',
},
start: 0,
},
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('Shipment properties on this page:', result.properties.length, result.properties)
}
} 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 fetchShipmentPropertyList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.shipmentproperty.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'sale.shipmentproperty.list',
params: {
select: [
'id',
'active',
'code',
'defaultValue',
'description',
'inputFieldLocation',
'isAddress',
'isAddressFrom',
'isAddressTo',
'isEmail',
'isFiltered',
'isLocation',
'isLocation4tax',
'isPayer',
'isPhone',
'isProfileName',
'isZip',
'multiple',
'name',
'personTypeId',
'propsGroupId',
'required',
'settings',
'sort',
'type',
'userProps',
'util',
'xmlId',
],
filter: {
'@type': 'STRING',
'%code': 'EMAIL',
},
order: {
id: 'desc',
},
start: 0,
},
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('Shipment properties on this page:', result.properties.length, result.properties)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchShipmentPropertyList)
</script>
try {
$response = $b24Service
->core
->call(
'sale.shipmentproperty.list',
[
'select' => [
'id',
'active',
'code',
'defaultValue',
'description',
'inputFieldLocation',
'isAddress',
'isAddressFrom',
'isAddressTo',
'isEmail',
'isFiltered',
'isLocation',
'isLocation4tax',
'isPayer',
'isPhone',
'isProfileName',
'isZip',
'multiple',
'name',
'personTypeId',
'propsGroupId',
'required',
'settings',
'sort',
'type',
'userProps',
'util',
'xmlId',
],
'filter' => [
'@type' => 'STRING',
'%code' => 'EMAIL',
],
'order' => [
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching shipment properties: ' . $e->getMessage();
}
BX24.callMethod(
"sale.shipmentproperty.list", {
"select": [
"id",
"active",
"code",
"defaultValue",
"description",
"inputFieldLocation",
"isAddress",
"isAddressFrom",
"isAddressTo",
"isEmail",
"isFiltered",
"isLocation",
"isLocation4tax",
"isPayer",
"isPhone",
"isProfileName",
"isZip",
"multiple",
"name",
"personTypeId",
"propsGroupId",
"required",
"settings",
"sort",
"type",
"userProps",
"util",
"xmlId",
],
"filter": {
"@type": "STRING",
"%code": "EMAIL",
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.shipmentproperty.list',
[
'select' => [
"id",
"active",
"code",
"defaultValue",
"description",
"inputFieldLocation",
"isAddress",
"isAddressFrom",
"isAddressTo",
"isEmail",
"isFiltered",
"isLocation",
"isLocation4tax",
"isPayer",
"isPhone",
"isProfileName",
"isZip",
"multiple",
"name",
"personTypeId",
"propsGroupId",
"required",
"settings",
"sort",
"type",
"userProps",
"util",
"xmlId",
],
'filter' => [
"@type" => "STRING",
"%code" => "EMAIL",
],
'order' => [
"id" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"properties":[
{
"active":"Y",
"code":"EMAIL",
"defaultValue":"",
"description":"",
"id":47,
"inputFieldLocation":"0",
"isAddress":"N",
"isAddressFrom":"N",
"isAddressTo":"N",
"isEmail":"Y",
"isFiltered":"Y",
"isLocation":"N",
"isPayer":"N",
"isPhone":"N",
"isProfileName":"N",
"isZip":"N",
"multiple":"N",
"name":"E-Mail",
"personTypeId":3,
"propsGroupId":5,
"required":"Y",
"settings":[
],
"sort":300,
"type":"STRING",
"userProps":"Y",
"util":"N",
"xmlId":""
},
{
"active":"Y",
"code":"EMAIL",
"defaultValue":"",
"description":"",
"id":33,
"inputFieldLocation":"0",
"isAddress":"N",
"isAddressFrom":"N",
"isAddressTo":"N",
"isEmail":"Y",
"isFiltered":"N",
"isLocation":"N",
"isPayer":"N",
"isPhone":"N",
"isProfileName":"N",
"isZip":"N",
"multiple":"N",
"name":"E-Mail",
"personTypeId":4,
"propsGroupId":8,
"required":"Y",
"settings":{
"size":40
},
"sort":250,
"type":"STRING",
"userProps":"Y",
"util":"N",
"xmlId":""
},
{
"active":"Y",
"code":"EMAIL",
"defaultValue":"",
"description":"",
"id":21,
"inputFieldLocation":"0",
"isAddress":"N",
"isAddressFrom":"N",
"isAddressTo":"N",
"isEmail":"Y",
"isFiltered":"Y",
"isLocation":"N",
"isPayer":"N",
"isPhone":"N",
"isProfileName":"N",
"isZip":"N",
"multiple":"N",
"name":"E-Mail",
"personTypeId":3,
"propsGroupId":5,
"required":"Y",
"settings":{
"size":40
},
"sort":110,
"type":"STRING",
"userProps":"Y",
"util":"N",
"xmlId":""
}
]
},
"total":3,
"time":{
"start":1712818881.719586,
"finish":1712818881.960037,
"duration":0.24045109748840332,
"processing":0.06902408599853516,
"date_start":"2024-04-11T10:01:21+03:00",
"date_finish":"2024-04-11T10:01:21+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
properties |
Массив объектов с информацией о выбранных свойствах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения свойств отгрузки |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Свойства отгрузки в Интернет-магазине: обзор методов
- Добавить свойство отгрузки sale.shipmentproperty.add
- Обновить свойство отгрузки sale.shipmentproperty.update
- Получить свойство отгрузки sale.shipmentproperty.get
- Удалить свойство отгрузки sale.shipmentproperty.delete
- Получить поля и настройки свойства отгрузки для определенного типа свойств sale.shipmentproperty.getfieldsbytype