Типы данных и структура объектов в REST API Интернет-магазина

Тип

Описания и значения

sale_order

Целочисленный идентификатор заказа (например, 1). Получить идентификаторы заказов можно с помощью метода sale.order.list

sale_basket_item

Целочисленный идентификатор корзины (например, 1). Получить идентификаторы корзин можно с помощью метода sale.basketItem.list

sale_order_shipment

Целочисленный идентификатор отгрузки (например, 1). Получить идентификаторы отгрузок можно с помощью метода sale.shipment.list

sale_order_shipment_item

Целочисленный идентификатор элемента табличной части отгрузки (например, 1). Получить идентификаторы элементов табличной части отгрузки можно с помощью метода sale.shipmentitem.list

sale_payment_item_shipment

Целочисленный идентификатор привязки оплаты к отгрузке (например, 1). Получить идентификаторы привязок оплат к отгрузкам можно с помощью метода sale.paymentitemshipment.list

sale_payment_item_basket

Целочисленный идентификатор привязки элемента корзины к оплате (например, 1). Получить идентификаторы привязок оплат к отгрузкам можно с помощью метода sale.paymentitembasket.list

sale_status

Символьный идентификатор статуса (например, DN). Получить идентификаторы статусов можно с помощью метода sale.status.list

sale_status_lang

Объект, содержащий информацию о локализации статуса. Получить список объектов локализаций статусов можно с помощью метода sale.statuslang.list

sale_lang

Символьный идентификатор языка (например, ru). Получить идентификаторы языка можно с помощью метода sale.statuslang.getlistlangs

sale_person_type

Целочисленный идентификатор типа плательщика (например, 1). Получить идентификаторы типов плательщиков можно с помощью метода sale.persontype.list

sale_order_property

Целочисленный идентификатор свойства заказа (например, 1). Получить идентификатор свойств заказа можно с помощью метода sale.property.list

sale_shipment_property

Целочисленный идентификатор свойства отгрузки (например, 1). Получить идентификатор свойств заказа можно с помощью метода sale.shipmentproperty.list

sale_shipment_property_value

Целочисленный идентификатор значения свойства отгрузки (например, 1). Получить идентификатор значения свойства заказа можно с помощью метода sale.shipmentpropertyvalue.list

sale_order_property_group

Целочисленный идентификатор группы свойств (например, 1). Получить идентификаторы типов групп свойств можно с помощью метода sale.propertygroup.list

sale_order_property_value

Целочисленный идентификатор значения свойства заказа (например, 1). Получить идентификатор значения свойства заказа можно с помощью метода sale.propertyvalue.list

sale_order_property_variant

Целочисленный идентификатор варианта значения свойства (например, 1). Получить идентификаторы типов групп свойств можно с помощью метода sale.propertyvariant.list

sale_order_property_relation

Объект, содержащий информацию о привязке свойства. Получить список объектов привязки свойства можно с помощью метода sale.propertyRelation.list

sale_order_trade_platform

Целочисленный идентификатор источника заказов (например, 1). Получить идентификаторы источников заказов можно с помощью метода sale.tradePlatform.list

sale_order_trade_binding

Целочисленный идентификатор привязки источников заказов к заказам (например, 1). Получить идентификаторы привязок можно с помощью метода sale.tradeBinding.list

sale_order_payment

Целочисленный идентификатор оплаты (например, 1). Получить идентификаторы оплат можно с помощью метода sale.payment.list

sale_business_value_person_domain

Объект, содержащий информацию о соответствии между типом плательщика и физ. или юр. лицом. Получить список объектов соответствий можно с помощью метода sale.businessValuePersonDomain.list

sale_delivery_handler

Объект обработчика службы доставки.
Обработчик службы доставки — это шаблон, по которому в дальнейшем создаются конкретные службы доставки.
Получить идентификаторы обработчиков служб доставки можно с помощью метода sale.delivery.handler.list

sale_delivery_service

Объект службы доставки. Получить идентификаторы служб доставки можно с помощью метода sale.delivery.getlist

sale_delivery_extra_service

Объект дополнительной услуги службы доставки. Получить идентификаторы услуг службы доставки можно с помощью метода sale.delivery.extra.service.get

sale_paysystem_handler

Объект обработчика платежной системы. Получить идентификаторы обработчиков платежных систем можно с помощью метода sale.paysystem.handler.list

sale_paysystem

Объект платежной системы. Получить идентификаторы платежных систем можно с помощью метода sale.paysystem.list

