Объект/Поле Метод Код поля в истории Примечание
#

Валюта Currency
code getCode() Код валюты
#

Каталог Catalog
mainSite getMainSite() Основной магазин каталога
Магазин
#

Компания Company
externalId getExternalId() company.external_id Внешний ID компании
active getActive() company.active Активность
name getName() company.name Наименование
brand getBrand() company.brand Бренд
site getSite() company.site Сайт компании
contragent getContragent() В истории фиксируются поля связной сущности Реквизиты
Контрагент
address getAddress() company.address
В истории также фиксируются поля связной сущности 		Адрес
Адрес клиента
avgMarginSumm getAvgMarginSumm() Средняя валовая прибыль по заказам клиента (в базовой валюте)
totalSumm getTotalSumm() Общая сумма заказов (в базовой валюте)
averageSumm getAverageSumm() Средняя сумма заказа (в базовой валюте)
ordersCount getOrdersCount() Количество заказов
marginSumm getMarginSumm() LTV (в базовой валюте)
customFields getCustomFields() Ассоциативный массив пользовательских полей
customField getCustomField(string code) Возвращает значение пользовательского поля. В code указывается символьный код поля.
#

Контрагент CompanyContragent
contragentType getContragentType() company.contragent.contragent_type Тип контрагента (может принимать 2 значения: legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель)
legalName getLegalName() company.contragent.legal_name Полное наименование
legalAddress getLegalAddress() company.contragent.legal_address Адрес регистрации
INN getINN() company.contragent.i_n_n ИНН
OKPO getOKPO() company.contragent.o_k_p_o ОКПО
KPP getKPP() company.contragent.k_p_p КПП
OGRN getOGRN() company.contragent.o_g_r_n ОГРН
OGRNIP getOGRNIP() company.contragent.o_g_r_n_i_p ОГРНИП
certificateNumber getCertificateNumber() company.contragent.certificate_number Номер свидетельства
certificateDate getCertificateDate() company.contragent.certificate_date Дата свидетельства
BIK getBIK() company.contragent.b_i_k БИК
bank getBank() company.contragent.bank Банк
bankAddress getBankAddress() company.contragent.bank_address Адрес банка
corrAccount getCorrAccount() company.contragent.corr_account Корр. счёт
bankAccount getBankAccount() company.contragent.bank_account Расчётный счёт
#

Клиент Customer
typeCode getTypeCode() Тип клиента (customer - клиент, customer_corporate - корпоративный клиент)
firstName getFirstName() first_name Имя
lastName getLastName() last_name Фамилия
patronymic getPatronymic() patronymic Отчество
nickName getNickName() ФИО
sexCode getSexCode() Пол ("male", "female" или null)
presumableSexCode getPresumableSexCode() Предположительный пол на основе ФИО
email getEmail() email E-mail
anyEmail getAnyEmail() Любой найденный e-mail
birthday getBirthday() birthday День рождения
source getSource() source Источник клиента
Источник
phones getPhones() phones Телефоны
[массив] Телефоны клиента
lastPhone getLastPhone() Последний указанный телефон
Телефоны клиента
phone getPhone() Телефон
anyPhone getAnyPhone() Любой найденный телефон
customerSubscriptions getCustomerSubscriptions() customer_subscription
В истории также фиксируются поля связной сущности 		Подписки
[массив] Подписка клиента
mgCustomers getMgCustomers() Клиенты MessageGateway
[массив] MessageGateway клиент
address getAddress() В истории фиксируются поля связной сущности Адрес клиента
Адрес клиента
commentary getCommentary() commentary deprecated Комментарий
segments getSegments() [массив] Сегменты
[массив] Сегмент
loyaltyAccountBySiteCode getLoyaltyAccountBySiteCode(string siteCode) В истории фиксируются поля связной сущности Участие в ПЛ клиента по коду сайта
Участие в программе лояльности
contragent getContragent() В истории фиксируются поля связной сущности deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
Контрагент
id getId() id ID клиента
createdAt getCreatedAt() Создан
customerContacts getCustomerContacts() Контактные лица
[массив] Контактное лицо
addresses getAddresses() address
В истории также фиксируются поля связной сущности 		Адреса клиента
[массив] Адрес клиента
mainAddress getMainAddress(bool getNewAddressOnNull = false) main_address
В истории также фиксируются поля связной сущности 		Основной адрес клиента
Адрес клиента
site getSite() site Магазин, с которого пришел клиент
Магазин
manager getManager() manager Менеджер клиента
Пользователь
vip getVip() vip Важный клиент
bad getBad() bad Плохой клиент
externalId getExternalId() external_id Внешний ID клиента
emailMarketingUnsubscribedAt getEmailMarketingUnsubscribedAt() deprecated Дата отписки от email рассылок
notes getNotes() notes Заметки
[массив] Заметка
mainCustomerContact getMainCustomerContact() Основное контактное лицо
Контактное лицо
avgSecondsBetweenOrders getAvgSecondsBetweenOrders() Среднее время между заказами, в секундах
firstOrder getFirstOrder() Первый неотмененный заказ клиента
Заказ
lastOrder getLastOrder() Последний неотмененный заказ клиента
Заказ
monetaryValue getMonetaryValue() Расчетное значение Monetary в RFM
recencyValue getRecencyValue() Расчетное значение Recency в RFM
monetaryClass getMonetaryClass() Monetary-сегмент в RFM
frequencyClass getFrequencyClass() Frequency-сегмент в RFM
recencyClass getRecencyClass() Recency-сегмент в RFM
hasTag hasTag(string name) Проверить есть ли тег у объекта
tags getTags() [массив] Теги
[массив] Тег
attachments getAttachments() Прикрепленные объекты (вложения)
[массив] Прикрепленный объект (вложение)
firstWebVisit getFirstWebVisit() Первый визит клиента на сайт
Визит клиента на сайт
lastWebVisit getLastWebVisit() Последний визит клиента на сайт
Визит клиента на сайт
clientIds getClientIds() Уникальные метки Google Analytics
[массив] Уникальная метка Google Analytics
utma getUtma() deprecated Уникальные метки Google Analytics
[массив] Уникальная метка Google Analytics
firstClientId getFirstClientId() Первая метка клиента Google Analytics
lastClientId getLastClientId() Последняя метка клиента Google Analytics
customFields getCustomFields() Ассоциативный массив пользовательских полей
customField getCustomField(string code) Возвращает значение пользовательского поля. В code указывается символьный код поля.
cumulativeDiscount getCumulativeDiscount() cumulative_discount deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
personalDiscount getPersonalDiscount() personal_discount Персональная скидка
discountCardNumber getDiscountCardNumber() discount_card_number Номер дисконтной карты
totalSumm getTotalSumm() Общая сумма заказов (в базовой валюте)
averageSumm getAverageSumm() Средняя сумма заказа (в базовой валюте)
ordersCount getOrdersCount() Количество заказов
avgMarginSumm getAvgMarginSumm() Средняя валовая прибыль по заказам клиента (в базовой валюте)
marginSumm getMarginSumm() LTV (в базовой валюте)
maturationTime getMaturationTime() Время «созревания», в секундах
#

Адрес клиента CustomerAddress
name getName() address.name Наменование адреса
index getIndex() address.index Индекс
country getCountry() address.country Страна
region getRegion() address.region Регион
city getCity(bool withType = true) address.city Город (Если withType = true, город будет выведен вместе с типом населенного пункта)
cityType getCityType() Тип населенного пункта
street getStreet(bool withType = true) address.street Улица (Если withType = true, улица будет выведена вместе с типом)
streetType getStreetType() Тип улицы
building getBuilding() address.building Дом
house getHouse() address.house Строение
housing getHousing() address.housing Корпус
block getBlock() address.block Подъезд
flat getFlat() address.flat Номер квартиры/офиса
floor getFloor() address.floor Этаж
metro getMetro() address.metro Метро
text getText() Адрес в текстовом виде
notes getNotes() address.notes Примечания к адресу
isEmpty isEmpty() Адрес пустой
fullAddressString getFullAddressString(bool withIndex = true, bool getAnyForm = false) Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
#

Контактное лицо CustomerContact
id getId() contact.id ID контакта
customerContactCompanies getCustomerContactCompanies() contact.contact_company
В истории также фиксируются поля связной сущности 		Компании контактного лица
[массив] Компания контактного лица
#

Компания контактного лица CustomerContactCompany
id getId() contact.contact_company.id ID компании
company getCompany() contact.contact_company.company
В истории также фиксируются поля связной сущности 		Компания
Компания
#

