sale.tradeBinding.getFields
Получить доступные поля заказов из источников
Описание
Метод sale.tradeBinding.getFields возвращает доступные поля заказов из источников.
Без параметров.
Примеры запроса
-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.tradeBinding.getFields
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.tradeBinding.getFields
// 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 a single field descriptor (each value in the tradeBinding map)
type FieldDescription = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type GetFieldsResult = {
tradeBinding: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<GetFieldsResult>({
method: 'sale.tradeBinding.getFields',
params: {},
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(Object.keys(result.tradeBinding))
}
} 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 getTradeBindingFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.tradeBinding.getFields',
params: {},
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(Object.keys(result.tradeBinding))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTradeBindingFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.tradebinding.get_fields().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.tradeBinding.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
console.log($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting trade binding fields: ' . $e->getMessage();
}
BX24.callMethod(
'sale.tradeBinding.getFields',
{},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.tradeBinding.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.tradeBinding.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.tradeBinding.getFields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "tradeBinding".
raw, ok := b24.Unwrap(res.Result, "tradeBinding")
if !ok {
return fmt.Errorf("в ответе нет ключа tradeBinding")
}
fmt.Printf("%s\n", raw)
Ответ
HTTP-статус: 200
{
"result": {
"tradeBinding": {
"externalOrderId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
}
// прочие поля
}
},
"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
Корневой элемент ответа
tradeBinding
object
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта sale_order_trade_binding , а value — объект типа rest_field_description
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access Denied"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для выполнения метода | |
0 |
Другие ошибки (например, фатальные ошибки) |