sale_cashbox_handler

Объект обработчика кассы. Получить идентификаторы обработчиков кассы можно с помощью метода sale.cashbox.handler.list

sale_cashbox

Объект кассы. Получить идентификаторы кассы можно с помощью метода sale.cashbox.list

Значение
тип

Описание

id
string

Идентификатор элемента табличной части отгрузки

orderDeliveryId
sale_order_shipment.id

Идентификатор отгрузки

basketId
sale_basket_item.id

Идентификатор корзины

quantity
float

Количество товара

reservedQuantity
float

Зарезервированное количество товара

xmlId
string

Внешний идентификатор.

Можно использовать для синхронизации текущей товарной позиции доставки с аналогичной позицией во внешней системе

dateInsert
datetime

Дата добавления элемента табличной части отгрузки

Значение
тип

Описание

id
integer

Идентификатор элемента табличной части отгрузки

shipmentId
sale_order_shipment.id

Идентификатор отгрузки

paymentId
sale_order_payment.id

Идентификатор оплаты

xmlId
string

Внешний идентификатор записи

dateInsert
datetime

Дата добавления привязки оплаты к отгрузке

Значение
тип

Описание

id
integer

Идентификатор привязки элемента корзины к оплате

paymentId
sale_order_payment.id

Идентификатор оплаты

basketId
sale_basket_item.id

Идентификатор элемента корзины

quantity
double

Количество товара

xmlId
string

Внешний идентификатор записи

dateInsert
datetime

Дата добавления привязки элемента корзины к оплате

Значение
тип

Описание

id
string

Идентификатор отгрузки

dateInsert
datetime

Дата создания отгрузки

orderId
sale_order.id

Идентификатор заказа

accountNumber
string

Системный номер отгрузки

allowDelivery
string

Признак разрешения доставки.

Возможные значения:

• Y — да (доставка разрешена)
• N — нет (доставка не разрешена)

dateAllowDelivery
datetime

Дата изменения флага разрешения доставки

empAllowDeliveryId
user.id

Пользователь, который изменил значение флага разрешения доставки

deducted
string

Признак того, является ли отгрузка отгруженной.

Возможные значения:

• Y — да (отгружена)
• N — нет (не отгружена)

dateDeducted
datetime

Дата изменения флага отгруженности отгрузки

empDeductedId
user.id

Пользователь, который изменил значение флага отгруженности

reasonUndoDeducted
string

Устаревшее свойство

system
string

Признак того, является ли отгрузка системной.

Значение всегда N. Системную отгрузку не видно через REST и не с ней не предполагается работа напрямую.

Возможные значения:

• Y — да
• N — нет

deliveryId
sale_delivery_service.id

Идентификатор службы доставки

deliveryName
string

Название службы доставки

deliveryXmlId
string

Внешний идентификатор службы доставки

statusId
sale_status.id

Идентификатор статуса доставки

statusXmlId
string

Внешний идентификатор статуса доставки

canceled
string

Устаревший. Необходимо использовать статус отгрузки.

Признак того, является ли отгрузка отмененной.

Возможные значения:

• Y — да
• N — нет

dateCanceled
datetime

Устаревший.

Дата и время отмены отгрузки

empCanceledId
user.id

Устаревший.

Пользователь, который изменил значение флага отмененности отгрузки (canceled)

marked
string

Флаг маркировки. Признак того, является ли отгрузка отмеченной как проблемная.

Возможные значения:

• Y — да
• N — нет

dateMarked
datetime

Дата изменения флага маркировки

reasonMarked
string

Причина, по которой отгрузка была отмечена флагом маркировки

empMarkedId
user.id

Пользователь, который выставил флаг маркировки в значение Y

deliveryDocDate
datetime

Дата документа отгрузки

deliveryDocNum
string

Номер документа отгрузки

trackingNumber
string

Идентификатор отправления

trackingDescription
string

Описание статуса отправления

trackingLastCheck
datetime

Время последней проверки статуса отправления

trackingStatus
string

Статус отправления

currency
string

Валюта отгрузки

customPriceDelivery
string

Признак кастомной стоимости доставки.

К примеру, служба доставки автоматически рассчитала стоимость в 500 рублей, но менеджер вручную выставил стоимость в 200 рублей. В этом случае, признак кастомной стоимости доставки будет автоматически выставлен в значение Y.

Возможные значения:

• Y — да
• N — нет

basePriceDelivery
double