Контрагент CustomerContragent
contragentType getContragentType() contragent.contragent_type Тип контрагента (может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель)
legalName getLegalName() contragent.legal_name Полное наименование
legalAddress getLegalAddress() contragent.legal_address Адрес регистрации
INN getINN() contragent.i_n_n ИНН
OKPO getOKPO() contragent.o_k_p_o ОКПО
KPP getKPP() contragent.k_p_p КПП
OGRN getOGRN() contragent.o_g_r_n ОГРН
OGRNIP getOGRNIP() contragent.o_g_r_n_i_p ОГРНИП
certificateNumber getCertificateNumber() contragent.certificate_number Номер свидетельства
certificateDate getCertificateDate() contragent.certificate_date Дата свидетельства
BIK getBIK() contragent.b_i_k БИК
bank getBank() contragent.bank Банк
bankAddress getBankAddress() contragent.bank_address Адрес банка
corrAccount getCorrAccount() contragent.corr_account Корр. счёт
bankAccount getBankAccount() contragent.bank_account Расчётный счёт
#

Корпоративный клиент CustomerCorporate
typeCode getTypeCode() Тип клиента (customer - клиент, customer_corporate - корпоративный клиент)
mainCustomerContact getMainCustomerContact() main_contact
В истории также фиксируются поля связной сущности 		Основное контактное лицо
Контактное лицо
companies getCompanies() company
В истории также фиксируются поля связной сущности 		Компании
[массив] Компания
mainCompany getMainCompany(bool getNewCompanyOnNull = false) main_company
В истории также фиксируются поля связной сущности 		Основная компания
Компания
phones getPhones() phones Телефоны корпоративного клиента
[массив] Телефоны клиента
id getId() id ID корпоративного клиента
createdAt getCreatedAt() Создан
customerContacts getCustomerContacts() contact
В истории также фиксируются поля связной сущности 		Контактные лица
[массив] Контактное лицо
addresses getAddresses() address
В истории также фиксируются поля связной сущности 		Адреса корпоративного клиента
[массив] Адрес клиента
mainAddress getMainAddress(bool getNewAddressOnNull = false) main_address
В истории также фиксируются поля связной сущности 		Основной адрес корпоративного клиента
Адрес клиента
site getSite() site Магазин, с которого пришел клиент
Магазин
manager getManager() manager Менеджер корпоративного клиента
Пользователь
vip getVip() vip Важный клиент
bad getBad() bad Плохой клиент
externalId getExternalId() external_id Внешний ID корпоративного клиента
nickName getNickName() nick_name Наименование
emailMarketingUnsubscribedAt getEmailMarketingUnsubscribedAt() deprecated Дата отписки от email рассылок
notes getNotes() notes Заметки
[массив] Заметка
avgSecondsBetweenOrders getAvgSecondsBetweenOrders() Среднее время между заказами, в секундах
firstOrder getFirstOrder() Первый неотмененный заказ корпоративного клиента
Заказ
lastOrder getLastOrder() Последний неотмененный заказ корпоративного клиента
Заказ
monetaryValue getMonetaryValue() Расчетное значение Monetary в RFM
recencyValue getRecencyValue() Расчетное значение Recency в RFM
monetaryClass getMonetaryClass() Monetary-сегмент в RFM
frequencyClass getFrequencyClass() Frequency-сегмент в RFM
recencyClass getRecencyClass() Recency-сегмент в RFM
hasTag hasTag(string name) Проверить есть ли тег у объекта
tags getTags() [массив] Теги
[массив] Тег
attachments getAttachments() Прикрепленные объекты (вложения)
[массив] Прикрепленный объект (вложение)
firstWebVisit getFirstWebVisit() Первый визит клиента на сайт
Визит клиента на сайт
lastWebVisit getLastWebVisit() Последний визит клиента на сайт
Визит клиента на сайт
clientIds getClientIds() Уникальные метки Google Analytics
[массив] Уникальная метка Google Analytics
utma getUtma() deprecated Уникальные метки Google Analytics
[массив] Уникальная метка Google Analytics
firstClientId getFirstClientId() Первая метка клиента Google Analytics
lastClientId getLastClientId() Последняя метка клиента Google Analytics
customFields getCustomFields() Ассоциативный массив пользовательских полей
customField getCustomField(string code) Возвращает значение пользовательского поля. В code указывается символьный код поля.
cumulativeDiscount getCumulativeDiscount() cumulative_discount deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
personalDiscount getPersonalDiscount() personal_discount Персональная скидка
discountCardNumber getDiscountCardNumber() discount_card_number Номер дисконтной карты
totalSumm getTotalSumm() Общая сумма заказов (в базовой валюте)
averageSumm getAverageSumm() Средняя сумма заказа (в базовой валюте)
ordersCount getOrdersCount() Количество заказов
avgMarginSumm getAvgMarginSumm() Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
marginSumm getMarginSumm() LTV (в базовой валюте)
#

Изменение корпоративного клиента CustomerCorporateHistory
customerContact getCustomerContact() Контактное лицо
Контактное лицо
company getCompany() Компания
Компания
customerAddress getCustomerAddress() Адрес клиента
Адрес клиента
fieldName getFieldName() Название поля
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Изменение клиента CustomerHistory
customerSubscription getCustomerSubscription() Подписка клиента
Подписка клиента
fieldName getFieldName() Название поля
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Заметка CustomerNote
id getId() ID заметки
createdAt getCreatedAt() Дата/время создания
manager getManager() Менеджер
Пользователь
text getText() Текст заметки
#

Телефоны клиента CustomerPhone
number getNumber() Номер телефона
type getType() Тип телефона
#

Служба доставки DeliveryService
name getName() Название
code getCode() Символьный код
deliveryType getDeliveryType() Тип доставки
Тип доставки
active getActive() Статус активности
#

Тип доставки DeliveryType
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
defaultCost getDefaultCost() Стоимость по умолчанию (в валюте объекта)
defaultNetCost getDefaultNetCost() Себестоимость по умолчанию (в валюте объекта)
description getDescription() Комментарий
paymentTypes getPaymentTypes() deprecated Разрешенные типы оплат. Используйте deliveryPaymentTypes
[массив] Тип оплаты
deliveryServices getDeliveryServices() Службы доставок, которые входят в данный тип доставки
[массив] Служба доставки
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
isRussianPost isRussianPost() deprecated Доставка интегрирована с Почтой России. Используйте getIntegrationDeliveryData().is('russianpost')
isMultiShip isMultiShip() deprecated Доставка интегрирована с MultiShip. Используйте getIntegrationDeliveryData().is('multiship')
isSdek isSdek() deprecated Доставка интегрирована со СДЭК. Используйте getIntegrationDeliveryData().is('sdek')
isDpd isDpd() deprecated Доставка интегрирована с DPD. Используйте getIntegrationDeliveryData().is('dpd')
isCourier isCourier() deprecated Курьерская доставка. Используйте getIntegrationDeliveryData().is('courier')
#

Юридическое лицо LegalEntity
code getCode() Символьный код
vatRate getVatRate() Ставка НДС
contragentType getContragentType() Тип юридического лица (может принимать 2 значения: legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель)
legalName getLegalName() Полное наименование
legalAddress getLegalAddress() Адрес регистрации
INN getINN() ИНН
OKPO getOKPO() ОКПО
KPP getKPP() КПП
OGRN getOGRN() ОГРН
OGRNIP getOGRNIP() ОГРНИП
certificateNumber getCertificateNumber() Номер свидетельства
certificateDate getCertificateDate() Дата свидетельства
BIK getBIK() БИК
bank getBank() Банк
bankAddress getBankAddress() Адрес банка
corrAccount getCorrAccount() Корр. счёт
bankAccount getBankAccount() Расчётный счёт
#

Координаты Model\Point
latitude getLatitude() Широта
longitude getLongitude() Долгота
#

Диапазон цен Model\PriceRange
min getMin() Минимальное значение
max getMax() Максимальное значение
#

Информация о временном диапазоне Model\TimeInterval
from getFrom() Время "с"
to getTo() Время "до"
custom getCustom() Временной диапазон в свободной форме
string getString() Строковое представление времени
isEmpty isEmpty() Проверяет задана ли информация о временном диапазоне
#

