sale.tradePlatform.list
Получить список источников заказов
Описание
Метод sale.tradePlatform.list получает список источников заказов.
Параметры
select
array
необязательный
Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_trade_platform)
filter
object
необязательный
Список полей для фильтрации. При указании нескольких полей используется логика AND.
Поля соответствуют соответствуют полям объекта sale_order_trade_platform.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- = — равно (работает и с массивами)
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- > — больше
- < — меньше
- != — не равно
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
- >= — больше или равно
- <= — меньше или равно
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения начинающиеся с «мол»
- "%мол" — ищем значения заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции
- %= — LIKE (смотрите описание выше)
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения не начинающиеся с «мол»
- "%мол" — ищем значения не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (смотрите описание выше)
order
object
необязательный
Параметры сортировки. Формат: {поле: направление (ASC, DESC)}.
Поля соответствуют соответствуют полям объекта sale_order_trade_platform.
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","code"],"filter":{"%code":"smart"},"order":{"code":"asc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.tradePlatform.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","code"],"filter":{"%code":"smart"},"order":{"code":"asc"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.tradePlatform.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 TradePlatformResult = {
tradePlatforms: {
id: number
code: string
}[]
}
try {
// sale.tradePlatform.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<TradePlatformResult>({
method: 'sale.tradePlatform.list',
params: {
select: ['id', 'code'],
filter: { '%code': 'smart' },
order: { code: 'asc' },
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('Trade platforms:', result.tradePlatforms, 'Count:', result.tradePlatforms.length)
}
} 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 listTradePlatforms() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.tradePlatform.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.tradePlatform.list',
params: {
select: ['id', 'code'],
filter: { '%code': 'smart' },
order: { code: 'asc' },
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('Trade platforms:', result.tradePlatforms, 'Count:', result.tradePlatforms.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listTradePlatforms)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.tradeplatform.list(
select=[
"id",
"code",
],
filter={
"%code": "smart",
},
order={
"code": "asc",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.tradePlatform.list',
[
'select' => ['id', 'code'],
'filter' => ['%code' => 'smart'],
'order' => ['code' => 'asc'],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching trade platforms: ' . $e->getMessage();
}
BX24.callMethod(
"sale.tradePlatform.list",
{
select: ['id', 'code'],
filter: {'%code': 'smart'},
order: {'code': 'asc'},
},
function(result)
{
if(result.error())
{
console.error(result);
}
else
{
console.dir(result);
if (result.more())
{
result.next();
}
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.tradePlatform.list',
[
'select' => ['id', 'code'],
'filter' => ['%code' => 'smart'],
'order' => ['code' => 'asc'],
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.tradePlatform.list", b24.Params{
"select": []string{"id", "code"},
"filter": b24.Params{
"%code": "smart",
},
"order": b24.Params{
"code": "asc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.tradePlatform.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "tradePlatforms".
raw, ok := b24.Unwrap(res.Result, "tradePlatforms")
if !ok {
return fmt.Errorf("в ответе нет ключа tradePlatforms")
}
var items []struct {
Code string `json:"code"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Code)
}
Ответ
HTTP-статус: 200
{
"result": {
"tradePlatforms": [
{
"code": "smart_invoice",
"id": 2
}
]
},
"total": 1,
"time": {
"start": 1712135957.057659,
"finish": 1712135957.407821,
"duration": 0.3501620292663574,
"processing": 0.011919021606445312,
"date_start": "2024-04-03T11:19:17+02:00",
"date_finish": "2024-04-03T11:19:17+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
tradePlatforms
sale_order_trade_platform[]
Массив объектов с информацией об источниках заказов
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access Denied"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для выполнения метода |