Базовая стоимость доставки (без скидок/наценок).

priceDelivery
double

Стоимость доставки

discountPrice
double

Скидка на доставку

comments
string

Комментарий менеджера

companyId
integer

Идентификатор компании из модуля «Интернет-магазин». Не используется в облачной версии

responsibleId
user.id

Идентификатор пользователя, ответственного за отгрузку

dateResponsibleId
datetime

Дата изменения ответственного за отгрузку

empResponsibleId
user.id

Пользователь, который назначил ответственного

xmlId
string

Внешний идентификатор отгрузки.

Можно использовать для синхронизации отгрузки с внешней системой

externalDelivery
string

Признак того, является ли отгрузка загруженной из внешней системы (например, 1С)

Возможные значения:

• Y — да
• N — нет

id1c
string

Идентификатор отгрузки в 1С

updated1c
string

Признак того, что данная отгрузка была синхронизирована (обновлена) с 1С

version1c
string

Версия 1С (если отгрузка была обновлена из 1С)

shipmentItems
sale_order_shipment_item[]

Массив, содержащий элементы табличной части отгрузки

Значение
тип

Описание

id
string

Символьный идентификатор статуса

type
string

Тип статуса:

• O — статус заказа
• D — статус доставки

notify
string

Индикатор необходимости отправки почтового уведомления пользователю при переходе сущности (заказ или доставка) в этот статус:

• Y — оповещать
• N — не оповещать

color
string

HEX код цвета статуса (например, #FF0000)

sort
integer

Сортировка

xmlId
string

Внешний идентификатор статуса

Значение
тип

Описание

statusId
sale_status.id

Символьный идентификатор статуса

lid
sale_lang.lid

Идентификатор языка

name
string

Название статуса

description
string

Описание статуса

Значение
тип

Описание

active
string

Индикатор активности языка

• Y — активен
• N — неактивен

lid
string

Символьный идентификатор языка

name
string

Название языка

Значение
тип

Описание

id
integer

Идентификатор свойства заказа

personTypeId
sale_person_type.id

Идентификатор типа плательщика

propsGroupId
sale_order_property_group.id

Идентификатор группы свойств

name
string

Название свойства заказа

type
string

Тип свойства заказа.

Возможные значения:

• STRING
• Y/N
• NUMBER
• ENUM
• FILE
• DATE
• LOCATION
• ADDRESS

code
string

Символьный код свойства заказа

active
string

Индикатор активности свойства заказа.

Возможные значения:

• Y — да
• N — нет

util
string

Индикатор того, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части.

Возможные значения:

• Y — да
• N — нет

userProps
string

Индикатор того, входит ли свойство заказа в профиль покупателя.

Возможные значения:

• Y — да
• N — нет

isFiltered
string

Индикатор того, доступно ли свойство заказа в фильтре на странице списка заказов.

Возможные значения:

• Y — да
• N — нет

sort
integer

Сортировка

description
string

Описание свойства заказа

required
string

Индикатор обязательности заполнения значения свойства заказа.

Возможные значения:

• Y — да
• N — нет

multiple
string

Индикатор того, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений.

Возможные значения:

• Y — да
• N — нет

xmlId
string

Внешний идентификатор свойства заказа

defaultValue
string|number|string[]|number[]

Дефолтное значение свойства заказа.

Для множественных свойств заказа (multiple) поддерживается передача массива значений

settings
object

См. описание параметра settings метода sale.property.add

isProfileName
string

Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isPayer
string

Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isEmail
string

Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа).

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isPhone
string

Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isZip
string

Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isAddress
string

Индикатор необходимости использования значения данного свойства заказа в качестве адреса.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа STRING

isLocation
string

Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа LOCATION

isLocation4tax
string

Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа LOCATION

inputFieldLocation
string

Устаревшее поле. Не используется.

Актуально только для свойств заказа типа LOCATION

isAddressFrom
string

Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя откуда необходимо забрать заказ для расчета стоимости доставки.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа ADDRESS

isAddressTo
string

Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя куда необходимо доставить заказ для расчета стоимости доставки.

Возможные значения:

• Y — да
• N — нет

Актуально только для свойств заказа типа ADDRESS

Значение
тип

Описание

id
integer

Идентификатор значения свойства

name
string

Название свойства

shipmentId
sale_order_shipment.id

Идентификатор отгрузки

code
string

Символьный код свойства

value
string
sale_order_property_value_file_value

Значение свойства

shipmentPropsId
sale_shipment_property.id