Торговое предложение (SKU) Offer
id getId() ID торгового предложения
name getName() Название
offerName getOfferName() Возвращает название товара иначе название SKU
displayName getDisplayName() Название SKU
article getArticle() Артикул
anyArticle getAnyArticle() Артикул торгового предложения или товара, если артикул SKU отсутствует
actualPrice getActualPrice() deprecated Возвращает цену SKU иначе цену товара, к которому относится SKU
price getPrice(string priceType = null) deprecated Цена SKU (priceType - код типа цены, если необходимо выбрать цену определенного типа)
offerPrice getOfferPrice(string priceType = null) Объект цены SKU (priceType - код типа цены, если необходимо выбрать цену определенного типа либо будет использован тип цены по умолчанию)
Доступные цены
purchasePrice getPurchasePrice() Закупочная цена SKU (в базовой валюте)
properties getProperties() Свойства SKU
product getProduct() Товар, к которому относится SKU
Товар
quantity getQuantity() Доступное количество
description getDescription() Описание
externalId getExternalId() ID торгового предложения в магазине
xmlId getXmlId() ID торгового предложения в складской системе
catalog getCatalog() Каталог
Каталог
site getSite() deprecated Магазин. Используйте getCatalog()
Магазин
createdAt getCreatedAt() Дата создания в системе
active getActive() Активность
imageUrl getImageUrl() Адрес изображения
unit getUnit() Единица измерения
Единица измерения
vatRate getVatRate() Ставка НДС
barcode getBarcode() Штрих-код
weight getWeight() Вес
#

Доступные цены OfferPrice
priceType getPriceType() Тип цены
Тип цены
price getPrice() Цена (в валюте объекта)
ordering getOrdering() Порядок
currency getCurrency() Валюта
Валюта
#

Заказ Order
id getId() id ID заказа
externalId getExternalId() Внешний ID заказа
number getNumber() number Номер заказа
createdAt getCreatedAt() created_at Дата оформления заказа
orderType getOrderType() order_type Тип заказа
Тип заказа
orderMethod getOrderMethod() order_method Способ оформления
Способ оформления заказа
privilegeType getPrivilegeType() privilege_type Тип привилегии. Возможные значения: none, personal_discount, loyalty_level, loyalty_event
country getCountry() country ISO код страны (ISO 3166-1 alpha-2)
site getSite() site Магазин
Магазин
status getStatus() status Статус заказа
Статус заказа
statusComment getStatusComment() Комментарий к последнему изменению статуса
statusUpdatedAt getStatusUpdatedAt() Дата последнего изменения статуса
manager getManager() manager Менеджер заказа
Пользователь
lastName getLastName() last_name Фамилия
firstName getFirstName() first_name Имя
patronymic getPatronymic() patronymic Отчество
nickName getNickName() ФИО
phone getPhone() phone Телефон
additionalPhone getAdditionalPhone() additional_phone Дополнительный телефон
anyPhone getAnyPhone() Любой найденный телефон
email getEmail() email E-mail
anyEmail getAnyEmail() Любой найденный e-mail
customer getCustomer() customer Клиент
Клиент
Корпоративный клиент
contact getContact() contact Контактное лицо
Клиент
company getCompany() company Компания
Компания
contragent getContragent() В истории фиксируются поля связной сущности Реквизиты
Контрагент
orderProducts getOrderProducts() order_product
В истории также фиксируются поля связной сущности 		Товары в заказе (в том числе и отмененные)
[массив] Позиция в заказе
availableOrderProducts getAvailableOrderProducts() В истории фиксируются поля связной сущности Товары в заказе (рекомендуется использовать данный метод для получения товаров)
[массив] Позиция в заказе
quantity getQuantity(bool onlyAvailableProducts = true) Общее количество товаров в заказе. Если вызвать с параметром getQuantity(false), то также учитываются отмененные товары
summ getSumm(bool onlyAvailableProducts = true) Сумма по товарам/услугам (в валюте объекта). Если вызвать с параметром getSumm(false), то в сумму также включается стоимость отмененных товаров
purchaseSumm getPurchaseSumm() Общая стоимость закупки (в базовой валюте)
discountSumm getDiscountSumm() Суммарная скидка на товары (в валюте объекта)
bonusesCreditTotal getBonusesCreditTotal() Количество начисленных бонусов
bonusesChargeTotal getBonusesChargeTotal() Количество списанных бонусов
deliveryType getDeliveryType() delivery_type Тип доставки
Тип доставки
deliveryService getDeliveryService() delivery_service Служба доставки
Служба доставки
deliveryAddress getDeliveryAddress() В истории фиксируются поля связной сущности Адрес доставки
Адрес доставки
deliveryDate getDeliveryDate() delivery_date Дата доставки
deliveryTime getDeliveryTime() delivery_time Время доставки
Информация о временном диапазоне
deliveryTimeFrom getDeliveryTimeFrom() deprecated Время доставки "с"
deliveryTimeTo getDeliveryTimeTo() deprecated Время доставки "до"
deliveryTimeCustom getDeliveryTimeCustom() deprecated Время доставки в свободной форме
deliveryTimeString getDeliveryTimeString() deprecated Строковое представление времени доставки
deliveryCost getDeliveryCost() delivery_cost Стоимость доставки (в валюте объекта)
deliveryNetCost getDeliveryNetCost() delivery_net_cost Себестоимость доставки (в валюте объекта)
deliveryCostIsManual getDeliveryCostIsManual() Стоимость доставки задается вручную
deliveryNetCostIsManual getDeliveryNetCostIsManual() Себестоимость доставки задается вручную
integrationDeliveryTrackId getIntegrationDeliveryTrackId() deprecated Номер отправления в интеграционной службе доставки. Используйте getIntegrationDeliveryData().trackNumber
russianPostTrackNumber getRussianPostTrackNumber() deprecated Номер отправления Почтой России либо EMS (если заказ доставляется соответствующим способом). Используйте getIntegrationDeliveryData().trackNumber
russianPostDeliveryStatus getRussianPostDeliveryStatus() deprecated Статус доставки отправления Почтой России либо EMS. Используйте getIntegrationDeliveryData().status
sdekExternalId getSdekExternalId() deprecated Номер отправления СДЭК (если заказ доставляется соответствующим способом). Используйте getIntegrationDeliveryData().trackNumber
courier getCourier() Курьер, назначенный на заказ (если заказ доставляется соответствующим способом)
Курьер
dpdDeliveryName getDpdDeliveryName() deprecated Тариф доставки для DPD. Используйте getIntegrationDeliveryData().deliveryName
isDpdPickupPoint isDpdPickupPoint() deprecated Доставка до терминала для DPD. Используйте getIntegrationDeliveryData().toPickuppoint
dpdExternalId getDpdExternalId() deprecated Номер отправления для DPD. Используйте getIntegrationDeliveryData().trackNumber
integrationDeliveryLocked getIntegrationDeliveryLocked() Не синхронизировать со службой доставки (для интеграционной доставки)
discountManualAmount getDiscountManualAmount() discount_manual_amount Денежная скидка на весь заказ (в валюте объекта)
discountManualPercent getDiscountManualPercent() discount_manual_percent Процентная скидка на весь заказ. Система округляет это значение до 2 знаков после запятой
personalDiscountPercent getPersonalDiscountPercent() Персональная скидка на заказ
discount getDiscount() Денежная скидка на весь заказ
discountPercent getDiscountPercent() Процентная скидка на весь заказ
totalDiscount getTotalDiscount() deprecated Итоговая скидка на заказ
loyaltyAccount getLoyaltyAccount() loyalty_account Участие в программе лояльности
Участие в программе лояльности
loyaltyLevel getLoyaltyLevel() loyalty_level Уровень участия в программе лояльности
Уровень участия в программе лояльности
loyaltyEventDiscount getLoyaltyEventDiscount() loyalty_event_discount Скидка по событию программы лояльности
Скидка по событию программы лояльности
deliveryVatRate getDeliveryVatRate() Ставка НДС доставки
totalSumm getTotalSumm() total_summ Общая сумма с учетом скидки (в валюте объекта)
prepaySum getPrepaySum() prepay_sum Оплаченная сумма (в валюте объекта)
toPaySumm getToPaySumm() Сумма, оставшаяся к оплате (в валюте объекта)
mark getMark() mark Оценка заказа
markDatetime getMarkDatetime() mark_datetime Дата и время получение оценки от покупателя
expired getExpired() expired Просрочен
call getCall() call Требуется позвонить
customerComment getCustomerComment() customer_comment Комментарий клиента
managerComment getManagerComment() manager_comment Комментарий оператора
marginSumm getMarginSumm() Валовая прибыль заказа (в валюте объекта)
fromApi getFromApi() from_api Заказ поступил через API
fullPaidAt getFullPaidAt() full_paid_at Дата полной оплаты
payments getPayments() payments
В истории также фиксируются поля связной сущности 		Платежи
[массив] Платёж
integrationDeliveryData getIntegrationDeliveryData() В истории фиксируются поля связной сущности Данные интеграционной доставки
Данные курьерской службы доставки
Данные службы доставки SafeRoute
Данные службы доставки, подключенной через API
Данные службы доставки Казпочта
Данные службы доставки Новая Почта
source getSource() source Источник заказа
Источник
shipmentStore getShipmentStore() shipment_store Склад отгрузки
Склад
shipmentDate getShipmentDate() shipment_date Дата отгрузки
shipped getShipped() shipped Заказ отгружен
isShipmentAllowed isShipmentAllowed() Заказ можно отгрузить
weight getWeight(bool|null getMax = false) weight Вес. При getMax = true возвращает наибольший из обычного и объемного веса
length getLength() length Длина
width getWidth() width Ширина
height getHeight() height Высота
initialProductSumm getInitialProductSumm() Сумма по товарам/услугам без учета скидок (в валюте объекта)
paymentStatus getPaymentStatus() deprecated Статус оплаты
Статус оплаты
paymentType getPaymentType() deprecated Тип оплаты
Тип оплаты
paymentDetail getPaymentDetail() deprecated Детали платежа
dialog getDialog() MessageGateway диалог
MessageGateway Диалог
attachments getAttachments() Прикрепленные объекты (вложения)
[массив] Прикрепленный объект (вложение)
customFields getCustomFields() Ассоциативный массив пользовательских полей
customField getCustomField(string code) Возвращает значение пользовательского поля. В code указывается символьный код поля.
secondsToNextOrder getSecondsToNextOrder() Время до следующего заказа, в секундах
costs getCosts() Список затрат
[массив] Расход
clientId getClientId() Метка клиента Google Analytics
Уникальная метка Google Analytics
clientIdString getClientIdString() Метка клиента Google Analytics (строка)
#

