Currency
Catalog
Company
CompanyContragent
Customer
CustomerAddress
CustomerContact
CustomerContactCompany
CustomerContragent
CustomerCorporate
CustomerCorporateHistory
CustomerHistory
CustomerNote
CustomerPhone
DeliveryService
DeliveryType
LegalEntity
Model\Point
Model\PriceRange
Model\TimeInterval
Offer
OfferPrice
Order
OrderContragent
OrderDeliveryAddress
OrderHistory
OrderMethod
OrderPlate
OrderProduct
OrderProductStatus
OrderType
Payment
PaymentStatus
PaymentType
PriceType
Product
ProductGroup
ProductProperty
Site
Source
Status
StatusGroup
Unit
Change\EntityChangeSet
ApiKey
User
ClientId
CustomerVisit
Call
Letter
Sms
CustomDictionaryElement
CourierData
DDeliveryData
GenericData
KazPostData
NewPostData
RuleActionSendLetterExecution
RuleActionSendSmsExecution
RuleExecution
Task
TaskComment
TaskHistory
Courier
CourierPhone
Movement
OrderProductPack
OrderProductPackHistory
PackPlate
Reserve
Store
StoreAddress
StorePhone
Segment
Criteria
GroupCriteria
Literal
BirthdayLoyaltyEvent
CustomLoyaltyEvent
Loyalty
LoyaltyAccount
LoyaltyAccountInfo
LoyaltyAccountTimeline
LoyaltyEventDiscount
LoyaltyLevel
Model\LoyaltyBonusOperation
WelcomeLoyaltyEvent
Cart
CartItem
Model\RecommendationGroup
RecommendationOffer
RecommendationProductGroup
Model\CatalogItem
Model\RuleActivationItem
Attachment
File
Cost
MGBot
MGChannel
MGCustomer
MGDialog
MGUser
Tag
Объект/Поле | Метод | Код поля в истории | Примечание |
---|---|---|---|
#
Валюта
|
|||
code
|
getCode()
|
Код валюты | |
#
Каталог
|
|||
mainSite
|
getMainSite()
|
Основной магазин каталога | |
#
Компания
|
|||
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(code)
|
Возвращает значение пользовательского поля. В code указывается символьный код поля.
|
|
#
Контрагент
|
|||
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
|
Расчётный счёт |
#
Клиент
|
|||
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
|
|
anyEmail
|
getAnyEmail()
|
Любой найденый e-mail | |
birthday
|
getBirthday()
|
birthday
|
День рождения |
source
|
getSource()
|
source
|
Источник клиента |
phones
|
getPhones()
|
phones
|
[массив] Телефоны |
lastPhone
|
getLastPhone()
|
Последний указанный телефон | |
phone
|
getPhone()
|
Телефон | |
anyPhone
|
getAnyPhone()
|
Любой найденый телефон | |
mgCustomers
|
getMgCustomers()
|
[массив] Клиенты MessageGateway | |
address
|
getAddress()
|
В истории фиксируются поля связной сущности | Адрес клиента |
commentary
|
getCommentary()
|
commentary
|
deprecated Комментарий
|
segments
|
getSegments()
|
[массив] Сегменты | |
loyaltyAccountBySiteCode
|
getLoyaltyAccountBySiteCode(siteCode)
|
В истории фиксируются поля связной сущности | Участие в ПЛ клиента по коду сайта |
id
|
getId()
|
id
|
ID клиента |
createdAt
|
getCreatedAt()
|
Создан | |
customerContacts
|
getCustomerContacts()
|
contact
В истории также фиксируются поля связной сущности |
[массив] Контактные лица |
addresses
|
getAddresses()
|
address
В истории также фиксируются поля связной сущности |
[массив] Адреса клиента |
mainAddress
|
getMainAddress(getNewAddressOnNull = false)
|
main_address
В истории также фиксируются поля связной сущности |
Основной адрес клиента |
site
|
getSite()
|
site
|
Магазин, с которого пришел клиент |
manager
|
getManager()
|
manager
|
Менеджер клиента |
vip
|
getVip()
|
vip
|
Важный клиент |
bad
|
getBad()
|
bad
|
Плохой клиент |
externalId
|
getExternalId()
|
external_id
|
Внешний ID клиента |
contragent
|
getContragent()
|
В истории фиксируются поля связной сущности |
deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
|
emailMarketingUnsubscribedAt
|
getEmailMarketingUnsubscribedAt()
|
email_marketing_unsubscribed_at
|
Дата отписки от email рассылок |
notes
|
getNotes()
|
notes
|
[массив] Заметки |
mainCustomerContact
|
getMainCustomerContact()
|
main_contact
В истории также фиксируются поля связной сущности |
Основное контактное лицо |
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(name)
|
Проверить есть ли тег у объекта | |
tags
|
getTags()
|
[массив] Теги | |
attachments
|
getAttachments()
|
[массив] Прикрепленные объекты (вложения) | |
firstWebVisit
|
getFirstWebVisit()
|
Первый визит клиента на сайт | |
lastWebVisit
|
getLastWebVisit()
|
Последний визит клиента на сайт | |
clientIds
|
getClientIds()
|
[массив] Уникальные метки Google Analytics | |
utma
|
getUtma()
|
deprecated Уникальные метки Google Analytics
|
|
firstClientId
|
getFirstClientId()
|
Первая метка клиента Google Analytics | |
lastClientId
|
getLastClientId()
|
Последняя метка клиента Google Analytics | |
customFields
|
getCustomFields()
|
Ассоциативный массив пользовательских полей | |
customField
|
getCustomField(code)
|
Возвращает значение пользовательского поля. В code указывается символьный код поля.
|
|
totalSumm
|
getTotalSumm()
|
Общая сумма заказов (в базовой валюте) | |
averageSumm
|
getAverageSumm()
|
Средняя сумма заказа (в базовой валюте) | |
ordersCount
|
getOrdersCount()
|
Количество заказов | |
avgMarginSumm
|
getAvgMarginSumm()
|
Средняя валовая прибыль по заказам клиента (в базовой валюте) | |
marginSumm
|
getMarginSumm()
|
LTV (в базовой валюте) | |
cumulativeDiscount
|
getCumulativeDiscount()
|
cumulative_discount
|
deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
|
personalDiscount
|
getPersonalDiscount()
|
personal_discount
|
Персональная скидка |
discountCardNumber
|
getDiscountCardNumber()
|
discount_card_number
|
Номер дисконтной карты |
maturationTime
|
getMaturationTime()
|
Время «созревания», в секундах | |
#
Адрес клиента
|
|||
name
|
getName()
|
address.name
|
Наменование адреса |
index
|
getIndex()
|
address.index
|
Индекс |
country
|
getCountry()
|
address.country
|
Страна |
region
|
getRegion()
|
address.region
|
Регион |
city
|
getCity(withType = true)
|
address.city
|
Город (Если withType = true , город будет выведен вместе с типом населенного пункта)
|
cityType
|
getCityType()
|
Тип населенного пункта | |
street
|
getStreet(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(withIndex = true, getAnyForm = false)
|
Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
|
|
#
Контактное лицо
|
|||
id
|
getId()
|
contact.id
|
ID контакта |
customerContactCompanies
|
getCustomerContactCompanies()
|
contact.contact_company
В истории также фиксируются поля связной сущности |
[массив] Компании контактного лица |
#
Компания контактного лица
|
|||
id
|
getId()
|
contact.contact_company.id
|
ID компании |
company
|
getCompany()
|
contact.contact_company.company
|
Компания |
#
Контрагент
|
|||
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
|
Расчётный счёт |
#
Корпоративный клиент
|
|||
typeCode
|
getTypeCode()
|
Тип клиента (customer - клиент, customer_corporate - корпоративный клиент)
|
|
mainCustomerContact
|
getMainCustomerContact()
|
main_contact
В истории также фиксируются поля связной сущности |
Основное контактное лицо |
companies
|
getCompanies()
|
company
В истории также фиксируются поля связной сущности |
[массив] Компании |
mainCompany
|
getMainCompany(getNewCompanyOnNull = false)
|
main_company
В истории также фиксируются поля связной сущности |
Основная компания |
phones
|
getPhones()
|
phones
|
[массив] Телефоны корпоративного клиента |
id
|
getId()
|
id
|
ID корпоративного клиента |
createdAt
|
getCreatedAt()
|
Создан | |
customerContacts
|
getCustomerContacts()
|
contact
В истории также фиксируются поля связной сущности |
[массив] Контактные лица |
addresses
|
getAddresses()
|
address
В истории также фиксируются поля связной сущности |
[массив] Адреса корпоративного клиента |
mainAddress
|
getMainAddress(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()
|
email_marketing_unsubscribed_at
|
Дата отписки от 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(name)
|
Проверить есть ли тег у объекта | |
tags
|
getTags()
|
[массив] Теги | |
attachments
|
getAttachments()
|
[массив] Прикрепленные объекты (вложения) | |
firstWebVisit
|
getFirstWebVisit()
|
Первый визит клиента на сайт | |
lastWebVisit
|
getLastWebVisit()
|
Последний визит клиента на сайт | |
clientIds
|
getClientIds()
|
[массив] Уникальные метки Google Analytics | |
utma
|
getUtma()
|
deprecated Уникальные метки Google Analytics
|
|
firstClientId
|
getFirstClientId()
|
Первая метка клиента Google Analytics | |
lastClientId
|
getLastClientId()
|
Последняя метка клиента Google Analytics | |
customFields
|
getCustomFields()
|
Ассоциативный массив пользовательских полей | |
customField
|
getCustomField(code)
|
Возвращает значение пользовательского поля. В code указывается символьный код поля.
|
|
totalSumm
|
getTotalSumm()
|
Общая сумма заказов (в базовой валюте) | |
averageSumm
|
getAverageSumm()
|
Средняя сумма заказа (в базовой валюте) | |
ordersCount
|
getOrdersCount()
|
Количество заказов | |
avgMarginSumm
|
getAvgMarginSumm()
|
Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте) | |
marginSumm
|
getMarginSumm()
|
LTV (в базовой валюте) | |
cumulativeDiscount
|
getCumulativeDiscount()
|
cumulative_discount
|
deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
|
personalDiscount
|
getPersonalDiscount()
|
personal_discount
|
Персональная скидка |
discountCardNumber
|
getDiscountCardNumber()
|
discount_card_number
|
Номер дисконтной карты |
#
Изменение корпоративного клиента
|
|||
customerContact
|
getCustomerContact()
|
Контактное лицо | |
company
|
getCompany()
|
Компания | |
customerAddress
|
getCustomerAddress()
|
Адрес клиента | |
fieldName
|
getFieldName()
|
Название поля | |
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Изменение клиента
|
|||
fieldName
|
getFieldName()
|
Название поля | |
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Заметка
|
|||
id
|
getId()
|
ID заметки | |
createdAt
|
getCreatedAt()
|
Дата/время создания | |
manager
|
getManager()
|
Менеджер | |
text
|
getText()
|
Текст заметки | |
#
Телефоны клиента
|
|||
number
|
getNumber()
|
Номер телефона | |
type
|
getType()
|
Тип телефона | |
#
Служба доставки
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
deliveryType
|
getDeliveryType()
|
Тип доставки | |
active
|
getActive()
|
Статус активности | |
#
Тип доставки
|
|||
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')
|
|
#
Юридическое лицо
|
|||
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()
|
Расчётный счёт | |
#
Координаты
|
|||
latitude
|
getLatitude()
|
Широта | |
longitude
|
getLongitude()
|
Долгота | |
#
Диапазон цен
|
|||
min
|
getMin()
|
Минимальное значение | |
max
|
getMax()
|
Максимальное значение | |
#
Информация о временном диапазоне
|
|||
from
|
getFrom()
|
Время "с" | |
to
|
getTo()
|
Время "до" | |
custom
|
getCustom()
|
Временной диапазон в свободной форме | |
string
|
getString()
|
Строковое представление времени | |
isEmpty
|
isEmpty()
|
Проверяет задана ли информация о временном диапазоне | |
#
Торговое предложение (SKU)
|
|||
id
|
getId()
|
ID торгового предложения | |
name
|
getName()
|
Название | |
offerName
|
getOfferName()
|
Возвращает название товара иначе название SKU | |
displayName
|
getDisplayName()
|
Название SKU | |
article
|
getArticle()
|
Артикул | |
anyArticle
|
getAnyArticle()
|
Артикул торгового предложения или товара, если артикул SKU отсутствует | |
actualPrice
|
getActualPrice()
|
deprecated Возвращает цену SKU иначе цену товара, к которому относится SKU
|
|
price
|
getPrice(priceType = null)
|
deprecated Цена SKU (priceType - код типа цены, если необходимо выбрать цену определенного типа)
|
|
offerPrice
|
getOfferPrice(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()
|
Дата создания в системе | |
imageUrl
|
getImageUrl()
|
Адрес изображения | |
unit
|
getUnit()
|
Единица измерения | |
vatRate
|
getVatRate()
|
Ставка НДС | |
barcode
|
getBarcode()
|
Штрих-код | |
weight
|
getWeight()
|
Вес | |
#
Доступные цены
|
|||
priceType
|
getPriceType()
|
Тип цены | |
price
|
getPrice()
|
Цена (в валюте объекта) | |
ordering
|
getOrdering()
|
Порядок | |
currency
|
getCurrency()
|
Валюта | |
#
Заказ
|
|||
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
|
|
anyEmail
|
getAnyEmail()
|
Любой найденый e-mail | |
customer
|
getCustomer()
|
customer
|
Клиент
Клиент Корпоративный клиент |
contact
|
getContact()
|
contact
|
Контактное лицо |
company
|
getCompany()
|
company
|
Компания |
contragent
|
getContragent()
|
В истории фиксируются поля связной сущности | Реквизиты |
orderProducts
|
getOrderProducts()
|
order_product
В истории также фиксируются поля связной сущности |
[массив] Товары в заказе (в том числе и отмененные) |
availableOrderProducts
|
getAvailableOrderProducts()
|
В истории фиксируются поля связной сущности | Товары в заказе |
quantity
|
getQuantity(onlyAvailableProducts = true)
|
Общее количество товаров в заказе. Если вызвать с параметром getQuantity(false) , то также учитываются отмененные товары
|
|
summ
|
getSumm(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()
|
Итоговая скидка на заказ | |
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(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 диалог | |
secondsToNextOrder
|
getSecondsToNextOrder()
|
Время до следующего заказа, в секундах | |
attachments
|
getAttachments()
|
[массив] Прикрепленные объекты (вложения) | |
costs
|
getCosts()
|
[массив] Список затрат | |
customFields
|
getCustomFields()
|
Ассоциативный массив пользовательских полей | |
customField
|
getCustomField(code)
|
Возвращает значение пользовательского поля. В code указывается символьный код поля.
|
|
clientId
|
getClientId()
|
Метка клиента Google Analytics | |
clientIdString
|
getClientIdString()
|
Метка клиента Google Analytics (строка) | |
#
Контрагент
|
|||
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
|
Расчётный счёт |
#
Адрес доставки
|
|||
country
|
getCountry()
|
delivery_address.country
|
Страна |
deliveryTime
|
getDeliveryTime()
|
deprecated Время доставки
|
|
index
|
getIndex()
|
delivery_address.index
|
Индекс |
region
|
getRegion()
|
delivery_address.region
|
Регион |
city
|
getCity(withType = true)
|
delivery_address.city
|
Город (Если withType = true , город будет выведен вместе с типом населенного пункта)
|
cityType
|
getCityType()
|
Тип населенного пункта | |
street
|
getStreet(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(withIndex = true, getAnyForm = false)
|
Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
|
|
#
Изменение заказа
|
|||
orderProduct
|
getOrderProduct()
|
Позиция в заказе, к которой относится изменение поля | |
payment
|
getPayment()
|
Платёж, к которому относится изменение поля | |
fieldName
|
getFieldName()
|
Название поля | |
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Способ оформления заказа
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
defaultForCrm
|
getDefaultForCrm()
|
Устанавливается по умолчанию для заказов, создаваемых в системе | |
defaultForApi
|
getDefaultForApi()
|
Устанавливается по умолчанию для заказов, создаваемых через API | |
#
Печатная форма
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Название печатной формы | |
#
Позиция в заказе
|
|||
id
|
getId()
|
order_product.id
|
ID позиции в заказе |
order
|
getOrder()
|
В истории фиксируются поля связной сущности | Заказ |
offer
|
getOffer()
|
Торговое предложение | |
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
|
Ставка НДС |
#
Статус товара в заказе
|
|||
code
|
getCode()
|
Символьный код | |
ordering
|
getOrdering()
|
Порядок | |
active
|
getActive()
|
Статус активности | |
isCancelStatus
|
isCancelStatus()
|
Является статусом отмены | |
createdAt
|
getCreatedAt()
|
Дата создания | |
name
|
getName()
|
Название | |
#
Тип заказа
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
defaultForCrm
|
getDefaultForCrm()
|
Устанавливается по умолчанию для заказов, создаваемых в системе | |
defaultForApi
|
getDefaultForApi()
|
Устанавливается по умолчанию для заказов, создаваемых через API | |
ordering
|
getOrdering()
|
Порядок | |
#
Платёж
|
|||
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
|
Комментарий |
#
Статус оплаты
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
defaultForCrm
|
getDefaultForCrm()
|
Устанавливается по умолчанию для заказов, создаваемых в системе | |
defaultForApi
|
getDefaultForApi()
|
Устанавливается по умолчанию для заказов, создаваемых через API | |
ordering
|
getOrdering()
|
Порядок | |
description
|
getDescription()
|
Комментарий | |
externalId
|
getExternalId()
|
Внешний ID | |
paymentComplete
|
getPaymentComplete()
|
Признак того, что заказ оплачен | |
isPaymentComplete
|
isPaymentComplete()
|
Признак того, что заказ оплачен | |
#
Тип оплаты
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
defaultForCrm
|
getDefaultForCrm()
|
Устанавливается по умолчанию для заказов, создаваемых в системе | |
defaultForApi
|
getDefaultForApi()
|
Устанавливается по умолчанию для заказов, создаваемых через API | |
description
|
getDescription()
|
Комментарий | |
#
Тип цены
|
|||
code
|
getCode()
|
Символьный код | |
#
Товар
|
|||
id
|
getId()
|
ID товара | |
typeCode
|
getTypeCode()
|
Тип (товар product или услуга service )
|
|
article
|
getArticle()
|
Артикул | |
name
|
getName()
|
Название | |
displayName
|
getDisplayName()
|
Производитель + название товара | |
active
|
getActive()
|
Активность | |
quantity
|
getQuantity()
|
Количество | |
minPrice
|
getMinPrice(array priceTypes = [])
|
deprecated Минимальная цена на товар (в базовой валюте)
|
|
maxPrice
|
getMaxPrice(array priceTypes = [])
|
deprecated Максимальная цена на товар (в базовой валюте)
|
|
offersPriceRange
|
getOffersPriceRange(array 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()
|
[массив] Торговые предложения | |
popular
|
getPopular()
|
Метка Лидер продаж | |
stock
|
getStock()
|
Метка Лучшая цена | |
novelty
|
getNovelty()
|
Метка Новинка | |
recommended
|
getRecommended()
|
Метка Рекомендуем | |
externalId
|
getExternalId()
|
Внешний ID товара | |
groups
|
getGroups()
|
Товарные группы, которым принадлежит товар | |
createdAt
|
getCreatedAt()
|
Дата создания товара в системе | |
updatedAt
|
getUpdatedAt()
|
Дата редактирования товара в системе | |
abcClass
|
getAbcClass(customerType = 0)
|
ABC-классификация товара | |
xyzClass
|
getXyzClass(customerType = 0)
|
XYZ-классификация товара | |
#
Товарная группа
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Название | |
nameWithDepth
|
getNameWithDepth()
|
Имя с отступом, соответствующему уровню вложенности | |
description
|
getDescription()
|
Описание | |
catalog
|
getCatalog()
|
Каталог | |
site
|
getSite()
|
Магазин | |
lvl
|
getLvl()
|
Уровень вложенности | |
parent
|
getParent()
|
Родительская товарная группа | |
externalId
|
getExternalId()
|
Внешний ID товарной группы | |
#
Свойство товара
|
|||
visible
|
getVisible()
|
Видимость свойства | |
variative
|
getVariative()
|
Вариативность свойства | |
#
Магазин
|
|||
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()
|
Страна по умолчанию | |
#
Источник
|
|||
id
|
getId()
|
ID источника | |
sourceName
|
getSourceName(translate = true)
|
Источник (строка) | |
mediumName
|
getMediumName(translate = true)
|
Канал | |
campaignName
|
getCampaignName()
|
Кампания | |
keywordName
|
getKeywordName()
|
Ключевое слово | |
adContentName
|
getAdContentName()
|
Содержание кампании | |
#
Статус заказа
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
ordering
|
getOrdering()
|
Порядок | |
group
|
getGroup()
|
Группа статусов, к которой относится статус | |
groupCode
|
getGroupCode()
|
Символьный код группы статусов, к которой относится статус | |
#
Группа статусов
|
|||
name
|
getName()
|
Название | |
code
|
getCode()
|
Символьный код | |
active
|
getActive()
|
Статус активности | |
ordering
|
getOrdering()
|
Порядок | |
process
|
getProcess()
|
Является или нет процессным состоянием заказа | |
custom
|
getCustom()
|
Признак того, что группа добавлена пользователем | |
editable
|
getEditable()
|
Возможно ли редактирование группы | |
statuses
|
getStatuses()
|
[массив] Статусы заказов, которые входят в данную группу | |
statusesCode
|
getStatusesCode()
|
[массив] Символьные коды статусов заказов, которые входят в данную группу | |
color
|
getColor()
|
Цвет используемый при выводе группы | |
#
Единица измерения
|
|||
code
|
getCode()
|
Символьный код | |
name
|
getName()
|
Название | |
sym
|
getSym()
|
Краткое обозначение | |
#
Набор изменений
|
|||
isCreate
|
isCreate()
|
Сущность создается | |
isUpdate
|
isUpdate()
|
Сущность изменяется | |
isDelete
|
isDelete()
|
Сущность удаляется | |
changedField
|
getChangedField(field, entity = null)
|
Набор из старого и нового значений поля. В field указывается код поля в истории
|
|
hasChangedField
|
hasChangedField(field, entity = null)
|
Проверка, что поле изменилось | |
hasChanges
|
hasChanges()
|
Есть ли изменения | |
hasChangesExcluding
|
hasChangesExcluding(array keys)
|
Есть ли изменения полей за исключением указанных | |
oldValue
|
getOldValue(field, entity = null)
|
Старое значение указанного поля. В field указывается код поля в истории
|
|
newValue
|
getNewValue(field, entity = null)
|
Новое значение указанного поля. В field указывается код поля в истории
|
|
authorOfChange
|
getAuthorOfChange(field, entity = null)
|
Возвращает пользователя, который изменил указанное поле. В field указывается код поля в истории
|
|
sourceOfChange
|
getSourceOfChange(field, entity = null)
|
Источник изменения (API api , пользователь user , триггер rule , система code , разделение split , копирование copy либо объединение с другим объектом combine ). В field указывается код поля в истории
|
|
apiKeyOfChange
|
getApiKeyOfChange(field, entity = null)
|
Возвращает API-ключ, который изменил указанное поле. В field указывается код поля в истории
|
|
hasChangesWithSource
|
hasChangesWithSource(source)
|
Проверка, что есть изменения из заданного источника source
|
|
#
API-ключ
|
|||
id
|
getId()
|
Внутренний идентификатор API-ключа | |
#
Пользователь
|
|||
id
|
getId()
|
ID пользователя | |
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(name)
|
Проверка, входит ли пользователь в указанную группу | |
position
|
getPosition()
|
Должность | |
phone
|
getPhone()
|
Телефон | |
phoneTfa
|
getPhoneTfa()
|
Телефон для аутентификации | |
createdAt
|
getCreatedAt()
|
Дата создания пользователя | |
language
|
getLanguage()
|
Язык интерфейса | |
ordersCount
|
getOrdersCount()
|
Количество заказов на менеджере | |
customersCount
|
getCustomersCount()
|
Количество клиентов на менеджере | |
totalSaleSumm
|
getTotalSaleSumm()
|
Общая сумма заказов на менеджере (в базовой валюте) | |
avgSaleSumm
|
getAvgSaleSumm()
|
Средний чек заказов на менеджере (в базовой валюте) | |
marginSumm
|
getMarginSumm()
|
Общая маржа заказов на менеджере (в базовой валюте) | |
avgMarginSumm
|
getAvgMarginSumm()
|
Средняя маржа заказов на менеджере (в базовой валюте) | |
#
Уникальная метка Google Analytics
|
|||
clientId
|
getClientId()
|
Значение метки | |
createdAt
|
getCreatedAt()
|
Дата создания | |
#
Визит клиента на сайт
|
|||
createdAt
|
getCreatedAt()
|
Дата-время начала визита | |
finishedAt
|
getFinishedAt()
|
Дата-вермя завершения визита | |
visitLength
|
getVisitLength()
|
Длительность визита в секундах | |
landingPage
|
getLandingPage()
|
Страница входа | |
exitPage
|
getExitPage()
|
Страница выхода | |
pageviews
|
getPageviews()
|
Количество страниц, просмотренных в ходе визита | |
pageDepth
|
getPageDepth()
|
Глубина просмотра | |
clientId
|
getClientId()
|
ClientId зафиксированный в ходе визита | |
#
Звонок
|
|||
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(name)
|
Проверить есть ли тег у объекта | |
#
Письмо
|
|||
isOpened
|
isOpened()
|
Возвращает флаг, определяющий, было ли письмо открыто | |
isClicked
|
isClicked()
|
Возвращает флаг, определяющий, была ли нажата ссылка внутри сообщения | |
#
SMS
|
|||
isDelivered
|
isDelivered()
|
Возвращает флаг, определяющий, было ли сообщение доставлено | |
#
Элемент справочника
|
|||
name
|
getName()
|
Название | |
active
|
getActive()
|
Доступен для использования или удален | |
code
|
getCode()
|
Символьный код | |
#
Данные курьерской службы доставки
|
|||
courier
|
getCourier()
|
integration_delivery_data.courier
|
Курьер |
is
|
is(code)
|
Возвращает true если переданный код совпадает с кодом службы доставки (.is('courier') )
|
|
#
Данные службы доставки SafeRoute
|
|||
externalId
|
getExternalId()
|
Идентификатор доставки в службе доставки | |
deliveryName
|
getDeliveryName()
|
integration_delivery_data.delivery_name
|
Название службы доставки |
days
|
getDays()
|
Ориентировочный срок доставки | |
state
|
getState()
|
integration_delivery_data.state
|
Статус оформления доставки (none - Не оформлялась, processing - Ожидается оформление, cancel - Отмена, success - Успешно, error - Ошибка)
|
is
|
is(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
|
|||
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(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()
|
Объявленная стоимость заказа (опция "Нулевая объявленная стоимость по умолчанию" из настроек интеграции не учитывается) | |
packagesCount
|
getPackagesCount(createPackageFromOrder = true)
|
Количество упаковок. Параметр createPackageFromOrder (по умолчанию true ) определяет, нужно ли генерировать упаковку на основе данных заказа, если в заказе отсутствуют иные упаковки.
|
|
#
Данные службы доставки Казпочта
|
|||
is
|
is(code)
|
Возвращает true если переданный код совпадает с кодом службы доставки (.is('kazpost') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Номер отправления |
status
|
getStatus()
|
integration_delivery_data.status
|
Код статуса доставки |
#
Данные службы доставки Новая Почта
|
|||
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(code)
|
Возвращает true если переданный код совпадает с кодом службы доставки (.is('newpost') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Номер отправления |
status
|
getStatus()
|
integration_delivery_data.status
|
Код статуса доставки |
isLocked
|
isLocked()
|
Не синхронизировать со службой доставки | |
declaredSum
|
getDeclaredSum()
|
Объявленная стоимость заказа (опция "Нулевая объявленная стоимость по умолчанию" из настроек интеграции не учитывается) | |
#
Данные срабатывания действия "Отправка письма" триггера
|
|||
letters
|
getLetters()
|
Список отправленных в результате срабатывания триггера писем | |
#
Данные срабатывания действия "Отправка SMS" триггера
|
|||
sms
|
getSms()
|
Отправленное в результате срабатывания триггера SMS | |
#
Данные при срабатывании триггера
|
|||
actions
|
getActions()
|
Список данных при срабатывании действий триггера | |
#
Задача
|
|||
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(name)
|
Проверить есть ли тег у объекта | |
tags
|
getTags()
|
Теги | |
#
Комментарий пользователя к задаче
|
|||
id
|
getId()
|
comments.id
|
ID комментария к задаче |
text
|
getText()
|
comments.text
|
Текст комментария к задаче |
#
Изменение задачи
|
|||
taskComment
|
getTaskComment()
|
Комментарий пользователя к задаче | |
fieldName
|
getFieldName()
|
Название поля | |
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Курьер
|
|||
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()
|
Примечание | |
#
Телефон курьера
|
|||
number
|
getNumber()
|
Номер телефона | |
type
|
getType()
|
Тип телефона | |
#
Перемещение товара
|
|||
shipmentDate
|
getShipmentDate()
|
Дата забора | |
storeTo
|
getStoreTo()
|
Склад привоза | |
storeFrom
|
getStoreFrom()
|
Склад забора | |
courier
|
getCourier()
|
Курьер | |
completed
|
getCompleted()
|
Перемещение проведено | |
#
Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
|
|||
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()
|
Торговое предложение | |
order
|
getOrder()
|
Заказ | |
isCanceled
|
isCanceled()
|
Пак переведена в статус отмены | |
status
|
getStatus()
|
Статус упаковки товаров | |
comment
|
getComment()
|
Комментарий к статусу | |
#
Набор изменений в истории комплектации
|
|||
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Печатная форма
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Название печатной формы | |
#
Бронь пака
|
|||
id
|
getId()
|
ID | |
quantity
|
getQuantity()
|
Количество | |
store
|
getStore()
|
Склад | |
purchasePrice
|
getPurchasePrice()
|
Закупочная цена (в базовой валюте) | |
createdAt
|
getCreatedAt()
|
Время создания брони | |
orderProductPack
|
getOrderProductPack()
|
Связанный пак | |
#
Склад
|
|||
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 склада | |
name
|
getName()
|
Название | |
#
Адрес склада
|
|||
coordinates
|
getCoordinates()
|
Координаты точки | |
index
|
getIndex()
|
Индекс | |
country
|
getCountry()
|
Страна | |
region
|
getRegion()
|
Регион | |
city
|
getCity(withType = true)
|
Город (Если withType = true , город будет выведен вместе с типом населенного пункта)
|
|
cityType
|
getCityType()
|
Тип населенного пункта | |
street
|
getStreet(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(withIndex = true, getAnyForm = false)
|
Адрес в строковом виде, собранный из полей. Параметр withIndex определяет выводить ли индекс
|
|
#
Телефон склада
|
|||
number
|
getNumber()
|
Номер телефона | |
type
|
getType()
|
Тип телефона | |
#
Сегмент
|
|||
name
|
getName()
|
Название сегмента | |
isDynamic
|
getIsDynamic()
|
Является ли сегмент автоматически пересчитываемым | |
customersCount
|
getCustomersCount()
|
Количество клиентов в сегменте | |
conditionByType
|
getConditionByType(type)
|
Возвращает объект соответствующего фильтра (Criteria ) или пустое значение, если такового не найдено
|
|
generatedAt
|
getGeneratedAt()
|
Время последнего пересчета сегмента | |
code
|
getCode()
|
Символьный код | |
#
Условие
|
|||
type
|
getType()
|
Тип условия | |
#
Группа условий
|
|||
type
|
getType()
|
Тип условия | |
#
Значения условия сегмента
|
|||
value
|
getValue()
|
Скалярное значение фильтра | |
min
|
getMin()
|
Значение минимума для числового и денежного фильтра (в базовой валюте) | |
max
|
getMax()
|
Значение максимума для числового и денежного фильтра (в базовой валюте) | |
isNegated
|
isNegated()
|
Условие по данному значению инвертировано | |
isNotEmpty
|
isNotEmpty()
|
Объект содержит условия | |
#
Событие "День рождения"
|
|||
id
|
getId()
|
ID события | |
privilegeType
|
getPrivilegeType()
|
Тип привилегии по событию. Возможные значения: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Размер скидки для товаров по обычной цене | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Размер скидки для товаров по акционной цене | |
#
Кастомное событие
|
|||
id
|
getId()
|
ID события | |
privilegeType
|
getPrivilegeType()
|
Тип привилегии по событию. Возможные значения: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Размер скидки для товаров по обычной цене | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Размер скидки для товаров по акционной цене | |
#
Программа лояльности
|
|||
id
|
getId()
|
ID программы лояльности | |
name
|
getName()
|
Название программы лояльности | |
#
Участие в программе лояльности
|
|||
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(code)
|
Возвращает значение пользовательского поля | |
#
Информация о бонусном счете участия
|
|||
activeAmount
|
getActiveAmount()
|
Количество активных бонусов | |
waitingActivationAmount
|
getWaitingActivationAmount()
|
Количество бонусов ожидающих активацию | |
burnSoonAmount
|
getBurnSoonAmount(day = 30)
|
Количество бонусов, которые скоро сгорят (в аргументе можно передать период сгорания в днях) | |
burnedAmount
|
getBurnedAmount()
|
Бонусов сгорело за все время участия | |
spentAmount
|
getSpentAmount()
|
Бонусов списано за все время участия | |
addedAmount
|
getAddedAmount()
|
Бонусов начислено за все время участия | |
#
Изменение участия в программе лояльности
|
|||
fieldName
|
getFieldName()
|
Название поля | |
oldValue
|
getOldValue()
|
Старое значение | |
newValue
|
getNewValue()
|
Новое значение | |
#
Скидка по событию программы лояльности
|
|||
discount
|
getDiscount()
|
Размер скидки для товаров по обычной цене | |
loyaltyEvent
|
getLoyaltyEvent()
|
Событие
Событие "День рождения" Событие "Welcome-бонусы" Кастомное событие |
|
discountPromo
|
getDiscountPromo()
|
Размер скидки для товаров по акционных товаров | |
isExpired
|
isExpired()
|
Просрочена | |
#
Уровень участия в программе лояльности
|
|||
id
|
getId()
|
ID уровня | |
name
|
getName()
|
Название уровня | |
type
|
getType()
|
Тип уровня. Возможные значения: bonus_converting , bonus_percent , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Размер скидки, процент или курс начисления бонусов для товаров по обычной цене (в валюте объекта) | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Размер скидки, процент или курс начисления бонусов для акционных товаров (в валюте объекта) | |
isDiscountPrivilegeType
|
isDiscountPrivilegeType()
|
Тип привилегий - скидка | |
isBonusPrivilegeType
|
isBonusPrivilegeType()
|
Тип привилегий - бонусы | |
#
Операция с бонусным счетом
|
|||
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-бонусы"
|
|||
id
|
getId()
|
ID события | |
privilegeType
|
getPrivilegeType()
|
Тип привилегии по событию. Возможные значения: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Размер скидки для товаров по обычной цене | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Размер скидки для товаров по акционной цене | |
#
Корзина
|
|||
site
|
getSite()
|
Магазин | |
createdAt
|
getCreatedAt()
|
Дата/время создания корзины | |
droppedAt
|
getDroppedAt()
|
Дата/время, когда корзина стала брошенной | |
link
|
getLink()
|
Ссылка на корзину | |
items
|
getItems()
|
[массив] Товары в корзине | |
#
Товарная позиция корзины
|
|||
offer
|
getOffer()
|
Торговое предложение | |
quantity
|
getQuantity()
|
Количество | |
price
|
getPrice()
|
Цена (в валюте объекта) | |
createdAt
|
getCreatedAt()
|
Дата/время добавления позиции | |
#
Группа рекомендаций
|
|||
offers
|
getOffers()
|
Торговые предложения | |
#
Торговое предложение
|
|||
offer
|
getOffer()
|
Торговое предложение | |
#
Товарная группа
|
|||
productGroup
|
getProductGroup()
|
Товарная группа | |
#
Торговое предложение или товарная группа
|
|||
offer
|
getOffer()
|
Торговое предложение | |
productGroup
|
getProductGroup()
|
Товарная группа | |
#
Группа рекомендаций для события "Просмотр товара или товарной группы"
|
|||
items
|
getItems()
|
Массив торговых предложений, вызвавших срабатывание правила (Тип Model\CatalogItem )
|
|
recommendItems
|
getRecommendItems()
|
Массив рекомендуемых торговых предложений и товарных групп (Тип Model\CatalogItem )
|
|
#
Прикрепленный объект (вложение)
|
|||
file
|
getFile()
|
Файл | |
createdAt
|
getCreatedAt()
|
Дата создания | |
#
Файл
|
|||
isImage
|
isImage()
|
Файл является изображением | |
filename
|
getFilename()
|
Имя файла | |
originalName
|
getOriginalName()
|
Оригинальное имя файла | |
type
|
getType()
|
MIME-тип файла | |
createdAt
|
getCreatedAt()
|
Дата создания | |
size
|
getSize()
|
Размер файла в байтах | |
#
Расход
|
|||
costItemCode
|
getCostItemCode()
|
Символьный код статьи расходов | |
costItemName
|
getCostItemName()
|
Название статьи расходов | |
costGroupName
|
getCostGroupName()
|
Название группы расходов | |
costGroupCode
|
getCostGroupCode()
|
Символьный код группы расходов | |
dateFrom
|
getDateFrom()
|
Дата (от) | |
dateTo
|
getDateTo()
|
Дата (до) | |
summ
|
getSumm()
|
Сумма (в базовой валюте) | |
comment
|
getComment()
|
Комментарий | |
#
MessageGateway бот
|
|||
externalId
|
getExternalId()
|
Внешний ID бота | |
name
|
getName()
|
Название бота | |
#
MessageGateway канал
|
|||
externalId
|
getExternalId()
|
Внешний ID канала | |
type
|
getType()
|
Тип канала | |
#
MessageGateway клиент
|
|||
customer
|
getCustomer()
|
Клиент | |
externalId
|
getExternalId()
|
Внешний ID MessageGateway клиента | |
channel
|
getChannel()
|
Канал | |
dialogs
|
getDialogs()
|
[массив] Диалоги | |
#
MessageGateway Диалог
|
|||
externalId
|
getExternalId()
|
Внешний ID диалога | |
createdAt
|
getCreatedAt()
|
Дата создания диалога | |
closedAt
|
getClosedAt()
|
Дата закрытия диалога | |
mgCustomer
|
getMgCustomer()
|
MessageGateway Клиент | |
manager
|
getManager()
|
Пользователь | |
mgBot
|
getMgBot()
|
MessageGateway Бот | |
messagesFromCustomer
|
getMessagesFromCustomer()
|
Количество сообщений от клиента | |
messagesFromManagers
|
getMessagesFromManagers()
|
Количество сообщений от менеджеров | |
avgAnswerTime
|
getAvgAnswerTime()
|
Время ответа менеджера на сообщения | |
firstAnswerTime
|
getFirstAnswerTime()
|
Время ответа менеджера на первое сообщение | |
hasTag
|
hasTag(name)
|
Проверить есть ли тег у объекта | |
tags
|
getTags()
|
Теги | |
#
MessageGateway пользователь
|
|||
externalId
|
getExternalId()
|
Внешний ID пользователя | |
user
|
getUser()
|
Пользователь | |
#
Тег
|
|||
name
|
getName()
|
Название |