Идентификатор свойства

shipmentPropsXmlId
string

Внешний идентификатор свойства отгрузки

Значение
тип

Описание

id
integer

Идентификатор значения свойства

name
string

Название свойства

orderId
sale_order.id

Идентификатор заказа

code
string

Символьный код свойства

value
string
sale_order_property_value_file_value

Значение свойства

orderPropsId
sale_order_property.id

Идентификатор свойства

orderPropsXmlId
string

Внешний идентификатор свойства заказа

Значение
тип

Описание

id
string

Идентификатор файла

contentType
string

MIME тип файла

description
string

Описание файла

externalId
string

Внешний идентификатор файла

fileName
string

Название файла

fileSize
integer

Размер файла в байтах

moduleId
string

Принадлежность к модулю

originalName
string

Оригинальное название файла

src
string

Полный путь к файлу на сервере

subdir
string

Подкаталог в котором находится файл на диске

timestampX
string

Дата изменения записи файла

versionOriginalId
string

Версия файла

width
string

Ширина изображения в пикселях (актуально только для файлов изображений)

height
string

Высота изображения в пикселях (актуально только для файлов изображений)

Значение
тип

Описание

id
integer

Идентификатор варианта значения свойства

name
string

Название варианта значения свойства

value
string

Код варианта значения свойства

orderPropsId
sale_order_property.id

Идентификатор свойства

description
string

Описание варианта значения свойства

sort
integer

Сортировка

Значение
тип

Описание

id
integer

Идентификатор группы свойств

name
string

Название группы свойств

personTypeId
sale_person_type.id

Идентификатор типа плательщика

sort
integer

Сортировка

Значение
тип

Описание

entityId
integer

Идентификатор сущности

entityType
string

Тип сущности:

• P — платежная система
• D — доставка
• L — лендинг
• T — источник заказа

propertyId
sale_order_property.id

Идентификатор свойства

Значение
тип

Описание

id
integer

Идентификатор типа плательщика

name
string

Название типа плательщика

code
string

Код типа плательщика

sort
string

Сортировка

active
string

Индикатор активности типа плательщика:

• Y — активен
• N — неактивен

xmlId
string

Внешний идентификатор.

Можно использовать для синхронизации текущего типа плательщика с аналогичной позицией во внешней системе

Значение
тип

Описание

personTypeId
sale_person_type.id

Идентификатор типа плательщика

domain
string

Значение, которому соответствует тип плательщика: физическое лицо или юридическое лицо.

• I — физическое лицо
• E — юридическое лицо

Эта опция нужна для работы механизма бизнес-смыслов

Значение
тип

Описание

id
integer

Идентификатор заказа

lid
string

Идентификатор сайта, на котором будет использоваться данный тип плательщика. Имеет постоянное значение s1

dateInsert
datetime

Дата создания заказа

dateUpdate
datetime

Дата обновления заказа

personTypeId
sale_person_type.id

Идентификатор типа плательщика

personTypeXmlId
string

Внешний идентификатор типа плательщика

statusId
sale_status.id

Идентификатор статуса

empStatusId
user.id

Идентификатор пользователя, изменившего статус заказа

dateStatus
datetime

Дата изменения статуса

marked
string

Флаг маркировки. Признак того, является ли отгрузка отмеченной как проблемная. Значение Y ставится автоматически, если при сохранении произошла ошибка.

• Y — да
• N — нет

dateMarked
datetime

Дата маркировки заказа

empMarkedId
user.id

Идентификатор пользователя, поставившего маркировку

reasonMarked
string

Причина, по которой заказ был промаркирован

price
double

Цена

discountValue
double

Значение скидки

taxValue
double

Ставка налога на заказ

userDescription
string

Комментарий покупателя к заказу

additionalInfo
string

Устаревший. Дополнительная информация

comments
string

Комментарий менеджера к заказу

responsibleId
user.id

Идентификатор пользователя, ответственного за заказ

recurringId
integer

Идентификатор продления подписки

lockedBy
user.id

Актуально только для коробочной версии.

Идентификатор пользователя, заблокировавшего заказ. Заказ блокируется в административной панели, когда пользователь открывает детальную карточку заказа

dateLock
datetime

Дата блокировки

recountFlag
string

Устаревший. Флаг пересчёта:

• Y — да
• N — нет

affiliateId
integer

Актуально только для коробочной версии. Идентификатор аффилиата

updated1c
string

Обновлен ли заказ через 1С:

• Y — да
• N — нет

orderTopic
string

Устаревший. Тема заказа

xmlId
string

Внешний идентификатор

statusXmlId
string

Внешний идентификатор статуса

id1c
string

Идентификатор в 1С

version
integer

Версия документа

version1c
string

Версия в 1С

externalOrder
string

Заказ из внешней системы или нет

• Y — да
• N — нет

canceled
string

Был ли отменен заказ:

• Y — да
• N — нет

dateCanceled
datetime

Дата отмены

empCanceledId
user.id

Идентификатор пользователя, отменившего заказ

reasonCanceled
string

Причина отмены

userId
user.id

Идентификатор клиента

currency
string

Валюта. Список валют можно получить через метод crm.currency.list

accountNumber
string

Номер заказа

payed
string

Заказ оплачен:

• Y — да
• N — нет

deducted
string

Устаревший. Отгружен ли заказ:

• Y — да
• N — нет

basketItems
sale_basket_item[]

Элементы корзины заказа

clients
sale_order_crm_client[]
Массив из контактов и компаний заказа модуля CRM

Массив объектов, содержащий информацию о привязках заказа к клиентам модуля CRM

payments
sale_order_payment[]

Оплаты заказа

shipments
sale_order_shipment[]

Отгрузки заказа

propertyValues
sale_order_property[]

Свойства заказа

requisiteLink
Массив из связей реквизитов модуля CRM

Связи реквизитов с заказом. Список связей реквизитов с CRM сущностями можно получить через метод crm.requisite.link.list, где для заказа entity_type_id = 14

tradeBindings
sale_order_trade_binding[]

Источники заказа

Значение
тип

Описание

id
integer

Идентификатор привязки

entityId
integer

Идентификатор объекта CRM

entityTypeId
integer

Идентификатор типа объекта CRM

isPrimary
string

Индикатор того, является ли клиент главным.

Возможные значения:

• Y - да
• N - нет

orderId
sale_order.id

Идентификатор заказа

roleId
integer

Устаревшее

sort
integer

Сортировка

Значение
тип

Описание

id
integer

Идентификатор оплаты

orderId
sale_order.id

Идентификатор заказа

paySystemXmlId
string

Внешний идентификатор платежной системы

paySystemIsCash
string

Является ли платежная система наличным расчетом:

• Y — да
• N — нет

accountNumber
string

Системный номер оплаты

paid
string

Внесена ли оплата:

• Y — да
• N — нет

datePaid
datetime

Дата оплаты

empPaidId
user.id

Пользователь, который внес оплату

paySystemId
sale_paysystem.id

Идентификатор платежной системы

psStatus
string

Статус транзакции платежной системы — успешно ли оплачен заказ (для платежных систем, которые позволяют автоматически получать данные по проведенным через них заказам):

• Y — да
• N — нет

psStatusCode
string

Код статуса транзакции платежной системы

psStatusDescription
string

Описание статуса транзакции платежной системы

psStatusMessage
string

Сообщение статуса транзакции платежной системы

psSum
double

Сумма транзакции платежной системы

psCurrency
string

Валюта платежной системы

psResponseDate
datetime

Дата ответа платежной системы

payVoucherNum
string

Номер платежного документа

payVoucherDate
date

Дата платежного документа

datePayBefore
datetime

Дата, по которой необходимо оплатить счет (в магазине не используется)

dateBill
datetime

Дата выставления счета

xmlId
string

Внешний идентификатор

sum
double

Сумма оплаты

currency
string

Валюта оплаты

paySystemName
string

Наименование платежной системы

companyId
integer

Идентификатор компании, которая будет принимать оплату

payReturnNum
string

Номер документа возврата

priceCod
double

Стоимость оплаты при доставке (используется, например, для наложенного платежа)

payReturnDate
date

Дата документа возврата

empReturnId
user.id

Идентификатор пользователя, который выполнил возврат

payReturnComment
string

Комментарий к возврату

responsibleId
user.id

Идентификатор пользователя, ответственного за оплату

empResponsibleId
user.id

Идентификатор пользователя, назначившего ответственного

dateResponsibleId
datetime

Дата назначения ответственного

isReturn
string

Выполнялся ли возврат:

• Y — да
• N — нет

comments
string

Комментарии к оплате

updated1c
string

Была ли оплата обновлена через 1С:

• Y — да
• N — нет

id1c
string

Идентификатор в 1С

version1c
string

Версия документа оплаты от 1С