Контрагент OrderContragent
contragentType getContragentType() contragent.contragent_type Тип контрагента (может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель)
legalName getLegalName() contragent.legal_name Полное наименование
legalAddress getLegalAddress() contragent.legal_address Адрес регистрации
INN getINN() contragent.i_n_n ИНН
OKPO getOKPO() contragent.o_k_p_o ОКПО
KPP getKPP() contragent.k_p_p КПП
OGRN getOGRN() contragent.o_g_r_n ОГРН
OGRNIP getOGRNIP() contragent.o_g_r_n_i_p ОГРНИП
certificateNumber getCertificateNumber() contragent.certificate_number Номер свидетельства
certificateDate getCertificateDate() contragent.certificate_date Дата свидетельства
BIK getBIK() contragent.b_i_k БИК
bank getBank() contragent.bank Банк
bankAddress getBankAddress() contragent.bank_address Адрес банка
corrAccount getCorrAccount() contragent.corr_account Корр. счёт
bankAccount getBankAccount() contragent.bank_account Расчётный счёт
#

Адрес доставки OrderDeliveryAddress
country getCountry() delivery_address.country ISO код страны (ISO 3166-1 alpha-2)
deliveryTime getDeliveryTime() deprecated Время доставки
index getIndex() delivery_address.index Индекс
region getRegion() delivery_address.region Регион
city getCity(bool withType = true) delivery_address.city Город (Если withType = true, город будет выведен вместе с типом населенного пункта)
cityType getCityType() Тип населенного пункта
street getStreet(bool withType = true) delivery_address.street Улица (Если withType = true, улица будет выведена вместе с типом)
streetType getStreetType() Тип улицы
building getBuilding() delivery_address.building Дом
house getHouse() delivery_address.house Строение
housing getHousing() delivery_address.housing Корпус
block getBlock() delivery_address.block Подъезд
flat getFlat() delivery_address.flat Номер квартиры/офиса
floor getFloor() delivery_address.floor Этаж
metro getMetro() delivery_address.metro Метро
text getText() Адрес в текстовом виде
notes getNotes() delivery_address.notes Примечания к адресу
isEmpty isEmpty() Адрес пустой
fullAddressString getFullAddressString(bool withIndex = true, bool getAnyForm = false) Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
#

Изменение заказа OrderHistory
orderProduct getOrderProduct() Позиция в заказе, к которой относится изменение поля
Позиция в заказе
payment getPayment() Платёж, к которому относится изменение поля
Платёж
fieldName getFieldName() Название поля
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Способ оформления заказа OrderMethod
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
defaultForApi getDefaultForApi() Устанавливается по умолчанию для заказов, создаваемых через API
#

Печатная форма OrderPlate
id getId() ID
name getName() Название печатной формы
#

Позиция в заказе OrderProduct
id getId() order_product.id ID позиции в заказе
order getOrder() В истории фиксируются поля связной сущности Заказ
Заказ
offer getOffer() Торговое предложение
Торговое предложение (SKU)
initialPrice getInitialPrice() order_product.initial_price Цена товара/SKU (в валюте объекта)
discount getDiscount() deprecated Денежная скидка на единицу товара
discountPercent getDiscountPercent() deprecated Процентная скидка на единицу товара
price getPrice() Цена на одну единицу товара с учетом скидки (в валюте объекта)
quantity getQuantity() order_product.quantity Количество
statusUpdatedAt getStatusUpdatedAt() Дата последнего изменения статуса позиции в заказе
comment getComment() order_product.comment Комментарий к позиции в заказе
status getStatus() order_product.status Статус позиции в заказе
Статус товара в заказе
orderStatus getOrderStatus() Статус который был у заказа при смене статуса товара
initialSumm getInitialSumm() Цена товарной позиции с учетом количества (в валюте объекта)
discountSumm getDiscountSumm() Общая скидка на товарную позицию с учетом количества (в валюте объекта)
summ getSumm() order_product.summ Общая сумма на товарную позицию с учетом скидок и количества (в валюте объекта)
unit getUnit() Единица измерения
Единица измерения
createdAt getCreatedAt() Дата создания позиции в системе
properties getProperties() [массив] Дополнительные свойства позиции в заказе
packs getPacks() Упаковки товаров, в рамках одной товарной позиции (в том числе и отмененные)
[массив] Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
availablePacks getAvailablePacks() Доступные упаковки товаров, в рамках одной товарной позиции (рекомендуется использовать данный метод для получения упаковок товаров)
[массив] Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
isCanceledForApi isCanceledForApi() Данная позиция в заказе является отменной
isCanceled isCanceled() Данная позиция в заказе является отменной
discountManualAmount getDiscountManualAmount() order_product.discount_manual_amount Денежная скидка на единицу товара (в валюте объекта)
discountManualPercent getDiscountManualPercent() order_product.discount_manual_percent Процентная скидка на единицу товара. Система округляет это значение до 2 знаков после запятой
bonusesCredit getBonusesCredit() order_product.bonuses_credit Количество начисленных бонусов
bonusesCharge getBonusesCharge() order_product.bonuses_charge Количество списанных бонусов
discountTotal getDiscountTotal() order_product.discount_total Итоговая денежная скидка на единицу товара c учетом всех скидок на товар и заказ (в валюте объекта)
basePurchasePrice getBasePurchasePrice() order_product.base_purchase_price Базовая закупочная цена (в базовой валюте)
purchasePrice getPurchasePrice() Закупочная цена (в базовой валюте)
purchaseSumm getPurchaseSumm() Закупочная цена товарной позиции с учетом количества (в базовой валюте)
priceType getPriceType() order_product.price_type Тип цены
Тип цены
vatRate getVatRate() order_product.vat_rate Ставка НДС
markingCodes getMarkingCodes() Коды маркировки
[массив] Код маркировки товара
#

Код маркировки товара OrderProductMarkingCode
id getId() ID кода маркировки
code getCode() Значение кода маркировки
#

Статус товара в заказе OrderProductStatus
code getCode() Символьный код
ordering getOrdering() Порядок
active getActive() Статус активности
isCancelStatus isCancelStatus() Является статусом отмены
createdAt getCreatedAt() Дата создания
name getName() Название
#

Тип заказа OrderType
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
defaultForApi getDefaultForApi() Устанавливается по умолчанию для заказов, создаваемых через API
ordering getOrdering() Порядок
#

Платёж Payment
id getId() payments.id Внутренний ID
status getStatus() payments.status Статус оплаты
Статус оплаты
type getType() payments.type Тип оплаты
Тип оплаты
externalId getExternalId() payments.external_id Внешний ID платежа
amount getAmount() payments.amount Сумма платежа (в валюте объекта)
paidAt getPaidAt() payments.paid_at Дата оплаты. Не забывайте проверять статус оплаты
comment getComment() payments.comment Комментарий
#