externalPayment
string

Является ли оплата внешней:

• Y — да
• N — нет

psInvoiceId
string

Идентификатор оплаты в платежной системе

marked
string

Флаг маркировки. Признак того, является ли оплата отмеченной как проблемная:

• Y — да
• N — нет

reasonMarked
string

Причина маркировки

dateMarked
datetime

Дата маркировки заказа

empMarkedId
user.id

Идентификатор пользователя, промаркировавшего оплату

Значение
тип

Описание

id
integer

Идентификатор элемента корзины

orderId
sale_order.id

Идентификатор заказа

sort
integer

Положение в списке позиций заказа

productId
integer

Идентификатор товара. Для товаров, отсутствующих на сайте, равен нулю

price
double

Цена товара с учетом скидок и наценок

customPrice
string

Указана ли цена вручную:

• Y — да
• N — нет

currency
string

Валюта цены. Должна совпадать с валютой заказа. Список валют можно получить методом crm.currency.list, подробную информацию о валюте — методом crm.currency.get

quantity
double

Количество

xmlId
string

Внешний код позиции корзины.
Если не указывать, то сгенерируется автоматически.
Используется для синхронизации с внешними системами (например, 1С)

dateInsert
datetime

Дата добавления элемента корзины

dateUpdate
datetime

Дата обновления элемента корзины

properties
sale_basket_item_property[]

Свойства элемента корзины

name
string

Название товара

basePrice
double

Цена товара без учета скидок и наценок

Всегда должно выполняться правило: basePrice = price + discountPrice

discountPrice
double

Величина итоговой скидки/наценки. Для наценки значение отрицательное

weight
double

Вес в груммах.
Для коробочных версий единица изменения веса указывается в настройках модуля Интернет-магазин (sale)

dimensions
string

Размеры товара в миллиметрах.

Поле либо пустое, либо содержит сериализованный массив с ключами:

• WIDTH — ширина
• HEIGHT — высота
• LENGTH — длина

measureCode
string

Код единицы измерения

measureName
string

Название единицы измерения

canBuy
string

Доступен ли товар к покупке:

• Y — да
• N — нет

vatRate
double

Величина налога в процентах. Может быть равна null («Без НДС» — в случае, когда используются ставки НДС)

vatIncluded
string

Включен ли налог в цену:

• Y — да
• N — нет

barcodeMulti
string

Поле доступно только при включенном складском учете. Является ли штрихкод уникальным:

• Y — да
• N — нет

Имеет смысл только для включенного складского учета. Для товаров из каталога категорически не рекомендуется заполнять это поле вручную

type
integer

Тип позиции. Не соответствует типу товара в каталоге. Возможные значения:

• 1 — комплект
• 2 — услуга
• null — любой другой

Категорически не рекомендуется задавать самостоятельно

catalogXmlId
string

Внешний идентификатор каталога.

Используется для синхронизации с внешними системами (например, 1С)

productXmlId
string

Внешний идентификатор товара.

Используется для синхронизации с внешними системами (например, 1С)

reservations
sale_basket_item_reservation[]

Резервы элемента корзины

Значение
тип

Описание

id
integer

Идентификатор свойства элемента корзины

basketId
sale_basket_item.id

Идентификатор элемента корзины

name
string

Название свойства

value
string

Значение свойства

code
string

Код свойства

sort
integer

Порядок сортировки

xmlId
string

Внешний идентификатор

Значение
тип

Описание

id
integer

Идентификатор источника заказа

code
string

Код источника заказа

active
string

Активен ли источник заказа

• Y — да
• N — нет

name
string

Название источника заказа

description
string

Описание источника заказа

settings
string

Настройки источника заказа в сериализованном виде

catalogSectionTabClassName
string

Класс для обработки закладки в настройках раздела каталога

class
string

Класс источника заказа

xmlId
string

Внешний идентификатор

Значение
тип

Описание

id
integer

Идентификатор привязки

xmlId
string

Внешний идентификатор привязки

externalOrderId
string

Номер заказа во внешней системе

orderId
sale_order.id

Идентификатор заказа

tradingPlatformId
sale_order_trade_platform.id

Идентификатор источника заказа

tradingPlatformXmlId
string

Внешний идентификатор источника заказа

params
string

Параметры в сериализованном виде

Значение
тип

Описание

id
integer

Идентификатор резерва

basketId
sale_basket_item.id

Идентификатор элемента корзины резерва

storeId
integer

Идентификатор склада

quantity
double

Количество

dateReserve
datetime

Дата резервирования

dateReserveEnd
datetime

Дата окончания резервирования

reservedBy
user.id

Идентификатор пользователя, добавившего резерв

Значение
тип

Описание

ID
integer

Идентификатор обработчика службы доставки.

Получить идентификаторы обработчиков служб доставки можно с помощью метода sale.delivery.handler.list

NAME
string

Название обработчика службы доставки

CODE
string

Символьный код обработчика службы доставки

SORT
integer

Сортировка

DESCRIPTION
string

Описание обработчика службы доставки

SETTINGS
sale_delivery_handler_settings

Объект, содержащий информацию о настройках службы доставки

PROFILES
sale_delivery_handler_profile[]

Массив, содержащий список объектов профилей доставки

Значение
тип

Описание

CALCULATE_URL
string

URL для расчёта стоимости доставки.

На данный URL приходят данные о посылке (что доставить, куда и как), стоимость доставки которой нужно рассчитать в ответе.

Формат запроса и ответа детально описан в документации по вебхуку Расчет стоимости доставки

CREATE_DELIVERY_REQUEST_URL
string

URL для создания заказа на доставку.

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно оформить в службе доставки.

Формат запроса и ответа детально описан в документации по вебхуку Создание заказа на доставку

CANCEL_DELIVERY_REQUEST_URL
string

URL для отмены заказа на доставку.

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно отменить в службе доставки.

Формат запроса и ответа детально описан в документации по вебхуку Отмена заказа на доставку

HAS_CALLBACK_TRACKING_SUPPORT
string

Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод sale.delivery.request.sendmessage).

В случае, если поддержка событий указана, то в интерфейсе менеджера при заказе доставки будет создано дело на доставку, в которое могут транслироваться изменения, связанные с текущим статусом доставки.

Возможные значения:

Y — есть поддержка
N — нет поддержки

CONFIG
sale_delivery_handler_settings_config_item[]

Массив объектов с доступными настройками для службы доставки, создаваемой с использованием данного обработчика

Значение
тип

Описание

TYPE
string

Тип поля настройки.

Возможные значения:

STRING — строка
Y/N — чекбокс (да / нет)
NUMBER — число
ENUM — список
DATE — дата
LOCATION — местоположение

CODE
string

Символьный код настройки

NAME
string

Название настройки

OPTIONS
object

Список опций для выбора. Объект в формате ключ=значение. Где ключ — код опции, а значение — опции.

Пример:

{
            "Option1Code": "Option1Value",
            "Option2Code": "Option2Value",
            "Option3Code": "Option3Value"
        }
        

Параметр актуален только для настройки типа ENUM

Значение
тип

Описание

NAME
string

Название профиля обработчика службы доставки

CODE
string

Символьный код профиля обработчика службы доставки

DESCRIPTION
string

Описание профиля обработчика службы доставки

Значение
тип

Описание

ID
integer

Идентификатор службы доставки.

Получить идентификаторы служб доставки можно с помощью метода sale.delivery.getlist

PARENT_ID
integer

Идентификатор родительской службы доставки.

Получить идентификаторы служб доставки можно с помощью метода sale.delivery.getlist

NAME
string

Название службы доставки

CURRENCY
string

Символьный код валюты службы доставки

DESCRIPTION
string

Описание службы доставки

SORT
integer

Сортировка

ACTIVE
string

Индикатор активности службы доставки.

Возможные значения:

Y — активна
N — неактивна

Значение
тип

Описание

CODE
string

Символьный код настройки

VALUE
any

Значение настройки

Значение
тип

Описание

ID
integer

Идентификатор дополнительной услуги службы доставки.

Получить идентификаторы услуг службы доставки можно с помощью метода sale.delivery.extra.service.get

TYPE
string

Тип услуги.

Возможные значения:

enum — список (выбор опции из заранее сформированного списка)
checkbox — единичная услуга (например, доставка до двери)
quantity — количественная услуга (например, требуемое количество грузчиков)

NAME
string

Название услуги

ACTIVE
string

Индикатор активности услуги.

Возможные значения:
Y — активна
N — неактивна

CODE
string

Символьный код услуги

SORT
integer

Сортировка

DESCRIPTION
string

Описание услуги

PRICE
double

Поле актуально только для услуг типа единичная услуга (checkbox) и количественная услуга (quantity)

ITEMS
sale_delivery_extra_service_enum_item[]