Статус оплаты PaymentStatus
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
defaultForApi getDefaultForApi() Устанавливается по умолчанию для заказов, создаваемых через API
ordering getOrdering() Порядок
description getDescription() Комментарий
externalId getExternalId() Внешний ID
paymentComplete getPaymentComplete() Признак того, что заказ оплачен
isPaymentComplete isPaymentComplete() Признак того, что заказ оплачен
#

Тип оплаты PaymentType
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
defaultForApi getDefaultForApi() Устанавливается по умолчанию для заказов, создаваемых через API
description getDescription() Комментарий
#

Тип цены PriceType
code getCode() Символьный код
#

Товар Product
id getId() ID товара
typeCode getTypeCode() Тип (товар product или услуга service)
article getArticle() Артикул
name getName() Название
displayName getDisplayName() Производитель + название товара
active getActive() Активность
quantity getQuantity() Количество
minPrice getMinPrice(array<PriceType> priceTypes = []) deprecated Минимальная цена на товар (в базовой валюте)
maxPrice getMaxPrice(array<PriceType> priceTypes = []) deprecated Максимальная цена на товар (в базовой валюте)
offersPriceRange getOffersPriceRange(array<PriceType> priceTypes = []) [массив] Массив из минимальной и максимальной цены на товар
Диапазон цен
minPurchasePrice getMinPurchasePrice() Минимальная закупочная цена на товар (в базовой валюте)
maxPurchasePrice getMaxPurchasePrice() Максимальная закупочная цена на товар (в базовой валюте)
weight getWeight() Вес
minWeight getMinWeight() Минимальный вес
maxWeight getMaxWeight() Максимальный вес
unit getUnit() Единица измерения
Единица измерения
url getUrl() Ссылка на страницу товара в магазине
imageUrl getImageUrl() Ссылка на изображение товара
description getDescription() Описание
catalog getCatalog() Каталог
Каталог
site getSite() deprecated Магазин. Используйте getCatalog()
Магазин
manufacturer getManufacturer() Производитель
offers getOffers() Торговые предложения
[массив] Торговое предложение (SKU)
popular getPopular() Метка Лидер продаж
stock getStock() Метка Лучшая цена
novelty getNovelty() Метка Новинка
recommended getRecommended() Метка Рекомендуем
externalId getExternalId() Внешний ID товара
groups getGroups() Товарные группы, которым принадлежит товар
[массив] Товарная группа
createdAt getCreatedAt() Дата создания товара в системе
updatedAt getUpdatedAt() Дата редактирования товара в системе
abcClass getAbcClass(int customerType = 0) ABC-классификация товара
xyzClass getXyzClass(int customerType = 0) XYZ-классификация товара
#

Товарная группа ProductGroup
id getId() ID
name getName() Название
nameWithDepth getNameWithDepth() Имя с отступом, соответствующему уровню вложенности
description getDescription() Описание
catalog getCatalog() Каталог
Каталог
site getSite() Магазин
Магазин
lvl getLvl() Уровень вложенности
parent getParent() Родительская товарная группа
Товарная группа
externalId getExternalId() Внешний ID товарной группы
#

Свойство товара ProductProperty
visible getVisible() Видимость свойства
variative getVariative() Вариативность свойства
#

Магазин Site
id getId() ID
name getName() Название
url getUrl() URL магазина
description getDescription() Комментарий
active getActive() Статус активности
defaultForCrm getDefaultForCrm() Устанавливается по умолчанию для заказов, создаваемых в системе
ordering getOrdering() Порядок
legalEntity getLegalEntity() deprecated Юридическое лицо. Используйте LegalEntity.legalName
inn getInn() deprecated ИНН. Используйте LegalEntity.INN
giro getGiro() deprecated Расчетный счет. Используйте LegalEntity.bankAccount
corrAccount getCorrAccount() deprecated Корреспондентский счет. Используйте LegalEntity.corrAccount
phones getPhones() Телефоны магазина
address getAddress() Адрес магазина
zip getZip() Почтовый индекс
createdAt getCreatedAt() Дата создания магазина в системе
code getCode() Символьный код магазина
contragent getContragent() Юридическое лицо
Юридическое лицо
country getCountry() Страна по умолчанию
#

Источник Source
id getId() ID источника
sourceName getSourceName() Источник (строка)
mediumName getMediumName() Канал
campaignName getCampaignName() Кампания
keywordName getKeywordName() Ключевое слово
adContentName getAdContentName() Содержание кампании
#

Статус заказа Status
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
ordering getOrdering() Порядок
group getGroup() Группа статусов, к которой относится статус
Группа статусов
groupCode getGroupCode() Символьный код группы статусов, к которой относится статус
#

Группа статусов StatusGroup
name getName() Название
code getCode() Символьный код
active getActive() Статус активности
ordering getOrdering() Порядок
process getProcess() Является или нет процессным состоянием заказа
custom getCustom() Признак того, что группа добавлена пользователем
editable getEditable() Возможно ли редактирование группы
statuses getStatuses() Статусы заказов, которые входят в данную группу
[массив] Статус заказа
statusesCode getStatusesCode() [массив] Символьные коды статусов заказов, которые входят в данную группу
color getColor() Цвет используемый при выводе группы
#

Единица измерения Unit
code getCode() Символьный код
name getName() Название
sym getSym() Краткое обозначение
#

Набор изменений Change\EntityChangeSet
isCreate isCreate() Сущность создается
isUpdate isUpdate() Сущность изменяется
isDelete isDelete() Сущность удаляется
changedField getChangedField(string field) Набор из старого и нового значений поля. В field указывается код поля в истории
Изменение корпоративного клиента
Изменение клиента
Изменение заказа
Изменение задачи
hasChangedField hasChangedField(string field) Проверка, что поле изменилось
hasChanges hasChanges() Есть ли изменения
hasChangesExcluding hasChangesExcluding(array keys) Есть ли изменения полей за исключением указанных
oldValue getOldValue(string field) Старое значение указанного поля. В field указывается код поля в истории
newValue getNewValue(string field) Новое значение указанного поля. В field указывается код поля в истории
authorOfChange getAuthorOfChange(string field) Возвращает пользователя, который изменил указанное поле. В field указывается код поля в истории
Пользователь
sourceOfChange getSourceOfChange(string field) Источник изменения (API api, пользователь user, триггер rule, система code, разделение split, копирование copy либо объединение с другим объектом combine). В field указывается код поля в истории
apiKeyOfChange getApiKeyOfChange(string field) Возвращает API-ключ, который изменил указанное поле. В field указывается код поля в истории
API-ключ
hasChangesWithSource hasChangesWithSource(string|null source) Проверка, что есть изменения из заданного источника source
ruleOfChange getRuleOfChange(string field) Возвращает триггер, который изменил указанное поле. В field указывается код поля в истории
Триггер
#

API-ключ ApiKey
id getId() Внутренний идентификатор API-ключа
#

Группа пользователей Group
code getCode() Код
name getName() Наименование
isManager getIsManager() Обрабатывают заказы
id getId() ID группы
#

Пользователь User
active getActive() Активность
emailAddress getEmailAddress() Email пользователя
firstName getFirstName() Имя
lastName getLastName() Фамилия
patronymic getPatronymic() Отчество
nickName getNickName() ФИО
cutName getCutName() Имя Фамилия
isManager isManager() Пользователь является менеджером, обрабатывающим заказы
isAdmin isAdmin() Является администратором
isDeliveryMan isDeliveryMan() Пользователь отвечает за доставку
restrictedByDeliveryTypes restrictedByDeliveryTypes() Доступ пользователя к заказа ограничен по типам доставок
allowedDeliveryTypes getAllowedDeliveryTypes() Перечень типов доставок, которые разрешают пользователю просмотр заказов, если включен флаг ограничения заказов по доставкам restrictedByDeliveryTypes. При использовании обязательно проверяйте, что restrictedByDeliveryTypes имеет значение true
[массив] Тип доставки
restrictingDeliveryTypes getRestrictingDeliveryTypes() deprecated Используйте allowedDeliveryTypes. Перечень типов доставок, которые разрешают пользователю просмотр заказов, если включен флаг ограничения заказов по доставкам restrictedByDeliveryTypes. При использовании обязательно проверяйте, что restrictedByDeliveryTypes имеет значение true
[массив] Тип доставки
groupCodes getGroupCodes() Символьные коды групп пользователя
hasGroup hasGroup(string|null name) Проверка, входит ли пользователь в указанную группу
position getPosition() Должность
phone getPhone() Телефон
phoneTfa getPhoneTfa() Телефон для аутентификации
createdAt getCreatedAt() Дата создания пользователя
language getLanguage() Язык интерфейса
id getId() ID пользователя
ordersCount getOrdersCount() Количество заказов на менеджере
customersCount getCustomersCount() Количество клиентов на менеджере
totalSaleSumm getTotalSaleSumm() Общая сумма заказов на менеджере (в базовой валюте)
avgSaleSumm getAvgSaleSumm() Средний чек заказов на менеджере (в базовой валюте)
marginSumm getMarginSumm() Общая маржа заказов на менеджере (в базовой валюте)
avgMarginSumm getAvgMarginSumm() Средняя маржа заказов на менеджере (в базовой валюте)
#

Уникальная метка Google Analytics ClientId
clientId getClientId() Значение метки
createdAt getCreatedAt() Дата создания
#

Визит клиента на сайт CustomerVisit
createdAt getCreatedAt() Дата-время начала визита
finishedAt getFinishedAt() Дата-вермя завершения визита
visitLength getVisitLength() Длительность визита в секундах
landingPage getLandingPage() Страница входа
exitPage getExitPage() Страница выхода
pageviews getPageviews() Количество страниц, просмотренных в ходе визита
pageDepth getPageDepth() Глубина просмотра
clientId getClientId() ClientId зафиксированный в ходе визита
Уникальная метка Google Analytics
#

Звонок Call
id getId() ID звонка
date getDate() Дата/время звонка
type getType() Тип звонка (входящий in либо исходящий out)
isMissing isMissing() Звонок является пропущенным
phone getPhone() Номер телефона
code getCode() Внутренний номер пользователя, который обрабатывал звонок
result getResult() Результат звонка (возможные значения: failed, answered, busy, no answer, not allowed, unknown)
manager getManager() Пользователь, который обрабатывал звонок
Пользователь
externalId getExternalId() ID звонка в АТС
duration getDuration() Длительность звонка (в секундах)
customer getCustomer() Клиент, который принимал или вызывал звонок (может отсутствовать)
Клиент
Корпоративный клиент
order getOrder() Заказ, с которым связан звонок (может отсутствовать)
Заказ
source getSource() Источник
Источник
site getSite() Магазин
Магазин
externalPhone getExternalPhone() Внешний номер телефона
hasTag hasTag(string name) Проверить есть ли тег у объекта
#

Письмо Letter
isOpened isOpened() Возвращает флаг, определяющий, было ли письмо открыто
isClicked isClicked() Возвращает флаг, определяющий, была ли нажата ссылка внутри сообщения
#

SMS Sms
isDelivered isDelivered() Возвращает флаг, определяющий, было ли сообщение доставлено
#

Элемент справочника CustomDictionaryElement
name getName() Название
active getActive() Доступен для использования или удален
code getCode() Символьный код
#

Данные курьерской службы доставки CourierData
courier getCourier() integration_delivery_data.courier Курьер
Курьер
is is(string code) Возвращает true если переданный код совпадает с кодом службы доставки (.is('courier'))
#

Данные службы доставки SafeRoute DDeliveryData
externalId getExternalId() Идентификатор доставки в службе доставки
deliveryName getDeliveryName() integration_delivery_data.delivery_name Название службы доставки
days getDays() Ориентировочный срок доставки
state getState() integration_delivery_data.state Статус оформления доставки (none - Не оформлялась, processing - Ожидается оформление, cancel - Отмена, success - Успешно, error - Ошибка)
is is(string code) Возвращает true если переданный код совпадает с кодом службы доставки (.is('ddelivery'))
trackNumber getTrackNumber() integration_delivery_data.track_number Номер отправления
status getStatus() integration_delivery_data.status Код статуса доставки
isLocked isLocked() Не синхронизировать со службой доставки
pickuppointAddress getPickuppointAddress() integration_delivery_data.pickuppoint_address Адрес пункта самовывоза
declaredSum getDeclaredSum() Объявленная стоимость заказа (опция "Нулевая объявленная стоимость по умолчанию" из настроек интеграции не учитывается)
#

Данные службы доставки, подключенной через API GenericData
externalId getExternalId() Идентификатор в службе доставки
statusText getStatusText() Наименование статуса доставки
statusDate getStatusDate() Дата статуса доставки
tariff getTariff() Код тарифа
tariffName getTariffName() integration_delivery_data.tariff_name Наименование тарифа
pickuppointId getPickuppointId() Идентификатор пункта самовывоза
pickuppointSchedule getPickuppointSchedule() Режим работы пункта самовывоза
pickuppointPhone getPickuppointPhone() Телефон пункта самовывоза
pickuppointCoordinateLatitude getPickuppointCoordinateLatitude() Координаты ПВЗ, широта
pickuppointCoordinateLongitude getPickuppointCoordinateLongitude() Координаты ПВЗ, долгота
statusComment getStatusComment() Комментарий к статусу доставки
cost getCost() Стоимость доставки, полученная из службы доставки (в валюте объекта)
deliveryTerm getDeliveryTerm() Ориентировочный срок доставки
shipmentpointId getShipmentpointId() Идентификатор терминала отгрузки
shipmentpointAddress getShipmentpointAddress() Адрес терминала отгрузки
shipmentpointSchedule getShipmentpointSchedule() Режим работы терминала отгрузки
shipmentpointPhone getShipmentpointPhone() Телефон терминала отгрузки
extraData getExtraData() Дополнительные данные доставки (deliveryDataField.code => значение)
state getState() integration_delivery_data.state Статус оформления доставки (none - Не оформлялась, processing - Ожидается оформление, cancel - Отмена, success - Успешно, error - Ошибка)
is is(string code) Возвращает true если переданный код совпадает с кодом службы доставки (.is('generic'))
trackNumber getTrackNumber() integration_delivery_data.track_number Номер отправления (поле deprecated на запись)
status getStatus() integration_delivery_data.status Код статуса доставки
isLocked isLocked() Не синхронизировать со службой доставки
pickuppointAddress getPickuppointAddress() integration_delivery_data.pickuppoint_address Адрес пункта самовывоза
declaredSum getDeclaredSum() Объявленная стоимость заказа (опция "Нулевая объявленная стоимость по умолчанию" из настроек интеграции не учитывается)
presentationPackages getPresentationPackages() Упаковки
packagesCount getPackagesCount(bool createPackageFromOrder = true) Количество упаковок. Параметр createPackageFromOrder (по умолчанию true) определяет, нужно ли генерировать упаковку на основе данных заказа, если в заказе отсутствуют иные упаковки.
#

Данные службы доставки Казпочта KazPostData
is is(string code) Возвращает true если переданный код совпадает с кодом службы доставки (.is('kazpost'))
trackNumber getTrackNumber() integration_delivery_data.track_number Номер отправления
status getStatus() integration_delivery_data.status Код статуса доставки
#

Данные службы доставки Новая Почта NewPostData
days getDays() Ориентировочный срок доставки
receiverWarehouse getReceiverWarehouse() integration_delivery_data.receiver_warehouse Номер и адрес отделения
price getPrice() Стоимость доставки, полученная из службы доставки
afterpaymentOnGoodsCost getAfterpaymentOnGoodsCost() Контроль оплаты (в валюте объекта)
state getState() integration_delivery_data.state Статус оформления доставки (none - Не оформлялась, processing - Ожидается оформление, cancel - Отмена, success - Успешно, error - Ошибка)
is is(string code) Возвращает true если переданный код совпадает с кодом службы доставки (.is('newpost'))
trackNumber getTrackNumber() integration_delivery_data.track_number Номер отправления
status getStatus() integration_delivery_data.status Код статуса доставки
isLocked isLocked() Не синхронизировать со службой доставки
declaredSum getDeclaredSum() Объявленная стоимость заказа (опция "Нулевая объявленная стоимость по умолчанию" из настроек интеграции не учитывается)
#

Упаковки Package
packageId getPackageId() Идентификатор упаковки
weight getWeight() Вес г.
length getLength() Длина мм.
width getWidth() Ширина мм.
height getHeight() Высота мм.
items getItems() Содержимое упаковки
#

Триггер Rule
code getCode() Код триггера
#

Данные срабатывания действия "Отправить письмо" триггера RuleActionSendLetterExecution
letters getLetters() Список отправленных в результате срабатывания триггера писем
[массив] Письмо
#