Список доступных для выбора опций.

Поле актуально только для услуг типа список (enum)

Значение
тип

Описание

TITLE
string

Название опции списка

CODE
string

Символьный код опции списка

PRICE
double

Стоимость услуги при выборе данной опции в валюте службы доставки

Значение
тип

Описание

ID
string

Идентификатор обработчика платежной системы

NAME
string

Название обработчика

CODE
string

Код обработчика

SORT
string

Сортировка

SETTINGS
object

Настройки обработчика. Структура сооветствует указанной при добавлении обработчика через sale.paysystem.handler.add в параметре SETTINGS

Значение
тип

Описание

ID
string

Идентификатор платежной системы

NAME
string

Название платежной системы

DESCRIPTION
string

Описание платежной системы

XML_ID
string

Символьный код

PERSON_TYPE_ID
sale_person_type.id

Идентификатор типа плательщика

ACTION_FILE
string

Для платежных систем REST это код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add.

Для системных платежных систем это код системного обработчика платежной системы

ACTIVE
string

Активна ли платежная система. Доступные значения:

• Y — да
• N — нет

ENTITY_REGISTRY_TYPE
string

Привязка платежной системы:

• ORDER — значение для заказов магазина, сделок, смарт-процессов
• CRM_INVOICE — значение для счетов CRM
• CRM_QUOTE — значение для коммерческих предложений CRM

NEW_WINDOW
string

Флаг, отвечающий за настройку «Открывать в новом окне». Доступные значения:

• Y — да
• N — нет

ALLOW_EDIT_PAYMENT
string

Флаг, отвечающий за настройку «Разрешить автопересчет оплаты». Доступные значения:

• Y — да
• N — нет

AUTO_CHANGE_1C
string

Флаг, отвечающий за настройку «Разрешить автоматическое изменение оплаты при импорте из 1С». Доступные значения:

• Y — да
• N — нет

CAN_PRINT_CHECK
string

Флаг, отвечающий за настройку «Разрешить печать чеков». Доступные значения:

• Y — да
• N — нет

ENCODING
string

Настройка «Кодировка». Доступные значения: windows-1251, utf-8, iso-8859-1.

Для REST-обработчиков не используется

IS_CASH
string

Тип оплаты. Возможные значения:

• N — безналичный
• Y — наличный
• A — эквайринговая операция

PSA_NAME
string

Заголовок платежной системы

PS_MODE
string

Режим работы платежной системы для обработчиков, поддерживающих несколько режимов работы

SORT
string

Сортировка

TARIFF
string

Не используется

Значение
тип

Описание

ID
string

Идентификатор обработчика кассы

NAME
string

Название обработчика

CODE
string

Код обработчика

SORT
string

Сортировка

SETTINGS
object

Настройки обработчика. Структура сооветствует указанной при добавлении обработчика через sale.cashbox.handler.add в параметре SETTINGS

Значение
тип

Описание

ID
string

Идентификатор обработчика платежной системы

NAME
string

Название кассы

ENABLED
string

Доступность кассы. Возможные значения:

• Y — да
• N — нет

ACTIVE
string

Активность кассы. Возможные значения:

• Y — да
• N — нет

OFD
string

Код обработчика ОФД. Доступные обработчики ОФД:

• bx_firstofd — Первый ОФД
• bx_platformaofd — Платформа ОФД
• bx_yarusofd — ОФД ЯРУС
• bx_taxcomofd — Такском ОФД
• bx_ofdruofd — OFD.RU
• bx_tenzorofd — Тензор ОФД
• bx_conturofd — Контур ОФД

EMAIL
string

Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков

KKM_ID
string

Марка ККМ

SORT
string

Сортировка

USE_OFFLINE
string

Используется ли касса офлайн. Возможные значения:

• Y — да
• N — нет

Значение
тип

Описание

isImmutable
boolean

Индикатор возможности изменения значения поля после создания.

Если у поля выставлен данный индикатор, то при создании сущности можно указать значение поля, но изменить его при обновлении не получится

isReadOnly
boolean

Индикатор «только чтение».

Если у поля выставлен данный индикатор, то в операциях добавления и обновления сущности передавать значение поля не нужно. Значение формируется автоматически и предназначено только для чтения

isRequired
boolean

Индикатор обязательности поля для операций добавления или обновления

type
string

Тип данных значений поля. Возможные значения:

• integer
• double
• string
• char
• list
• text
• file
• date
• datetime
• datatype
• productproperty