Данные срабатывания действия "Отправить сообщение в чат" триггера RuleActionSendMGMessageExecution
mgMessages getMgMessages() Список отправленных в результате срабатывания триггера сообщений
[массив] Сообщение в чатах
#

Данные срабатывания действия "Отправить SMS" триггера RuleActionSendSmsExecution
sms getSms() Отправленное в результате срабатывания триггера SMS
SMS
#

Данные при срабатывании триггера RuleExecution
actions getActions() Список данных при срабатывании действий триггера
[массив] Данные срабатывания действий триггера, не связанных с рассылкой
[массив] Данные срабатывания действия "Отправить письмо" триггера
[массив] Данные срабатывания действия "Отправить сообщение в чат" триггера
[массив] Данные срабатывания действия "Отправить SMS" триггера
#

Задача Task
id getId() id ID задачи
text getText() text Текст задачи
commentary getCommentary() commentary Комментарий к задаче
datetime getDatetime() datetime Время выполнения задачи
createdAt getCreatedAt() created_at Дата создания
complete getComplete() complete Признак выполнения задачи
user getUser() user Автор задачи
Пользователь
performer getPerformer() performer Исполнитель задачи
Группа пользователей
Пользователь
customer getCustomer() customer Клиент, к которому привязана задача
Клиент
Корпоративный клиент
order getOrder() order Заказ, к которому привязана задача
Заказ
phone getPhone() phone Телефон связанный с задачей
phoneSite getPhoneSite() phone_site Магазин, связанный с задачей на перезвон
Магазин
completedAt getCompletedAt() completed_at Время завершения задачи
taskComments getTaskComments() comments
В истории также фиксируются поля связной сущности 		Комментарии пользователей к задаче
[массив] Комментарий пользователя к задаче
hasTag hasTag(string name) Проверить есть ли тег у объекта
tags getTags() Теги
[массив] Тег
#

Комментарий пользователя к задаче TaskComment
id getId() comments.id ID комментария к задаче
text getText() comments.text Текст комментария к задаче
#

Изменение задачи TaskHistory
taskComment getTaskComment() Комментарий пользователя к задаче
Комментарий пользователя к задаче
fieldName getFieldName() Название поля
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Курьер Courier
id getId() ID курьера
active getActive() Признак активности
createdAt getCreatedAt() Дата заведения курьера в системе
email getEmail() Электронная почта
phone getPhone() Контактный телефон
Телефон курьера
name getName() deprecated ФИО. Используйте fullName
firstName getFirstName() Имя
lastName getLastName() Фамилия
patronymic getPatronymic() Отчество
fullName getFullName() ФИО
description getDescription() Примечание
#

Телефон курьера CourierPhone
number getNumber() Номер телефона
type getType() Тип телефона
#

Остатки по складам Inventory
quantity getQuantity() Количество
store getStore() Склад
Склад
purchasePrice getPurchasePrice() Закупочная цена (в базовой валюте)
#

Перемещение товара Movement
shipmentDate getShipmentDate() Дата забора
storeTo getStoreTo() Склад привоза
Склад
storeFrom getStoreFrom() Склад забора
Склад
courier getCourier() Курьер
Курьер
completed getCompleted() Перемещение проведено
#

Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада OrderProductPack
id getId() ID
purchasePrice getPurchasePrice() Закупочная цена (в базовой валюте)
quantity getQuantity() Количество товара в упаковке
store getStore() Склад
Склад
orderProduct getOrderProduct() Связанная товарная позиция из заказа
Позиция в заказе
reserve getReserve() Бронь пака
Бронь пака
purchaseSumm getPurchaseSumm() Закупочная сумма по упаковке (в базовой валюте)
summ getSumm() Сумма продажи по упаковке (в валюте объекта)
shipmentStore getShipmentStore() Склад отгрузки
Склад
reserveStore getReserveStore() Склад резерва
Склад
movement getMovement() Перемещение товара
Перемещение товара
deliveryNoteNumber getDeliveryNoteNumber() Номер товарной накладной
invoiceNumber getInvoiceNumber() Номер счет-фактуры
shipmentDate getShipmentDate() Дата забора пака
offer getOffer() Торговое предложение
Торговое предложение (SKU)
order getOrder() Заказ
Заказ
isCanceled isCanceled() Пак переведена в статус отмены
status getStatus() Статус упаковки товаров
Статус товара в заказе
comment getComment() Комментарий к статусу
#

Набор изменений в истории комплектации OrderProductPackHistory
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Печатная форма PackPlate
id getId() ID
name getName() Название печатной формы
#

Бронь пака Reserve
id getId() ID
quantity getQuantity() Количество
store getStore() Склад
Склад
purchasePrice getPurchasePrice() Закупочная цена (в базовой валюте)
createdAt getCreatedAt() Время создания брони
orderProductPack getOrderProductPack() Связанный пак
Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
#

Склад Store
id getId() ID склада
active getActive() Статус активности
ordering getOrdering() Порядок
description getDescription() Описание склада
address getAddress() Адрес склада
Адрес склада
type getType() Тип склада (store-type-retail - розничный магазин, store-type-online - интернет-магазин, store-type-warehouse - склад, store-type-supplier - склад поставщика)
externalId getExternalId() Внешний ID
phone getPhone() Телефон склада
Телефон склада
contact getContact() Контактное лицо на складе
createdAt getCreatedAt() Дата создания склада в системе
code getCode() Символьный код
email getEmail() Email склада
workTimes getWorkTimes() Рабочее время
[массив] Время работы склада
name getName() Название
#

Адрес склада StoreAddress
coordinates getCoordinates() Координаты точки (Тип Model\Point)
Координаты
index getIndex() Индекс
country getCountry() Страна
region getRegion() Регион
city getCity(bool withType = true) Город (Если withType = true, город будет выведен вместе с типом населенного пункта)
cityType getCityType() Тип населенного пункта
street getStreet(bool withType = true) Улица (Если withType = true, улица будет выведена вместе с типом)
streetType getStreetType() Тип улицы
building getBuilding() Дом
house getHouse() Строение
housing getHousing() Корпус
block getBlock() Подъезд
flat getFlat() Номер квартиры/офиса
floor getFloor() Этаж
metro getMetro() Метро
text getText() Адрес в текстовом виде
notes getNotes() Примечания к адресу
isEmpty isEmpty() Адрес пустой
fullAddressString getFullAddressString(bool withIndex = true, bool getAnyForm = false) Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
#

Телефон склада StorePhone
number getNumber() Номер телефона
type getType() Тип телефона
#

Время работы склада StoreWorkTime
day getDay() День недели (0 - воскресенье, 6 - суббота)
workFrom getWorkFrom() Время начала работы склада (в формате H:i)
workUntil getWorkUntil() Время окончания работы склада (в формате H:i)
lunchFrom getLunchFrom() Время начала перерыва (в формате H:i)
lunchUntil getLunchUntil() Время окончания перерыва (в формате H:i)
#

Сегмент Segment
name getName() Название сегмента
isDynamic getIsDynamic() Является ли сегмент автоматически пересчитываемым
customersCount getCustomersCount() Количество клиентов в сегменте
generatedAt getGeneratedAt() Время последнего пересчета сегмента
code getCode() Символьный код
#

Значения условия сегмента Literal
value getValue() Скалярное значение фильтра
min getMin() Значение минимума для числового и денежного фильтра
max getMax() Значение максимума для числового и денежного фильтра
isNegated isNegated() Условие по данному значению инвертировано
isNotEmpty isNotEmpty() Объект содержит условия
#

Событие "День рождения" BirthdayLoyaltyEvent
id getId() ID события
privilegeType getPrivilegeType() Тип привилегии по событию. Возможные значения: bonus, discount
privilegeSize getPrivilegeSize() Размер скидки для товаров по обычной цене
privilegeSizePromo getPrivilegeSizePromo() Размер скидки для товаров по акционной цене
#

Кастомное событие CustomLoyaltyEvent
id getId() ID события
privilegeType getPrivilegeType() Тип привилегии по событию. Возможные значения: bonus, discount
privilegeSize getPrivilegeSize() Размер скидки для товаров по обычной цене
privilegeSizePromo getPrivilegeSizePromo() Размер скидки для товаров по акционной цене
#

Программа лояльности Loyalty
id getId() ID программы лояльности
name getName() Название программы лояльности
#

Участие в программе лояльности LoyaltyAccount
id getId() ID участия
isActive isActive() Признак активности участия
loyalty getLoyalty() Программа лояльности
Программа лояльности
createdAt getCreatedAt() Дата создания
status getStatus() Статус участия. Возможные значения: not_confirmed, activated, deactivated
phoneNumber getPhoneNumber() Номер телефона
cardNumber getCardNumber() Номер карты
amount getAmount() Количество активных бонусов
awaitingAmount getAwaitingAmount() Ожидающие активации бонусы
ordersSum getOrdersSum() Сумма покупок (в валюте объекта)
level getLevel() Уровень участия
Уровень участия в программе лояльности
customFields getCustomFields() Ассоциативный массив пользовательских полей
customField getCustomField(string code) Возвращает значение пользовательского поля
#

Информация о бонусном счете участия LoyaltyAccountInfo
activeAmount getActiveAmount() Количество активных бонусов
waitingActivationAmount getWaitingActivationAmount() Количество бонусов ожидающих активацию
burnSoonAmount getBurnSoonAmount(int day = 30) Количество бонусов, которые скоро сгорят (в аргументе можно передать период сгорания в днях)
burnedAmount getBurnedAmount() Бонусов сгорело за все время участия
spentAmount getSpentAmount() Бонусов списано за все время участия
addedAmount getAddedAmount() Бонусов начислено за все время участия
#

Изменение участия в программе лояльности LoyaltyAccountTimeline
fieldName getFieldName() Название поля
oldValue getOldValue() Старое значение
newValue getNewValue() Новое значение
#

Скидка по событию программы лояльности LoyaltyEventDiscount
discount getDiscount() Размер скидки для товаров по обычной цене
loyaltyEvent getLoyaltyEvent() Событие
Событие "День рождения"
Кастомное событие
Событие "Welcome-бонусы"
discountPromo getDiscountPromo() Размер скидки для товаров по акционных товаров
isExpired isExpired() Просрочена
#

Уровень участия в программе лояльности LoyaltyLevel
id getId() ID уровня
name getName() Название уровня
type getType() Тип уровня. Возможные значения: bonus_converting, bonus_percent, discount
privilegeSize getPrivilegeSize() Размер скидки, процент или курс начисления бонусов для товаров по обычной цене (в валюте объекта)
privilegeSizePromo getPrivilegeSizePromo() Размер скидки, процент или курс начисления бонусов для акционных товаров (в валюте объекта)
isDiscountPrivilegeType isDiscountPrivilegeType() Тип привилегий - скидка
isBonusPrivilegeType isBonusPrivilegeType() Тип привилегий - бонусы
#

Операция с бонусным счетом Model\LoyaltyBonusOperation
createdAt getCreatedAt() Дата операции
reason getReason() Тип действия с бонусами. Возможные значения: credit_for_order, burn, credit_for_event, charge_for_order, charge_manual, credit_manual, cancel_of_charge, cancel_of_credit, trigger_credit
loyaltyAccount getLoyaltyAccount() Участие в программе лояльности
Участие в программе лояльности
customer getCustomer() Клиент
Клиент
amount getAmount() Сумма операции
type getType() Тип операции. Возможные значения: credit, charge
comment getComment() Комментарий
order getOrder() Заказ
Заказ
manager getManager() Инициатор
Пользователь
#

Событие "Welcome-бонусы" WelcomeLoyaltyEvent
id getId() ID события
privilegeType getPrivilegeType() Тип привилегии по событию. Возможные значения: bonus, discount
privilegeSize getPrivilegeSize() Размер скидки для товаров по обычной цене
privilegeSizePromo getPrivilegeSizePromo() Размер скидки для товаров по акционной цене
#

Корзина Cart
site getSite() Магазин
Магазин
createdAt getCreatedAt() Дата/время создания корзины
droppedAt getDroppedAt() Дата/время, когда корзина стала брошенной
link getLink() Ссылка на корзину
linkPath getLinkPath() Ссылка на корзину (путь)
items getItems() Товары в корзине
[массив] Товарная позиция корзины
#

Товарная позиция корзины CartItem
offer getOffer() Торговое предложение
Торговое предложение (SKU)
quantity getQuantity() Количество
price getPrice() Цена (в валюте объекта)
createdAt getCreatedAt() Дата/время добавления позиции
#

Группа рекомендаций Model\RecommendationGroup
offers getOffers() Торговые предложения
[массив] Торговое предложение (SKU)
#

Торговое предложение RecommendationOffer
offer getOffer() Торговое предложение
Торговое предложение (SKU)
#

Товарная группа RecommendationProductGroup
productGroup getProductGroup() Товарная группа
Товарная группа
#

Торговое предложение или товарная группа Model\CatalogItem
offer getOffer() Торговое предложение
Торговое предложение (SKU)
productGroup getProductGroup() Товарная группа
Товарная группа
#

Группа рекомендаций для события "Просмотр товара или товарной группы" Model\RuleActivationItem
items getItems() Массив торговых предложений, вызвавших срабатывание правила (Тип Model\CatalogItem)
[массив] Торговое предложение или товарная группа
recommendItems getRecommendItems() Массив рекомендуемых торговых предложений и товарных групп (Тип Model\CatalogItem)
[массив] Торговое предложение или товарная группа
#

Прикрепленный объект (вложение) Attachment
file getFile() Файл
Файл
createdAt getCreatedAt() Дата создания
#

Файл File
isImage isImage() Файл является изображением
filename getFilename() Имя файла
originalName getOriginalName() Оригинальное имя файла
type getType() MIME-тип файла
createdAt getCreatedAt() Дата создания
size getSize() Размер файла в байтах
#

Расход Cost
costItemCode getCostItemCode() Символьный код статьи расходов
costItemName getCostItemName() Название статьи расходов
costGroupName getCostGroupName() Название группы расходов
costGroupCode getCostGroupCode() Символьный код группы расходов
dateFrom getDateFrom() Дата (от)
dateTo getDateTo() Дата (до)
summ getSumm() Сумма (в базовой валюте)
comment getComment() Комментарий
#

Статья расходов CostItem
code getCode() Символьный код статьи расходов
name getName() Название статьи расходов
active getActive() Активность
#

MessageGateway бот MGBot
externalId getExternalId() Внешний ID бота
name getName() Название бота
#

MessageGateway канал MGChannel
externalId getExternalId() Внешний ID канала
type getType() Тип канала
#

MessageGateway клиент MGCustomer
customer getCustomer() Клиент
Клиент
externalId getExternalId() Внешний ID MessageGateway клиента
channel getChannel() Канал
MessageGateway канал
dialogs getDialogs() Диалоги
[массив] MessageGateway Диалог
#

MessageGateway Диалог MGDialog
externalId getExternalId() Внешний ID диалога
createdAt getCreatedAt() Дата создания диалога
closedAt getClosedAt() Дата закрытия диалога
mgCustomer getMgCustomer() MessageGateway Клиент
MessageGateway клиент
manager getManager() Пользователь
Пользователь
mgBot getMgBot() MessageGateway Бот
MessageGateway бот
messagesFromCustomer getMessagesFromCustomer() Количество сообщений от клиента
messagesFromManagers getMessagesFromManagers() Количество сообщений от менеджеров
avgAnswerTime getAvgAnswerTime() Время ответа менеджера на сообщения
firstAnswerTime getFirstAnswerTime() Время ответа менеджера на первое сообщение
hasTag hasTag(string name) Проверить есть ли тег у объекта
tags getTags() Теги
[массив] Тег
#

Сообщение в чатах MGMessage
isSent isSent() Признак успешной отправки сообщения в чат
isFailed isFailed() Признак ошибочной отправки сообщения в чат
channelType channelType() Тип канала, в котором было отправлено сообщение
#

MessageGateway пользователь MGUser
externalId getExternalId() Внешний ID пользователя
user getUser() Пользователь
Пользователь
#

Тег Tag
name getName() Название
#

Подписка клиента CustomerSubscription
subscription getSubscription() Категория подписки
Категория подписки
subscribed getSubscribed() customer_subscription.subscribed Активность подписки
changedAt getChangedAt() Дата изменения флага активности
#

Категория подписки Subscription
channelCode getChannelCode() Канал
name getName() Название
code getCode() Символьный код
#

Справочник символьных кодов и значений CodeValueModel
code code() Код
value value() Значение
#

Содержимое упаковки PackageItem
orderProduct orderProduct() Позиция в заказе
Позиция в заказе
quantity quantity() Количество товара в упаковке
#

Позиция в заказе PackageItemOrderProduct
id id() ID позиции в заказе
externalId externalId() deprecated Внешний ID позиции в заказе
externalIds externalIds() Внешние идентификаторы позиции в заказе
[массив] Справочник символьных кодов и значений
#

Данные срабатывания действий триггера, не связанных с рассылкой RuleActionGenericExecution