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
OrderProductMarkingCode
OrderProductStatus
OrderType
Payment
PaymentStatus
PaymentType
PriceType
Product
ProductGroup
ProductProperty
Site
Source
Status
StatusGroup
Unit
Change\EntityChangeSet
ApiKey
Group
User
ClientId
CustomerVisit
Call
Letter
Sms
CustomDictionaryElement
CourierData
DDeliveryData
GenericData
KazPostData
NewPostData
Package
Rule
RuleActionSendLetterExecution
RuleActionSendMGMessageExecution
RuleActionSendSmsExecution
RuleExecution
Task
TaskComment
TaskHistory
Courier
CourierPhone
Movement
OrderProductPack
OrderProductPackHistory
PackPlate
Reserve
Store
StoreAddress
StorePhone
StoreWorkTime
Segment
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
MGMessage
MGUser
Tag
CustomerSubscription
Subscription
CodeValueModel
PackageItem
PackageItemOrderProduct
RuleActionGenericExecution
Entity/Field | Method | Field name in history | Description |
---|---|---|---|
#
Currency
|
|||
code
|
getCode()
|
Currency code | |
#
Catalog
|
|||
mainSite
|
getMainSite()
|
Main store of catalog
Store |
|
#
Company
|
|||
externalId
|
getExternalId()
|
company.external_id
|
Company external ID |
active
|
getActive()
|
company.active
|
Activity |
name
|
getName()
|
company.name
|
Name |
brand
|
getBrand()
|
company.brand
|
Brand |
site
|
getSite()
|
company.site
|
Company website |
contragent
|
getContragent()
|
Only fields of related entity are recorded in history |
Requisites
Contragent |
address
|
getAddress()
|
company.address
Else fields of related entity are recorded in history |
Address
Customer address |
avgMarginSumm
|
getAvgMarginSumm()
|
Average gross profit of customer orders (in base currency) | |
totalSumm
|
getTotalSumm()
|
Orders total sum (in base currency) | |
averageSumm
|
getAverageSumm()
|
Order average sum (in base currency) | |
ordersCount
|
getOrdersCount()
|
Orders quantity | |
marginSumm
|
getMarginSumm()
|
LTV (in base currency) | |
customFields
|
getCustomFields()
|
Associative array of custom fields | |
customField
|
getCustomField(string code)
|
Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.
|
|
#
Contragent
|
|||
contragentType
|
getContragentType()
|
company.contragent.contragent_type
|
Contragent type (field can receive 2 values: legal-entity - legal entity, entrepreneur - individual entrepreneur) |
legalName
|
getLegalName()
|
company.contragent.legal_name
|
Legal name |
legalAddress
|
getLegalAddress()
|
company.contragent.legal_address
|
Registration address |
INN
|
getINN()
|
company.contragent.i_n_n
|
TIN |
OKPO
|
getOKPO()
|
company.contragent.o_k_p_o
|
RNNBO |
KPP
|
getKPP()
|
company.contragent.k_p_p
|
IECC |
OGRN
|
getOGRN()
|
company.contragent.o_g_r_n
|
PSRN |
OGRNIP
|
getOGRNIP()
|
company.contragent.o_g_r_n_i_p
|
PSRN of Individual entrepreneur |
certificateNumber
|
getCertificateNumber()
|
company.contragent.certificate_number
|
Certificate number |
certificateDate
|
getCertificateDate()
|
company.contragent.certificate_date
|
Certificate date |
BIK
|
getBIK()
|
company.contragent.b_i_k
|
RCBIC |
bank
|
getBank()
|
company.contragent.bank
|
Bank |
bankAddress
|
getBankAddress()
|
company.contragent.bank_address
|
Bank address |
corrAccount
|
getCorrAccount()
|
company.contragent.corr_account
|
Corresponding account |
bankAccount
|
getBankAccount()
|
company.contragent.bank_account
|
Settlement account |
#
Customer
|
|||
typeCode
|
getTypeCode()
|
Customer type ("customer" - customer, "customer_corporate" - corporate customer)
|
|
firstName
|
getFirstName()
|
first_name
|
Name |
lastName
|
getLastName()
|
last_name
|
Surname |
patronymic
|
getPatronymic()
|
patronymic
|
Middle name |
nickName
|
getNickName()
|
Full name | |
sexCode
|
getSexCode()
|
Sex code ("male" , "female" or null)
|
|
presumableSexCode
|
getPresumableSexCode()
|
Guessed gender code by customer name | |
email
|
getEmail()
|
email
|
|
anyEmail
|
getAnyEmail()
|
Any found e-mail | |
birthday
|
getBirthday()
|
birthday
|
Birthday |
source
|
getSource()
|
source
|
Customer source
Source |
phones
|
getPhones()
|
phones
|
Phones
[array] Customer phone |
lastPhone
|
getLastPhone()
|
Last found phone
Customer phone |
|
phone
|
getPhone()
|
Phone | |
anyPhone
|
getAnyPhone()
|
Any found phone | |
customerSubscriptions
|
getCustomerSubscriptions()
|
customer_subscription
Else fields of related entity are recorded in history |
Subscriptions
[array] Client's subscription |
mgCustomers
|
getMgCustomers()
|
MessageGateway customers
[array] MessageGateway customer |
|
address
|
getAddress()
|
Only fields of related entity are recorded in history |
Customer address
Customer address |
commentary
|
getCommentary()
|
commentary
|
deprecated Comment
|
segments
|
getSegments()
|
[array] Segments
[array] Segment |
|
loyaltyAccountBySiteCode
|
getLoyaltyAccountBySiteCode(string siteCode)
|
Only fields of related entity are recorded in history |
Participation in the customer's Loyalty Program by the site code
Participation in the loyalty program |
contragent
|
getContragent()
|
Only fields of related entity are recorded in history |
deprecated Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
Contragent |
id
|
getId()
|
id
|
Customer ID |
createdAt
|
getCreatedAt()
|
Created at | |
customerContacts
|
getCustomerContacts()
|
Contact persons
[array] Contact person |
|
addresses
|
getAddresses()
|
address
Else fields of related entity are recorded in history |
Customer addresses
[array] Customer address |
mainAddress
|
getMainAddress(bool getNewAddressOnNull = false)
|
main_address
Else fields of related entity are recorded in history |
Main customer address
Customer address |
site
|
getSite()
|
site
|
Store, from which the customer came
Store |
manager
|
getManager()
|
manager
|
Customer manager
User |
vip
|
getVip()
|
vip
|
VIP customer |
bad
|
getBad()
|
bad
|
Bad customer |
externalId
|
getExternalId()
|
external_id
|
Customer external ID |
emailMarketingUnsubscribedAt
|
getEmailMarketingUnsubscribedAt()
|
deprecated Date of unsubscription from emails
|
|
notes
|
getNotes()
|
notes
|
Notes
[array] Note |
mainCustomerContact
|
getMainCustomerContact()
|
Main contact person
Contact person |
|
avgSecondsBetweenOrders
|
getAvgSecondsBetweenOrders()
|
Average time between orders, in seconds | |
firstOrder
|
getFirstOrder()
|
First uncancelled order of customer
Order |
|
lastOrder
|
getLastOrder()
|
Last uncancelled order of customer
Order |
|
monetaryValue
|
getMonetaryValue()
|
Monetary value in RFM | |
recencyValue
|
getRecencyValue()
|
Recency value in RFM | |
monetaryClass
|
getMonetaryClass()
|
Monetary-segment in RFM | |
frequencyClass
|
getFrequencyClass()
|
Frequency-segment in RFM | |
recencyClass
|
getRecencyClass()
|
Recency-segment in RFM | |
hasTag
|
hasTag(string name)
|
Check if an object has a tag | |
tags
|
getTags()
|
[array] Tags
[array] Tag |
|
attachments
|
getAttachments()
|
Attachments
[array] Attachment |
|
firstWebVisit
|
getFirstWebVisit()
|
First customer visit on site
Customer visit in site |
|
lastWebVisit
|
getLastWebVisit()
|
Last customer visit on site
Customer visit in site |
|
clientIds
|
getClientIds()
|
Google Analytics unique clientIds
[array] Google Analytics unique clientId |
|
utma
|
getUtma()
|
deprecated Google Analytics unique clientIds
[array] Google Analytics unique clientId |
|
firstClientId
|
getFirstClientId()
|
First Google Analytics clientId | |
lastClientId
|
getLastClientId()
|
Last Google Analytics clientId | |
customFields
|
getCustomFields()
|
Associative array of custom fields | |
customField
|
getCustomField(string code)
|
Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.
|
|
cumulativeDiscount
|
getCumulativeDiscount()
|
cumulative_discount
|
deprecated Cumulative discount (Not available starting from version 8 of the system)
|
personalDiscount
|
getPersonalDiscount()
|
personal_discount
|
Personal discount |
discountCardNumber
|
getDiscountCardNumber()
|
discount_card_number
|
Discount card number |
totalSumm
|
getTotalSumm()
|
Orders total sum (in base currency) | |
averageSumm
|
getAverageSumm()
|
Order average sum (in base currency) | |
ordersCount
|
getOrdersCount()
|
Orders quantity | |
avgMarginSumm
|
getAvgMarginSumm()
|
Average gross profit of customer orders (in base currency) | |
marginSumm
|
getMarginSumm()
|
LTV (in base currency) | |
maturationTime
|
getMaturationTime()
|
Maturation time, in seconds | |
#
Customer address
|
|||
name
|
getName()
|
address.name
|
Name |
index
|
getIndex()
|
address.index
|
Postal code |
country
|
getCountry()
|
address.country
|
Country |
region
|
getRegion()
|
address.region
|
Region |
city
|
getCity(bool withType = true)
|
address.city
|
City (If withType = true , city will be displayed with locality type)
|
cityType
|
getCityType()
|
Locality type | |
street
|
getStreet(bool withType = true)
|
address.street
|
Street (If withType = true , street will be displayed with type)
|
streetType
|
getStreetType()
|
Street type | |
building
|
getBuilding()
|
address.building
|
Building |
house
|
getHouse()
|
address.house
|
House |
housing
|
getHousing()
|
address.housing
|
Housing |
block
|
getBlock()
|
address.block
|
Entrance |
flat
|
getFlat()
|
address.flat
|
Flat/office |
floor
|
getFloor()
|
address.floor
|
Floor |
metro
|
getMetro()
|
address.metro
|
Underground |
text
|
getText()
|
Address as string | |
notes
|
getNotes()
|
address.notes
|
Notes to address |
isEmpty
|
isEmpty()
|
Address is empty | |
fullAddressString
|
getFullAddressString(bool withIndex = true, bool getAnyForm = false)
|
Address as string collected from fields. Parameter withIndex allows to display postal code
|
|
#
Contact person
|
|||
id
|
getId()
|
contact.id
|
Contact ID |
customerContactCompanies
|
getCustomerContactCompanies()
|
contact.contact_company
Else fields of related entity are recorded in history |
Companies of the contact person
[array] Contact person`s company |
#
Contact person`s company
|
|||
id
|
getId()
|
contact.contact_company.id
|
Company ID |
company
|
getCompany()
|
contact.contact_company.company
Else fields of related entity are recorded in history |
Company
Company |
#
Contragent
|
|||
contragentType
|
getContragentType()
|
contragent.contragent_type
|
Contragent type (field can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur) |
legalName
|
getLegalName()
|
contragent.legal_name
|
Legal name |
legalAddress
|
getLegalAddress()
|
contragent.legal_address
|
Registration address |
INN
|
getINN()
|
contragent.i_n_n
|
TIN |
OKPO
|
getOKPO()
|
contragent.o_k_p_o
|
RNNBO |
KPP
|
getKPP()
|
contragent.k_p_p
|
IECC |
OGRN
|
getOGRN()
|
contragent.o_g_r_n
|
PSRN |
OGRNIP
|
getOGRNIP()
|
contragent.o_g_r_n_i_p
|
PSRN of Individual entrepreneur |
certificateNumber
|
getCertificateNumber()
|
contragent.certificate_number
|
Certificate number |
certificateDate
|
getCertificateDate()
|
contragent.certificate_date
|
Certificate date |
BIK
|
getBIK()
|
contragent.b_i_k
|
RCBIC |
bank
|
getBank()
|
contragent.bank
|
Bank |
bankAddress
|
getBankAddress()
|
contragent.bank_address
|
Bank address |
corrAccount
|
getCorrAccount()
|
contragent.corr_account
|
Corresponding account |
bankAccount
|
getBankAccount()
|
contragent.bank_account
|
Settlement account |
#
Corporate customer
|
|||
typeCode
|
getTypeCode()
|
Customer type ("customer" - customer, "customer_corporate" - corporate customer)
|
|
mainCustomerContact
|
getMainCustomerContact()
|
main_contact
Else fields of related entity are recorded in history |
Main contact person
Contact person |
companies
|
getCompanies()
|
company
Else fields of related entity are recorded in history |
Companies
[array] Company |
mainCompany
|
getMainCompany(bool getNewCompanyOnNull = false)
|
main_company
Else fields of related entity are recorded in history |
Main company
Company |
phones
|
getPhones()
|
phones
|
Phone numbers of the corporate customer
[array] Customer phone |
id
|
getId()
|
id
|
Corporate customer ID |
createdAt
|
getCreatedAt()
|
Created at | |
customerContacts
|
getCustomerContacts()
|
contact
Else fields of related entity are recorded in history |
Contact persons
[array] Contact person |
addresses
|
getAddresses()
|
address
Else fields of related entity are recorded in history |
Corporate customer addresses
[array] Customer address |
mainAddress
|
getMainAddress(bool getNewAddressOnNull = false)
|
main_address
Else fields of related entity are recorded in history |
Main corporate customer address
Customer address |
site
|
getSite()
|
site
|
Store, from which the corporate customer came
Store |
manager
|
getManager()
|
manager
|
Corporate customer manager
User |
vip
|
getVip()
|
vip
|
VIP corporate customer |
bad
|
getBad()
|
bad
|
Bad corporate customer |
externalId
|
getExternalId()
|
external_id
|
Corporate customer external ID |
nickName
|
getNickName()
|
nick_name
|
Name |
emailMarketingUnsubscribedAt
|
getEmailMarketingUnsubscribedAt()
|
deprecated Date of unsubscription from emails
|
|
notes
|
getNotes()
|
notes
|
Notes
[array] Note |
avgSecondsBetweenOrders
|
getAvgSecondsBetweenOrders()
|
Average time between orders, in seconds | |
firstOrder
|
getFirstOrder()
|
First uncancelled order of corporate customer
Order |
|
lastOrder
|
getLastOrder()
|
Last uncancelled order of corporate customer
Order |
|
monetaryValue
|
getMonetaryValue()
|
Monetary value in RFM | |
recencyValue
|
getRecencyValue()
|
Recency value in RFM | |
monetaryClass
|
getMonetaryClass()
|
Monetary-segment in RFM | |
frequencyClass
|
getFrequencyClass()
|
Frequency-segment in RFM | |
recencyClass
|
getRecencyClass()
|
Recency-segment in RFM | |
hasTag
|
hasTag(string name)
|
Check if an object has a tag | |
tags
|
getTags()
|
[array] Tags
[array] Tag |
|
attachments
|
getAttachments()
|
Attachments
[array] Attachment |
|
firstWebVisit
|
getFirstWebVisit()
|
First customer visit on site
Customer visit in site |
|
lastWebVisit
|
getLastWebVisit()
|
Last customer visit on site
Customer visit in site |
|
clientIds
|
getClientIds()
|
Google Analytics unique clientIds
[array] Google Analytics unique clientId |
|
utma
|
getUtma()
|
deprecated Google Analytics unique clientIds
[array] Google Analytics unique clientId |
|
firstClientId
|
getFirstClientId()
|
First Google Analytics unique clientId | |
lastClientId
|
getLastClientId()
|
Last Google Analytics unique clientId | |
customFields
|
getCustomFields()
|
Associative array of custom fields | |
customField
|
getCustomField(string code)
|
Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.
|
|
cumulativeDiscount
|
getCumulativeDiscount()
|
cumulative_discount
|
deprecated Cumulative discount (Not available starting from version 8 of the system)
|
personalDiscount
|
getPersonalDiscount()
|
personal_discount
|
Personal discount |
discountCardNumber
|
getDiscountCardNumber()
|
discount_card_number
|
Discount card number |
totalSumm
|
getTotalSumm()
|
Orders total sum (in base currency) | |
averageSumm
|
getAverageSumm()
|
Order average sum (in base currency) | |
ordersCount
|
getOrdersCount()
|
Orders quantity | |
avgMarginSumm
|
getAvgMarginSumm()
|
Average gross profit of corporate customer orders (in base currency) | |
marginSumm
|
getMarginSumm()
|
LTV (in base currency) | |
#
Corporate customer change
|
|||
customerContact
|
getCustomerContact()
|
Contact person
Contact person |
|
company
|
getCompany()
|
Company
Company |
|
customerAddress
|
getCustomerAddress()
|
Customer address
Customer address |
|
fieldName
|
getFieldName()
|
Field name | |
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Customer change
|
|||
customerSubscription
|
getCustomerSubscription()
|
Client's subscription
Client's subscription |
|
fieldName
|
getFieldName()
|
Field name | |
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Note
|
|||
id
|
getId()
|
Note ID | |
createdAt
|
getCreatedAt()
|
Date/time of creation | |
manager
|
getManager()
|
Manager
User |
|
text
|
getText()
|
Note text | |
#
Customer phone
|
|||
number
|
getNumber()
|
Phone number | |
type
|
getType()
|
Phone type | |
#
Delivery service
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
deliveryType
|
getDeliveryType()
|
Delivery type
Delivery type |
|
active
|
getActive()
|
Activity status | |
#
Delivery type
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
defaultCost
|
getDefaultCost()
|
Default cost (in entity currency) | |
defaultNetCost
|
getDefaultNetCost()
|
Default net cost (in entity currency) | |
description
|
getDescription()
|
Comment | |
paymentTypes
|
getPaymentTypes()
|
deprecated Allowed payment types. Use deliveryPaymentTypes
[array] Payment type |
|
deliveryServices
|
getDeliveryServices()
|
Delivery services included in this delivery type
[array] Delivery service |
|
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
isRussianPost
|
isRussianPost()
|
deprecated Delivery is integrated with Russian Post. Use getIntegrationDeliveryData().is('russianpost')
|
|
isMultiShip
|
isMultiShip()
|
deprecated Delivery is integrated with MultiShip. Use getIntegrationDeliveryData().is('multiship')
|
|
isSdek
|
isSdek()
|
deprecated Delivery is integrated with SDEK. Use getIntegrationDeliveryData().is('sdek')
|
|
isDpd
|
isDpd()
|
deprecated Delivery is integrated with DPD. Use getIntegrationDeliveryData().is('dpd')
|
|
isCourier
|
isCourier()
|
deprecated Courier delivery. Use getIntegrationDeliveryData().is('courier')
|
|
#
Legal entity
|
|||
code
|
getCode()
|
Symbolic code | |
vatRate
|
getVatRate()
|
VAT rate | |
contragentType
|
getContragentType()
|
Legal entity type (field can receive 2 values: legal-entity - legal entity, entrepreneur - individual entrepreneur) | |
legalName
|
getLegalName()
|
Legal name | |
legalAddress
|
getLegalAddress()
|
Registration address | |
INN
|
getINN()
|
TIN | |
OKPO
|
getOKPO()
|
RNNBO | |
KPP
|
getKPP()
|
IECC | |
OGRN
|
getOGRN()
|
PSRN | |
OGRNIP
|
getOGRNIP()
|
PSRN of Individual entrepreneur | |
certificateNumber
|
getCertificateNumber()
|
Certificate number | |
certificateDate
|
getCertificateDate()
|
Certificate date | |
BIK
|
getBIK()
|
RCBIC | |
bank
|
getBank()
|
Bank | |
bankAddress
|
getBankAddress()
|
Bank address | |
corrAccount
|
getCorrAccount()
|
Corresponding account | |
bankAccount
|
getBankAccount()
|
Settlement account | |
#
Coordinates
|
|||
latitude
|
getLatitude()
|
Latitude | |
longitude
|
getLongitude()
|
Longitude | |
#
Price range
|
|||
min
|
getMin()
|
Min value | |
max
|
getMax()
|
Max value | |
#
Information on time range
|
|||
from
|
getFrom()
|
Time "from" | |
to
|
getTo()
|
Time "to" | |
custom
|
getCustom()
|
Time range in free form | |
string
|
getString()
|
Time range as string | |
isEmpty
|
isEmpty()
|
Check if the information on time range is specified | |
#
SKU
|
|||
id
|
getId()
|
SKU ID | |
name
|
getName()
|
Name | |
offerName
|
getOfferName()
|
Returns item name or SKU name | |
displayName
|
getDisplayName()
|
SKU name | |
article
|
getArticle()
|
Vendor code | |
anyArticle
|
getAnyArticle()
|
SKU or item vendor code, if SKU vendor code is absent | |
actualPrice
|
getActualPrice()
|
Returns SKU price or item price, which refers to SKU | |
price
|
getPrice(string priceType = null)
|
SKU price (priceType - price type code, if a certain price type required)
|
|
offerPrice
|
getOfferPrice(string priceType = null)
|
SKU price object (priceType - price type code, if a certain price type required or default price type will be applied)
Available prices |
|
purchasePrice
|
getPurchasePrice()
|
SKU purchasing price (in base currency) | |
properties
|
getProperties()
|
SKU properties | |
product
|
getProduct()
|
Item, which refers to SKU
Product |
|
quantity
|
getQuantity()
|
Available quantity | |
description
|
getDescription()
|
Description | |
externalId
|
getExternalId()
|
SKU ID in store | |
xmlId
|
getXmlId()
|
SKU ID in the warehouse system | |
catalog
|
getCatalog()
|
Catalog
Catalog |
|
site
|
getSite()
|
deprecated Store. Use getCatalog()
Store |
|
createdAt
|
getCreatedAt()
|
System creation date and time | |
active
|
getActive()
|
Activity | |
imageUrl
|
getImageUrl()
|
Image URL | |
unit
|
getUnit()
|
Unit
Unit |
|
vatRate
|
getVatRate()
|
VAT rate | |
barcode
|
getBarcode()
|
Barcode | |
weight
|
getWeight()
|
Weight | |
#
Available prices
|
|||
priceType
|
getPriceType()
|
Price type
Price type |
|
price
|
getPrice()
|
Price (in entity currency) | |
ordering
|
getOrdering()
|
Ordering | |
currency
|
getCurrency()
|
Currency
Currency |
|
#
Order
|
|||
id
|
getId()
|
id
|
Order ID |
externalId
|
getExternalId()
|
Order external ID | |
number
|
getNumber()
|
number
|
Order number |
createdAt
|
getCreatedAt()
|
created_at
|
Order creation date |
orderType
|
getOrderType()
|
order_type
|
Order type
Order type |
orderMethod
|
getOrderMethod()
|
order_method
|
Order method
Order method |
privilegeType
|
getPrivilegeType()
|
privilege_type
|
Privilege type. Possible values: none , personal_discount , loyalty_level , loyalty_event
|
country
|
getCountry()
|
country
|
ISO country code (ISO 3166-1 alpha-2) |
site
|
getSite()
|
site
|
Store
Store |
status
|
getStatus()
|
status
|
Order status
Order status |
statusComment
|
getStatusComment()
|
Comment to the last status change | |
statusUpdatedAt
|
getStatusUpdatedAt()
|
Date of the last order status change | |
manager
|
getManager()
|
manager
|
Order manager
User |
lastName
|
getLastName()
|
last_name
|
Surname |
firstName
|
getFirstName()
|
first_name
|
Name |
patronymic
|
getPatronymic()
|
patronymic
|
Middle name |
nickName
|
getNickName()
|
Full name | |
phone
|
getPhone()
|
phone
|
Phone |
additionalPhone
|
getAdditionalPhone()
|
additional_phone
|
Additional phone |
anyPhone
|
getAnyPhone()
|
Any found phone | |
email
|
getEmail()
|
email
|
|
anyEmail
|
getAnyEmail()
|
Any found e-mail | |
customer
|
getCustomer()
|
customer
|
Customer
Customer Corporate customer |
contact
|
getContact()
|
contact
|
Contact person
Customer |
company
|
getCompany()
|
company
|
Company
Company |
contragent
|
getContragent()
|
Only fields of related entity are recorded in history |
Requisites
Contragent |
orderProducts
|
getOrderProducts()
|
order_product
Else fields of related entity are recorded in history |
Items in order (including cancelled)
[array] Order item |
availableOrderProducts
|
getAvailableOrderProducts()
|
Only fields of related entity are recorded in history |
Items in order (recommended to use this method for getting order items)
[array] Order item |
quantity
|
getQuantity(bool onlyAvailableProducts = true)
|
Total items quantity in order. If to call with parameter getQuantity(false) , then quantity will also include cancelled items
|
|
summ
|
getSumm(bool onlyAvailableProducts = true)
|
Total for goods/services (in entity currency). If to call with parameter getSumm(false) , then sum will also include cancelled items cost
|
|
purchaseSumm
|
getPurchaseSumm()
|
Total purchase sum (in base currency) | |
discountSumm
|
getDiscountSumm()
|
Total amount of items discount (in entity currency) | |
bonusesCreditTotal
|
getBonusesCreditTotal()
|
Amount of accrued bonuses | |
bonusesChargeTotal
|
getBonusesChargeTotal()
|
Amount of debited bonuses | |
deliveryType
|
getDeliveryType()
|
delivery_type
|
Delivery type
Delivery type |
deliveryService
|
getDeliveryService()
|
delivery_service
|
Delivery service
Delivery service |
deliveryAddress
|
getDeliveryAddress()
|
Only fields of related entity are recorded in history |
Delivery address
Delivery address |
deliveryDate
|
getDeliveryDate()
|
delivery_date
|
Delivery date |
deliveryTime
|
getDeliveryTime()
|
delivery_time
|
Delivery time
Information on time range |
deliveryTimeFrom
|
getDeliveryTimeFrom()
|
deprecated Delivery time "from"
|
|
deliveryTimeTo
|
getDeliveryTimeTo()
|
deprecated Delivery time "to"
|
|
deliveryTimeCustom
|
getDeliveryTimeCustom()
|
deprecated Delivery time in free form
|
|
deliveryTimeString
|
getDeliveryTimeString()
|
deprecated Delivery time as string
|
|
deliveryCost
|
getDeliveryCost()
|
delivery_cost
|
Delivery cost (in entity currency) |
deliveryNetCost
|
getDeliveryNetCost()
|
delivery_net_cost
|
Delivery net cost (in entity currency) |
deliveryCostIsManual
|
getDeliveryCostIsManual()
|
Delivery cost is set manually | |
deliveryNetCostIsManual
|
getDeliveryNetCostIsManual()
|
Delivery net cost is set manually | |
integrationDeliveryTrackId
|
getIntegrationDeliveryTrackId()
|
deprecated Tracking number in integrated delivery service. Use getIntegrationDeliveryData().trackNumber
|
|
russianPostTrackNumber
|
getRussianPostTrackNumber()
|
deprecated Tracking number of Russian POst or EMS (if order is delivered this way). Use getIntegrationDeliveryData().trackNumber
|
|
russianPostDeliveryStatus
|
getRussianPostDeliveryStatus()
|
deprecated Delivery status of tracking by Russian Post or EMS. Use getIntegrationDeliveryData().status
|
|
sdekExternalId
|
getSdekExternalId()
|
deprecated Tracking number of SDEK (if order is delivered this way). Use getIntegrationDeliveryData().trackNumber
|
|
courier
|
getCourier()
|
Courier assigned on this order (if order is delivered this way)
Courier |
|
dpdDeliveryName
|
getDpdDeliveryName()
|
deprecated Delivery tariff of DPD. Use getIntegrationDeliveryData().deliveryName
|
|
isDpdPickupPoint
|
isDpdPickupPoint()
|
deprecated Delivery to the terminal for DPD. Use getIntegrationDeliveryData().toPickuppoint
|
|
dpdExternalId
|
getDpdExternalId()
|
deprecated Tracking number of DPD. Use getIntegrationDeliveryData().trackNumber
|
|
integrationDeliveryLocked
|
getIntegrationDeliveryLocked()
|
Do not synchronize with the delivery service (for integrational delivery) | |
discountManualAmount
|
getDiscountManualAmount()
|
discount_manual_amount
|
Monetary discount (in entity currency) |
discountManualPercent
|
getDiscountManualPercent()
|
discount_manual_percent
|
Percentage discount. System rounds this value up to 2 decimals |
personalDiscountPercent
|
getPersonalDiscountPercent()
|
Personal discount on the order | |
discount
|
getDiscount()
|
Monetary discount | |
discountPercent
|
getDiscountPercent()
|
Percentage discount | |
totalDiscount
|
getTotalDiscount()
|
deprecated Total order discount
|
|
loyaltyAccount
|
getLoyaltyAccount()
|
loyalty_account
|
Participation in the loyalty program
Participation in the loyalty program |
loyaltyLevel
|
getLoyaltyLevel()
|
loyalty_level
|
Level of participation in the loyalty program
Level of participation in the loyalty program |
loyaltyEventDiscount
|
getLoyaltyEventDiscount()
|
loyalty_event_discount
|
Discount on the event of the loyalty program
Discount on the event of the loyalty program |
deliveryVatRate
|
getDeliveryVatRate()
|
Delivery VAT rate | |
totalSumm
|
getTotalSumm()
|
total_summ
|
Total sum with discount (in entity currency) |
prepaySum
|
getPrepaySum()
|
prepay_sum
|
Paid sum (in entity currency) |
toPaySumm
|
getToPaySumm()
|
Sum to pay (in entity currency) | |
mark
|
getMark()
|
mark
|
Order evaluation |
markDatetime
|
getMarkDatetime()
|
mark_datetime
|
Date and time of getting evaluation from customer |
expired
|
getExpired()
|
expired
|
Expired |
call
|
getCall()
|
call
|
Call required |
customerComment
|
getCustomerComment()
|
customer_comment
|
Customer comment |
managerComment
|
getManagerComment()
|
manager_comment
|
Operator comment |
marginSumm
|
getMarginSumm()
|
Gross order profit (in entity currency) | |
fromApi
|
getFromApi()
|
from_api
|
Order received through API |
fullPaidAt
|
getFullPaidAt()
|
full_paid_at
|
Full payment date |
payments
|
getPayments()
|
payments
Else fields of related entity are recorded in history |
Payments
[array] Payment |
integrationDeliveryData
|
getIntegrationDeliveryData()
|
Only fields of related entity are recorded in history |
Data of integrated delivery service
Courier delivery service data DDelivery delivery service data Data of the delivery service, connected by API KazPost delivery service data New Post delivery service data |
source
|
getSource()
|
source
|
Order source
Source |
shipmentStore
|
getShipmentStore()
|
shipment_store
|
Shipping warehouse
Warehouse |
shipmentDate
|
getShipmentDate()
|
shipment_date
|
Shipment date |
shipped
|
getShipped()
|
shipped
|
Order is shipped |
isShipmentAllowed
|
isShipmentAllowed()
|
Order is ready for shipping | |
weight
|
getWeight(bool|null getMax = false)
|
weight
|
Weight. For getMax = true returns the maximum weight from common and volumetric weight
|
length
|
getLength()
|
length
|
Length |
width
|
getWidth()
|
width
|
Width |
height
|
getHeight()
|
height
|
Height |
initialProductSumm
|
getInitialProductSumm()
|
Total for goods/services without discounts (in entity currency) | |
paymentStatus
|
getPaymentStatus()
|
deprecated Payment status
Payment status |
|
paymentType
|
getPaymentType()
|
deprecated Payment type
Payment type |
|
paymentDetail
|
getPaymentDetail()
|
deprecated Payment details
|
|
dialog
|
getDialog()
|
MessageGateway dialog
MessageGateway Dialog |
|
attachments
|
getAttachments()
|
Attachments
[array] Attachment |
|
customFields
|
getCustomFields()
|
Associative array of custom fields | |
customField
|
getCustomField(string code)
|
Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.
|
|
secondsToNextOrder
|
getSecondsToNextOrder()
|
Time till next order, in seconds | |
costs
|
getCosts()
|
Cost list
[array] Cost |
|
clientId
|
getClientId()
|
Google Analytics clientId
Google Analytics unique clientId |
|
clientIdString
|
getClientIdString()
|
Google Analytics unique clientId (string) | |
#
Contragent
|
|||
contragentType
|
getContragentType()
|
contragent.contragent_type
|
Contragent type (field can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur) |
legalName
|
getLegalName()
|
contragent.legal_name
|
Legal name |
legalAddress
|
getLegalAddress()
|
contragent.legal_address
|
Registration address |
INN
|
getINN()
|
contragent.i_n_n
|
TIN |
OKPO
|
getOKPO()
|
contragent.o_k_p_o
|
RNNBO |
KPP
|
getKPP()
|
contragent.k_p_p
|
IECC |
OGRN
|
getOGRN()
|
contragent.o_g_r_n
|
PSRN |
OGRNIP
|
getOGRNIP()
|
contragent.o_g_r_n_i_p
|
PSRN of Individual entrepreneur |
certificateNumber
|
getCertificateNumber()
|
contragent.certificate_number
|
Certificate number |
certificateDate
|
getCertificateDate()
|
contragent.certificate_date
|
Certificate date |
BIK
|
getBIK()
|
contragent.b_i_k
|
RCBIC |
bank
|
getBank()
|
contragent.bank
|
Bank |
bankAddress
|
getBankAddress()
|
contragent.bank_address
|
Bank address |
corrAccount
|
getCorrAccount()
|
contragent.corr_account
|
Corresponding account |
bankAccount
|
getBankAccount()
|
contragent.bank_account
|
Settlement account |
#
Delivery address
|
|||
country
|
getCountry()
|
delivery_address.country
|
Country ISO code (ISO 3166-1 alpha-2) |
deliveryTime
|
getDeliveryTime()
|
deprecated Delivery time
|
|
index
|
getIndex()
|
delivery_address.index
|
Postal code |
region
|
getRegion()
|
delivery_address.region
|
Region |
city
|
getCity(bool withType = true)
|
delivery_address.city
|
City (If withType = true , city will be displayed with locality type)
|
cityType
|
getCityType()
|
Locality type | |
street
|
getStreet(bool withType = true)
|
delivery_address.street
|
Street (If withType = true , street will be displayed with type)
|
streetType
|
getStreetType()
|
Street type | |
building
|
getBuilding()
|
delivery_address.building
|
Building |
house
|
getHouse()
|
delivery_address.house
|
House |
housing
|
getHousing()
|
delivery_address.housing
|
Housing |
block
|
getBlock()
|
delivery_address.block
|
Entrance |
flat
|
getFlat()
|
delivery_address.flat
|
Flat/office |
floor
|
getFloor()
|
delivery_address.floor
|
Floor |
metro
|
getMetro()
|
delivery_address.metro
|
Underground |
text
|
getText()
|
Address as string | |
notes
|
getNotes()
|
delivery_address.notes
|
Notes to address |
isEmpty
|
isEmpty()
|
Address is empty | |
fullAddressString
|
getFullAddressString(bool withIndex = true, bool getAnyForm = false)
|
Address as string collected from fields. Parameter withIndex allows to display postal code
|
|
#
Order change
|
|||
orderProduct
|
getOrderProduct()
|
Order item to which the change of the field relates
Order item |
|
payment
|
getPayment()
|
Payment to which the change of the field relates
Payment |
|
fieldName
|
getFieldName()
|
Field name | |
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Order method
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
defaultForApi
|
getDefaultForApi()
|
Set by default for orders received through API | |
#
Printed form
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Name of printed form | |
#
Order item
|
|||
id
|
getId()
|
order_product.id
|
ID of order item |
order
|
getOrder()
|
Only fields of related entity are recorded in history |
Order
Order |
offer
|
getOffer()
|
SKU
SKU |
|
initialPrice
|
getInitialPrice()
|
order_product.initial_price
|
Item price/SKU (in entity currency) |
discount
|
getDiscount()
|
deprecated Monetary discount per item
|
|
discountPercent
|
getDiscountPercent()
|
deprecated Percentage discount per item
|
|
price
|
getPrice()
|
Item price with discount (in entity currency) | |
quantity
|
getQuantity()
|
order_product.quantity
|
Quantity |
statusUpdatedAt
|
getStatusUpdatedAt()
|
Date of last status change of the order item | |
comment
|
getComment()
|
order_product.comment
|
Comment to the order item |
status
|
getStatus()
|
order_product.status
|
Status of the order item
Item status in order |
orderStatus
|
getOrderStatus()
|
Order status when changing of item status | |
initialSumm
|
getInitialSumm()
|
Item price considering quantity (in entity currency) | |
discountSumm
|
getDiscountSumm()
|
Item discount considering quantity (in entity currency) | |
summ
|
getSumm()
|
order_product.summ
|
Item total sum considering discount and quantity (in entity currency) |
unit
|
getUnit()
|
Unit
Unit |
|
createdAt
|
getCreatedAt()
|
Date of order item creation in the system | |
properties
|
getProperties()
|
[array] Additional properties of the order item | |
packs
|
getPacks()
|
Item packs, within the one item position (including cancelled)
[array] Pack - items pack, within the one item position, from one warehouse |
|
availablePacks
|
getAvailablePacks()
|
Available item packs, within the one item position (recommended to use this method for getting items packs)
[array] Pack - items pack, within the one item position, from one warehouse |
|
isCanceledForApi
|
isCanceledForApi()
|
This order item is cancelled in the order | |
isCanceled
|
isCanceled()
|
This order item is cancelled in the order | |
discountManualAmount
|
getDiscountManualAmount()
|
order_product.discount_manual_amount
|
Monetary discount per item (in entity currency) |
discountManualPercent
|
getDiscountManualPercent()
|
order_product.discount_manual_percent
|
Percentage discount per item. System rounds this value up to 2 decimals |
bonusesCredit
|
getBonusesCredit()
|
order_product.bonuses_credit
|
Amount of accrued bonuses |
bonusesCharge
|
getBonusesCharge()
|
order_product.bonuses_charge
|
Amount of debited bonuses |
discountTotal
|
getDiscountTotal()
|
order_product.discount_total
|
Final monetary discount per item including all item and order discounts (in entity currency) |
basePurchasePrice
|
getBasePurchasePrice()
|
order_product.base_purchase_price
|
Base purchasing price (in base currency) |
purchasePrice
|
getPurchasePrice()
|
Purchasing price (in base currency) | |
purchaseSumm
|
getPurchaseSumm()
|
Item purchasing price considering quantity (in base currency) | |
priceType
|
getPriceType()
|
order_product.price_type
|
Price type
Price type |
vatRate
|
getVatRate()
|
order_product.vat_rate
|
VAT rate |
markingCodes
|
getMarkingCodes()
|
Marking codes
[array] Product marking code |
|
#
Product marking code
|
|||
id
|
getId()
|
ID code marking | |
code
|
getCode()
|
Meaning of the marking code | |
#
Item status in order
|
|||
code
|
getCode()
|
Symbolic code | |
ordering
|
getOrdering()
|
Ordering | |
active
|
getActive()
|
Activity status | |
isCancelStatus
|
isCancelStatus()
|
Is cancellation status | |
createdAt
|
getCreatedAt()
|
Creation date | |
name
|
getName()
|
Name | |
#
Order type
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
defaultForApi
|
getDefaultForApi()
|
Set by default for orders received through API | |
ordering
|
getOrdering()
|
Ordering | |
#
Payment
|
|||
id
|
getId()
|
payments.id
|
Payment ID |
status
|
getStatus()
|
payments.status
|
Payment Status
Payment status |
type
|
getType()
|
payments.type
|
Payment Type
Payment type |
externalId
|
getExternalId()
|
payments.external_id
|
External ID |
amount
|
getAmount()
|
payments.amount
|
Amount (in entity currency) |
paidAt
|
getPaidAt()
|
payments.paid_at
|
Payment date. Don't forget to check the status of payment |
comment
|
getComment()
|
payments.comment
|
Comment |
#
Payment status
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
defaultForApi
|
getDefaultForApi()
|
Set by default for orders received through API | |
ordering
|
getOrdering()
|
Ordering | |
description
|
getDescription()
|
Comment | |
externalId
|
getExternalId()
|
External ID | |
paymentComplete
|
getPaymentComplete()
|
The sigh that order is paid | |
isPaymentComplete
|
isPaymentComplete()
|
The sigh that order is paid | |
#
Payment type
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
defaultForApi
|
getDefaultForApi()
|
Set by default for orders received through API | |
description
|
getDescription()
|
Comment | |
#
Price type
|
|||
code
|
getCode()
|
Symbolic code | |
#
Product
|
|||
id
|
getId()
|
Product ID | |
typeCode
|
getTypeCode()
|
Type (product product or service service )
|
|
article
|
getArticle()
|
Vendor code | |
name
|
getName()
|
Name | |
displayName
|
getDisplayName()
|
Manufacturer + item name | |
active
|
getActive()
|
Activity | |
quantity
|
getQuantity()
|
Quantity | |
minPrice
|
getMinPrice(array<PriceType> priceTypes = [])
|
Minimum item price (in base currency) | |
maxPrice
|
getMaxPrice(array<PriceType> priceTypes = [])
|
Maximum item price (in base currency) | |
offersPriceRange
|
getOffersPriceRange(array<PriceType> priceTypes = [])
|
[array] Array of minimum and maximum item price
Price range |
|
minPurchasePrice
|
getMinPurchasePrice()
|
Minimum item purchasing price (in base currency) | |
maxPurchasePrice
|
getMaxPurchasePrice()
|
Maximum item purchasing price (in base currency) | |
weight
|
getWeight()
|
Weight | |
minWeight
|
getMinWeight()
|
Minimum weight | |
maxWeight
|
getMaxWeight()
|
Maximum weight | |
unit
|
getUnit()
|
Unit
Unit |
|
url
|
getUrl()
|
Link to item page in the web-store | |
imageUrl
|
getImageUrl()
|
Image URL | |
description
|
getDescription()
|
Description | |
catalog
|
getCatalog()
|
Catalog
Catalog |
|
site
|
getSite()
|
deprecated Store. Use getCatalog()
Store |
|
manufacturer
|
getManufacturer()
|
Manufacturer | |
offers
|
getOffers()
|
SKUs
[array] SKU |
|
popular
|
getPopular()
|
Mark Sales leader | |
stock
|
getStock()
|
Mark Best price | |
novelty
|
getNovelty()
|
Mark New | |
recommended
|
getRecommended()
|
Mark Recommended | |
externalId
|
getExternalId()
|
Item external ID | |
groups
|
getGroups()
|
Item groups, which contains this item
[array] Item group |
|
createdAt
|
getCreatedAt()
|
Order creation date in the system | |
updatedAt
|
getUpdatedAt()
|
Date of editing the product in the system | |
abcClass
|
getAbcClass(int customerType = 0)
|
ABC-classification of item | |
xyzClass
|
getXyzClass(int customerType = 0)
|
XYZ-classification of item | |
#
Item group
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Name | |
nameWithDepth
|
getNameWithDepth()
|
The name with indent, which matches to level of nesting | |
description
|
getDescription()
|
Description | |
catalog
|
getCatalog()
|
Catalog
Catalog |
|
site
|
getSite()
|
Store
Store |
|
lvl
|
getLvl()
|
Nesting level | |
parent
|
getParent()
|
Parental item group
Item group |
|
externalId
|
getExternalId()
|
Item group external ID | |
#
Item property
|
|||
visible
|
getVisible()
|
Property visibility | |
variative
|
getVariative()
|
Property variability | |
#
Store
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Name | |
url
|
getUrl()
|
Store URL | |
description
|
getDescription()
|
Comment | |
active
|
getActive()
|
Activity status | |
defaultForCrm
|
getDefaultForCrm()
|
Set by default for orders created in system | |
ordering
|
getOrdering()
|
Ordering | |
legalEntity
|
getLegalEntity()
|
deprecated Legal entity. Use LegalEntity.legalName
|
|
inn
|
getInn()
|
deprecated TIN. Use LegalEntity.INN
|
|
giro
|
getGiro()
|
deprecated Settlement account. Use LegalEntity.bankAccount
|
|
corrAccount
|
getCorrAccount()
|
deprecated Corresponding account. Use LegalEntity.corrAccount
|
|
phones
|
getPhones()
|
Store phones | |
address
|
getAddress()
|
Store address | |
zip
|
getZip()
|
Zip code | |
createdAt
|
getCreatedAt()
|
Store creation date in the system | |
code
|
getCode()
|
Store symbolic code | |
contragent
|
getContragent()
|
Legal entity
Legal entity |
|
country
|
getCountry()
|
Default country | |
#
Source
|
|||
id
|
getId()
|
Source ID | |
sourceName
|
getSourceName()
|
Source as string | |
mediumName
|
getMediumName()
|
Medium | |
campaignName
|
getCampaignName()
|
Campaign | |
keywordName
|
getKeywordName()
|
Keyword | |
adContentName
|
getAdContentName()
|
Ad content | |
#
Order status
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
ordering
|
getOrdering()
|
Ordering | |
group
|
getGroup()
|
Status group, which contains this status
Status group |
|
groupCode
|
getGroupCode()
|
Symbolic code of the status group, which contains this status | |
#
Status group
|
|||
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
active
|
getActive()
|
Activity status | |
ordering
|
getOrdering()
|
Ordering | |
process
|
getProcess()
|
Is the order processing status or not | |
custom
|
getCustom()
|
The sign that group is added by user | |
editable
|
getEditable()
|
Is the group editable | |
statuses
|
getStatuses()
|
Orders statuses included in this group
[array] Order status |
|
statusesCode
|
getStatusesCode()
|
[array] Symbolic codes of order statuses included in this group | |
color
|
getColor()
|
Color used when displaying group | |
#
Unit
|
|||
code
|
getCode()
|
Unit symbolic code | |
name
|
getName()
|
Unit name | |
sym
|
getSym()
|
Unit short name | |
#
Change set
|
|||
isCreate
|
isCreate()
|
Content is created | |
isUpdate
|
isUpdate()
|
Content is edited | |
isDelete
|
isDelete()
|
Content is deleted | |
changedField
|
getChangedField(string field)
|
Set of old and new values of the field. Field code in the history should be specified in field
Corporate customer change Customer change Order change Task change |
|
hasChangedField
|
hasChangedField(string field)
|
Verification that the field has changed | |
hasChanges
|
hasChanges()
|
Are there any changes | |
hasChangesExcluding
|
hasChangesExcluding(array keys)
|
If there are any changes in fields except the specified ones | |
oldValue
|
getOldValue(string field)
|
Old value of specified field. Field code in the history should be specified in field
|
|
newValue
|
getNewValue(string field)
|
New value of specified field. Field code in the history should be specified in field
|
|
authorOfChange
|
getAuthorOfChange(string field)
|
Returns a user, who changed the specified field. Field code in the history should be specified in field
User |
|
sourceOfChange
|
getSourceOfChange(string field)
|
Source of changes (API api , user user , trigger rule , system code , separation split , copying copy or combination with another object combine )
|
|
apiKeyOfChange
|
getApiKeyOfChange(string field)
|
Returns an API key, that changed the specified field. Field code in the history should be specified in field
API key |
|
hasChangesWithSource
|
hasChangesWithSource(string|null source)
|
Verification that there are changes from specified source
|
|
ruleOfChange
|
getRuleOfChange(string field)
|
Returns a trigger, that changed the specified field. Field code in the history should be specified in field
Trigger |
|
#
API key
|
|||
id
|
getId()
|
Internal identifier of the API key | |
#
Users group
|
|||
code
|
getCode()
|
Code | |
name
|
getName()
|
Name | |
isManager
|
getIsManager()
|
Group processes orders | |
id
|
getId()
|
ID | |
#
User
|
|||
active
|
getActive()
|
Active | |
emailAddress
|
getEmailAddress()
|
User email | |
firstName
|
getFirstName()
|
Name | |
lastName
|
getLastName()
|
Surname | |
patronymic
|
getPatronymic()
|
Middle name | |
nickName
|
getNickName()
|
Full name | |
cutName
|
getCutName()
|
Name and surname | |
isManager
|
isManager()
|
User is a manager | |
isAdmin
|
isAdmin()
|
Is an administrator | |
isDeliveryMan
|
isDeliveryMan()
|
User is responsible for delivery | |
restrictedByDeliveryTypes
|
restrictedByDeliveryTypes()
|
User access to order is restricted by delivery types | |
allowedDeliveryTypes
|
getAllowedDeliveryTypes()
|
List of delivery types which allow the user to view orders if the setting restricting access to orders by delivery types is selected restrictedByDeliveryTypes . When using, always check that restrictedByDeliveryTypes has true value
[array] Delivery type |
|
restrictingDeliveryTypes
|
getRestrictingDeliveryTypes()
|
deprecated Use allowedDeliveryTypes . List of delivery types which allow the user to view orders if the setting restricting access to orders by delivery types is selected restrictedByDeliveryTypes . When using, always check that restrictedByDeliveryTypes has true value
[array] Delivery type |
|
groupCodes
|
getGroupCodes()
|
Symbolic codes of user groups | |
hasGroup
|
hasGroup(string|null name)
|
Verification that the user included in specified group | |
position
|
getPosition()
|
Position | |
phone
|
getPhone()
|
Phone | |
phoneTfa
|
getPhoneTfa()
|
Phone number for authentication | |
createdAt
|
getCreatedAt()
|
User creation date | |
language
|
getLanguage()
|
Language | |
id
|
getId()
|
User ID | |
ordersCount
|
getOrdersCount()
|
The average number of orders assigned to a manager | |
customersCount
|
getCustomersCount()
|
The average number of customers assigned to a manager | |
totalSaleSumm
|
getTotalSaleSumm()
|
Total sum of orders aasigned to a manager (in base currency) | |
avgSaleSumm
|
getAvgSaleSumm()
|
Average value of orders assigned to a manager (in base currency) | |
marginSumm
|
getMarginSumm()
|
Total margin of orders assigned to a manager (in base currency) | |
avgMarginSumm
|
getAvgMarginSumm()
|
Average margin of orders assigned to a manager (in base currency) | |
#
Google Analytics unique clientId
|
|||
clientId
|
getClientId()
|
ClientId value | |
createdAt
|
getCreatedAt()
|
Creation date | |
#
Customer visit in site
|
|||
createdAt
|
getCreatedAt()
|
Datetime of visit starting | |
finishedAt
|
getFinishedAt()
|
Datetime of visit ending | |
visitLength
|
getVisitLength()
|
Visit duration in seconds | |
landingPage
|
getLandingPage()
|
Enter page | |
exitPage
|
getExitPage()
|
Exit page | |
pageviews
|
getPageviews()
|
Pages quantity per visit | |
pageDepth
|
getPageDepth()
|
Page depth | |
clientId
|
getClientId()
|
ClientId of the visit
Google Analytics unique clientId |
|
#
Call
|
|||
id
|
getId()
|
Call ID | |
date
|
getDate()
|
Date/time of call | |
type
|
getType()
|
Call type (incoming in or outgoing out )
|
|
isMissing
|
isMissing()
|
Call is missed | |
phone
|
getPhone()
|
Phone number | |
code
|
getCode()
|
Extension of user, who processed the call | |
result
|
getResult()
|
Call result (possible values: failed , answered , busy , no answer , not allowed , unknown )
|
|
manager
|
getManager()
|
User, who processed the call
User |
|
externalId
|
getExternalId()
|
Call ID in PBX | |
duration
|
getDuration()
|
Call duration (in seconds) | |
customer
|
getCustomer()
|
Customer, who received or initiated call (may be absent)
Customer Corporate customer |
|
order
|
getOrder()
|
Order related with call (may be absent)
Order |
|
source
|
getSource()
|
Source
Source |
|
site
|
getSite()
|
Store
Store |
|
externalPhone
|
getExternalPhone()
|
External phone number | |
hasTag
|
hasTag(string name)
|
Check if an object has a tag | |
#
Email
|
|||
isOpened
|
isOpened()
|
Returns the flag that determines whether the message was opened | |
isClicked
|
isClicked()
|
Returns a flag that determines whether the link in the message was clicked | |
#
SMS
|
|||
isDelivered
|
isDelivered()
|
Returns a flag that determines whether the message was delivered | |
#
Directory element
|
|||
name
|
getName()
|
Name | |
active
|
getActive()
|
Available for usage or deleted | |
code
|
getCode()
|
Symbolic code | |
#
Courier delivery service data
|
|||
courier
|
getCourier()
|
integration_delivery_data.courier
|
Courier
Courier |
is
|
is(string code)
|
Returns true if transmitted code matches to delivery service code (.is('courier') )
|
|
#
DDelivery delivery service data
|
|||
externalId
|
getExternalId()
|
Delivery id in delivery service | |
deliveryName
|
getDeliveryName()
|
integration_delivery_data.delivery_name
|
Delivery service name |
days
|
getDays()
|
Approximate delivery time | |
state
|
getState()
|
integration_delivery_data.state
|
Status of delivery registration (none - Didn’t pass registration, processing - Waiting for registration, cancel - Cancellation, success - Successfully, error - Error)
|
is
|
is(string code)
|
Returns true if transmitted code matches to delivery service code (.is('ddelivery') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Track number |
status
|
getStatus()
|
integration_delivery_data.status
|
Delivery status code |
isLocked
|
isLocked()
|
Do not synchronize with the delivery service | |
pickuppointAddress
|
getPickuppointAddress()
|
integration_delivery_data.pickuppoint_address
|
Pickup point address |
declaredSum
|
getDeclaredSum()
|
Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account) | |
#
Data of the delivery service, connected by API
|
|||
externalId
|
getExternalId()
|
Delivery id in delivery service | |
statusText
|
getStatusText()
|
Delivery status name | |
statusDate
|
getStatusDate()
|
Delivery status date | |
tariff
|
getTariff()
|
Tariff code | |
tariffName
|
getTariffName()
|
integration_delivery_data.tariff_name
|
Tariff name |
pickuppointId
|
getPickuppointId()
|
Pickup point ID | |
pickuppointSchedule
|
getPickuppointSchedule()
|
Pickup point working time | |
pickuppointPhone
|
getPickuppointPhone()
|
Pickup point phone | |
pickuppointCoordinateLatitude
|
getPickuppointCoordinateLatitude()
|
Pickup point coordinates, latitude | |
pickuppointCoordinateLongitude
|
getPickuppointCoordinateLongitude()
|
Pickup point coordinates, longitude | |
statusComment
|
getStatusComment()
|
Comment to delivery status | |
cost
|
getCost()
|
Delivery cost received from delivery service (in entity currency) | |
deliveryTerm
|
getDeliveryTerm()
|
Approximate delivery time | |
shipmentpointId
|
getShipmentpointId()
|
Shipment terminal ID | |
shipmentpointAddress
|
getShipmentpointAddress()
|
Shipment terminal address | |
shipmentpointSchedule
|
getShipmentpointSchedule()
|
Pickup point working time shipment terminal | |
shipmentpointPhone
|
getShipmentpointPhone()
|
Shipment terminal phone | |
extraData
|
getExtraData()
|
Additional delivery data (deliveryDataField.code => value )
|
|
state
|
getState()
|
integration_delivery_data.state
|
Status of delivery registration (none - Didn’t pass registration, processing - Waiting for registration, cancel - Cancellation, success - Successfully, error - Error)
|
is
|
is(string code)
|
Returns true if transmitted code matches to delivery service code (.is('generic') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Track number (deprecated for write)
|
status
|
getStatus()
|
integration_delivery_data.status
|
Delivery status code |
isLocked
|
isLocked()
|
Do not synchronize with the delivery service | |
pickuppointAddress
|
getPickuppointAddress()
|
integration_delivery_data.pickuppoint_address
|
Pickup point address |
declaredSum
|
getDeclaredSum()
|
Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account) | |
presentationPackages
|
getPresentationPackages()
|
Packages | |
packagesCount
|
getPackagesCount(bool createPackageFromOrder = true)
|
Number of packages. The createPackageFromOrder parameter (by default - true ) determines whether a package should be generated based on the order data if there are no other packages in the order.
|
|
#
KazPost delivery service data
|
|||
is
|
is(string code)
|
Returns true if transmitted code matches to delivery service code (.is('kazpost') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Track number |
status
|
getStatus()
|
integration_delivery_data.status
|
Delivery status code |
#
New Post delivery service data
|
|||
days
|
getDays()
|
Approximate delivery time | |
receiverWarehouse
|
getReceiverWarehouse()
|
integration_delivery_data.receiver_warehouse
|
Post office number and address |
price
|
getPrice()
|
Delivery cost received from delivery service | |
afterpaymentOnGoodsCost
|
getAfterpaymentOnGoodsCost()
|
Payment control (in entity currency) | |
state
|
getState()
|
integration_delivery_data.state
|
Status of delivery registration (none - Didn’t pass registration, processing - Waiting for registration, cancel - Cancellation, success - Successfully, error - Error)
|
is
|
is(string code)
|
Returns true if transmitted code matches to delivery service code (.is('newpost') )
|
|
trackNumber
|
getTrackNumber()
|
integration_delivery_data.track_number
|
Track number |
status
|
getStatus()
|
integration_delivery_data.status
|
Delivery status code |
isLocked
|
isLocked()
|
Do not synchronize with the delivery service | |
declaredSum
|
getDeclaredSum()
|
Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account) | |
#
Package
|
|||
packageId
|
getPackageId()
|
Package number | |
weight
|
getWeight()
|
Weight | |
length
|
getLength()
|
Length | |
width
|
getWidth()
|
Width | |
height
|
getHeight()
|
Height | |
items
|
getItems()
|
Package content | |
#
Trigger
|
|||
code
|
getCode()
|
Trigger code | |
#
Trigger data of "Message delivery"
|
|||
letters
|
getLetters()
|
The list of sent messages as a result of trigger action
[array] Email |
|
#
Trigger data of "Send message to chat"
|
|||
mgMessages
|
getMgMessages()
|
The list of messages sent as a result of the trigger action
[array] Message in chats |
|
#
Trigger data of "SMS Delivery"
|
|||
sms
|
getSms()
|
SMS sent as a result of trigger action
SMS |
|
#
Data when the trigger occurs
|
|||
actions
|
getActions()
|
Data list when trigger is activated
[array] Trigger data not associated with mailing [array] Trigger data of "Message delivery" [array] Trigger data of "Send message to chat" [array] Trigger data of "SMS Delivery" |
|
#
Task
|
|||
id
|
getId()
|
id
|
Task ID |
text
|
getText()
|
text
|
Task text |
commentary
|
getCommentary()
|
commentary
|
Commentary, related to the task |
datetime
|
getDatetime()
|
datetime
|
Task execution date |
createdAt
|
getCreatedAt()
|
created_at
|
Creation date |
complete
|
getComplete()
|
complete
|
Sign of the task execution |
user
|
getUser()
|
user
|
Task author
User |
performer
|
getPerformer()
|
performer
|
Task executor
Users group User |
customer
|
getCustomer()
|
customer
|
Customer, related to the task
Customer Corporate customer |
order
|
getOrder()
|
order
|
Order, related to the task
Order |
phone
|
getPhone()
|
phone
|
Phone number, related to the task |
phoneSite
|
getPhoneSite()
|
phone_site
|
Store, related to recall task
Store |
completedAt
|
getCompletedAt()
|
completed_at
|
Task completion time |
taskComments
|
getTaskComments()
|
comments
Else fields of related entity are recorded in history |
User comments on the task
[array] User comment on the task |
hasTag
|
hasTag(string name)
|
Check if an object has a tag | |
tags
|
getTags()
|
Tags
[array] Tag |
|
#
User comment on the task
|
|||
id
|
getId()
|
comments.id
|
Task comment ID |
text
|
getText()
|
comments.text
|
Task comment text |
#
Task change
|
|||
taskComment
|
getTaskComment()
|
User comment on the task
User comment on the task |
|
fieldName
|
getFieldName()
|
Field name | |
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Courier
|
|||
id
|
getId()
|
Courier ID | |
active
|
getActive()
|
Activity status | |
createdAt
|
getCreatedAt()
|
Courier creation date in the system | |
email
|
getEmail()
|
||
phone
|
getPhone()
|
Contact phone
Courier phone |
|
name
|
getName()
|
deprecated Fullname. Use fullName instead
|
|
firstName
|
getFirstName()
|
First name | |
lastName
|
getLastName()
|
Last name | |
patronymic
|
getPatronymic()
|
Patronymic | |
fullName
|
getFullName()
|
Full name | |
description
|
getDescription()
|
Description | |
#
Courier phone
|
|||
number
|
getNumber()
|
Phone number | |
type
|
getType()
|
Phone type | |
#
Item movement
|
|||
shipmentDate
|
getShipmentDate()
|
Date of collection from warehouse | |
storeTo
|
getStoreTo()
|
Bringing warehouse
Warehouse |
|
storeFrom
|
getStoreFrom()
|
Collection warehouse
Warehouse |
|
courier
|
getCourier()
|
Courier
Courier |
|
completed
|
getCompleted()
|
Movement has been carried out | |
#
Pack - items pack, within the one item position, from one warehouse
|
|||
id
|
getId()
|
ID | |
purchasePrice
|
getPurchasePrice()
|
Purchasing price (in base currency) | |
quantity
|
getQuantity()
|
Item quantity in pack | |
store
|
getStore()
|
Warehouse
Warehouse |
|
orderProduct
|
getOrderProduct()
|
Related item position in order
Order item |
|
reserve
|
getReserve()
|
Pack reservation
Pack reservation |
|
purchaseSumm
|
getPurchaseSumm()
|
Purchasing sum for pack (in base currency) | |
summ
|
getSumm()
|
Total sum for pack (in entity currency) | |
shipmentStore
|
getShipmentStore()
|
Shipping warehouse
Warehouse |
|
reserveStore
|
getReserveStore()
|
Reservation warehouse
Warehouse |
|
movement
|
getMovement()
|
Item movement
Item movement |
|
deliveryNoteNumber
|
getDeliveryNoteNumber()
|
Packing list number | |
invoiceNumber
|
getInvoiceNumber()
|
Invoice number | |
shipmentDate
|
getShipmentDate()
|
Pack shipment date | |
offer
|
getOffer()
|
SKU
SKU |
|
order
|
getOrder()
|
Order
Order |
|
isCanceled
|
isCanceled()
|
Pack transferred to cancellation status | |
status
|
getStatus()
|
Item pack status
Item status in order |
|
comment
|
getComment()
|
Comment to status | |
#
Set of changes in the collecting history
|
|||
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Printed form
|
|||
id
|
getId()
|
ID | |
name
|
getName()
|
Name of printed form | |
#
Pack reservation
|
|||
id
|
getId()
|
ID | |
quantity
|
getQuantity()
|
Quantity | |
store
|
getStore()
|
Warehouse
Warehouse |
|
purchasePrice
|
getPurchasePrice()
|
Purchasing price (in base currency) | |
createdAt
|
getCreatedAt()
|
Reservation creation date | |
orderProductPack
|
getOrderProductPack()
|
Related pack
Pack - items pack, within the one item position, from one warehouse |
|
#
Warehouse
|
|||
id
|
getId()
|
Warehouse ID | |
active
|
getActive()
|
Activity status | |
ordering
|
getOrdering()
|
Ordering | |
description
|
getDescription()
|
Warehouse description | |
address
|
getAddress()
|
Warehouse address
Warehouse address |
|
type
|
getType()
|
Warehouse type (store-type-retail - retail store, store-type-online - online-store, store-type-warehouse - warehouse, store-type-supplier - the supplier's warehouse)
|
|
externalId
|
getExternalId()
|
External ID | |
phone
|
getPhone()
|
Warehouse phone
Warehouse phone |
|
contact
|
getContact()
|
Contact person at the warehouse | |
createdAt
|
getCreatedAt()
|
Warehouse creation date in the system | |
code
|
getCode()
|
Symbolic code | |
email
|
getEmail()
|
Warehouse email | |
workTimes
|
getWorkTimes()
|
Working time
[array] Warehouse work time |
|
name
|
getName()
|
Name | |
#
Warehouse address
|
|||
coordinates
|
getCoordinates()
|
Coordinates (Type Model\Point )
Coordinates |
|
index
|
getIndex()
|
Postal code | |
country
|
getCountry()
|
Country | |
region
|
getRegion()
|
Region | |
city
|
getCity(bool withType = true)
|
City (If withType = true , city will be displayed with locality type)
|
|
cityType
|
getCityType()
|
Locality type | |
street
|
getStreet(bool withType = true)
|
Street (If withType = true , street will be displayed with type)
|
|
streetType
|
getStreetType()
|
Street type | |
building
|
getBuilding()
|
Building | |
house
|
getHouse()
|
House | |
housing
|
getHousing()
|
Housing | |
block
|
getBlock()
|
Entrance | |
flat
|
getFlat()
|
Flat/office | |
floor
|
getFloor()
|
Floor | |
metro
|
getMetro()
|
Underground | |
text
|
getText()
|
Address as string | |
notes
|
getNotes()
|
Notes to address | |
isEmpty
|
isEmpty()
|
Address is empty | |
fullAddressString
|
getFullAddressString(bool withIndex = true, bool getAnyForm = false)
|
Address as string collected from fields. Parameter withIndex allows to display postal code
|
|
#
Warehouse phone
|
|||
number
|
getNumber()
|
Phone number | |
type
|
getType()
|
Phone type | |
#
Warehouse work time
|
|||
day
|
getDay()
|
Day of the week (0 - Sunday, 6 - Saturday) | |
workFrom
|
getWorkFrom()
|
Start of the warehouse work time interval (in H:i format)
|
|
workUntil
|
getWorkUntil()
|
End of the warehouse work time interval (in H:i format)
|
|
lunchFrom
|
getLunchFrom()
|
Start of the lunch time interval (in H:i format)
|
|
lunchUntil
|
getLunchUntil()
|
End of the lunch time interval (in H:i format)
|
|
#
Segment
|
|||
name
|
getName()
|
Segment name | |
isDynamic
|
getIsDynamic()
|
Is this segment dynamic | |
customersCount
|
getCustomersCount()
|
Customer quantity in segment | |
generatedAt
|
getGeneratedAt()
|
Time of the last segment generation | |
code
|
getCode()
|
Symbolic code | |
#
Segment criterion value
|
|||
value
|
getValue()
|
The scalar value of filter | |
min
|
getMin()
|
Minimum value for numeric and monetary filter | |
max
|
getMax()
|
Maximum value for numeric and monetary filter | |
isNegated
|
isNegated()
|
Criterion on this value was inverted | |
isNotEmpty
|
isNotEmpty()
|
Object contains criterions | |
#
Birthday event
|
|||
id
|
getId()
|
Event ID | |
privilegeType
|
getPrivilegeType()
|
Type of privilege on the event. Possible values: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Discount amount for products at a regular price | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Discount amount for products at a promotion price | |
#
Custom event
|
|||
id
|
getId()
|
Event ID | |
privilegeType
|
getPrivilegeType()
|
Type of privilege on the event. Possible values: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Discount amount for products at a regular price | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Discount amount for products at a promotion price | |
#
Loyalty program
|
|||
id
|
getId()
|
Loyalty program ID | |
name
|
getName()
|
Loyalty program name | |
#
Participation in the loyalty program
|
|||
id
|
getId()
|
Participation ID | |
isActive
|
isActive()
|
Flag of active participation | |
loyalty
|
getLoyalty()
|
Loyalty program
Loyalty program |
|
createdAt
|
getCreatedAt()
|
Creation date | |
status
|
getStatus()
|
Participation status. Possible values: not_confirmed , activated , deactivated
|
|
phoneNumber
|
getPhoneNumber()
|
Phone number | |
cardNumber
|
getCardNumber()
|
Card number | |
amount
|
getAmount()
|
Active bonus amount | |
awaitingAmount
|
getAwaitingAmount()
|
Bonuses waiting to be activated | |
ordersSum
|
getOrdersSum()
|
Orders total sum (in entity currency) | |
level
|
getLevel()
|
Level of participation
Level of participation in the loyalty program |
|
customFields
|
getCustomFields()
|
Associative array of custom fields | |
customField
|
getCustomField(string code)
|
Returns value of the specific custom field | |
#
Information about the bonus account of the participation
|
|||
activeAmount
|
getActiveAmount()
|
Active bonuses | |
waitingActivationAmount
|
getWaitingActivationAmount()
|
Bonus amount waiting to be activated | |
burnSoonAmount
|
getBurnSoonAmount(int day = 30)
|
Bonus amount that will soon expire (you can pass the expiration period in days in the argument) | |
burnedAmount
|
getBurnedAmount()
|
Bonuses expired for the entire time of participation | |
spentAmount
|
getSpentAmount()
|
Bonuses redeemed for the entire time of participation | |
addedAmount
|
getAddedAmount()
|
Bonuses accrued for the entire time of participation | |
#
Change of participation in the loyalty program
|
|||
fieldName
|
getFieldName()
|
Field name | |
oldValue
|
getOldValue()
|
Old value | |
newValue
|
getNewValue()
|
New value | |
#
Discount on the event of the loyalty program
|
|||
discount
|
getDiscount()
|
Discount amount for products at a regular price | |
loyaltyEvent
|
getLoyaltyEvent()
|
Event
Birthday event Custom event Welcome-bonuses event |
|
discountPromo
|
getDiscountPromo()
|
Discount amount for products at a promotion price | |
isExpired
|
isExpired()
|
Expired | |
#
Level of participation in the loyalty program
|
|||
id
|
getId()
|
Level ID | |
name
|
getName()
|
Level name | |
type
|
getType()
|
Level type. Possible values: bonus_converting , bonus_percent , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Discount amount, percentage or rate of bonus accrual for products at a regular price (in entity currency) | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Discount amount, percentage or rate of bonus accrual for promotional products (in entity currency) | |
isDiscountPrivilegeType
|
isDiscountPrivilegeType()
|
Type of privileges - discount | |
isBonusPrivilegeType
|
isBonusPrivilegeType()
|
Type of privileges - bonuses | |
#
Operation with bonus account
|
|||
createdAt
|
getCreatedAt()
|
Date of operation | |
reason
|
getReason()
|
Type of action with bonuses. Possible values: credit_for_order , burn , credit_for_event , charge_for_order , charge_manual , credit_manual , cancel_of_charge , cancel_of_credit , trigger_credit
|
|
loyaltyAccount
|
getLoyaltyAccount()
|
Participation in loyalty program
Participation in the loyalty program |
|
customer
|
getCustomer()
|
Customer
Customer |
|
amount
|
getAmount()
|
Sum of operation | |
type
|
getType()
|
Type of operation. Possible values: credit , charge
|
|
comment
|
getComment()
|
Comment | |
order
|
getOrder()
|
Order
Order |
|
manager
|
getManager()
|
Initiator
User |
|
#
Welcome-bonuses event
|
|||
id
|
getId()
|
Event ID | |
privilegeType
|
getPrivilegeType()
|
Type of privilege on the event. Possible values: bonus , discount
|
|
privilegeSize
|
getPrivilegeSize()
|
Discount amount for products at a regular price | |
privilegeSizePromo
|
getPrivilegeSizePromo()
|
Discount amount for products at a promotion price | |
#
Cart
|
|||
site
|
getSite()
|
Store
Store |
|
createdAt
|
getCreatedAt()
|
Date/time when the cart was created | |
droppedAt
|
getDroppedAt()
|
Date/time when the cart was dropped | |
link
|
getLink()
|
Link to the cart | |
linkPath
|
getLinkPath()
|
Link to the cart (path) | |
items
|
getItems()
|
Products in the cart
[array] Cart item |
|
#
Cart item
|
|||
offer
|
getOffer()
|
SKU
SKU |
|
quantity
|
getQuantity()
|
Quantity | |
price
|
getPrice()
|
Price (in entity currency) | |
createdAt
|
getCreatedAt()
|
Date/time when the item was added | |
#
Recommendation group
|
|||
offers
|
getOffers()
|
SKUs
[array] SKU |
|
#
SKU
|
|||
offer
|
getOffer()
|
SKU
SKU |
|
#
Product group
|
|||
productGroup
|
getProductGroup()
|
Product group
Item group |
|
#
SKU or product group
|
|||
offer
|
getOffer()
|
SKU
SKU |
|
productGroup
|
getProductGroup()
|
Product group
Item group |
|
#
Group of recommedations for event "Item or item group view"
|
|||
items
|
getItems()
|
Collection of SKUs that triggered the rule (Type Model\CatalogItem )
[array] SKU or product group |
|
recommendItems
|
getRecommendItems()
|
Recommended SKUs and product groups collection (Type Model\CatalogItem )
[array] SKU or product group |
|
#
Attachment
|
|||
file
|
getFile()
|
File
File |
|
createdAt
|
getCreatedAt()
|
Creation date | |
#
File
|
|||
isImage
|
isImage()
|
File is an image | |
filename
|
getFilename()
|
File name | |
originalName
|
getOriginalName()
|
Original file name | |
type
|
getType()
|
File MIME-type | |
createdAt
|
getCreatedAt()
|
Creation date | |
size
|
getSize()
|
File size in bytes | |
#
Cost
|
|||
costItemCode
|
getCostItemCode()
|
Symbolic code of costs item | |
costItemName
|
getCostItemName()
|
Costs item name | |
costGroupName
|
getCostGroupName()
|
Costs group name | |
costGroupCode
|
getCostGroupCode()
|
Symbolic code of costs group | |
dateFrom
|
getDateFrom()
|
Date (from) | |
dateTo
|
getDateTo()
|
Date (to) | |
summ
|
getSumm()
|
Sum (in base currency) | |
comment
|
getComment()
|
Comment | |
#
MessageGateway bot
|
|||
externalId
|
getExternalId()
|
External ID of the bot | |
name
|
getName()
|
Bot name | |
#
MessageGateway channel
|
|||
externalId
|
getExternalId()
|
External ID of the channel | |
type
|
getType()
|
Channel type | |
#
MessageGateway customer
|
|||
customer
|
getCustomer()
|
Customer
Customer |
|
externalId
|
getExternalId()
|
External ID of the MessageGateway customer | |
channel
|
getChannel()
|
MessageGateway channel
MessageGateway channel |
|
dialogs
|
getDialogs()
|
MessageGateway dialogs
[array] MessageGateway Dialog |
|
#
MessageGateway Dialog
|
|||
externalId
|
getExternalId()
|
External ID of the dialog | |
createdAt
|
getCreatedAt()
|
Date of creating the dialog | |
closedAt
|
getClosedAt()
|
Date of closing the dialog | |
mgCustomer
|
getMgCustomer()
|
MessageGateway Customer
MessageGateway customer |
|
manager
|
getManager()
|
User
User |
|
mgBot
|
getMgBot()
|
MessageGateway Bot
MessageGateway bot |
|
messagesFromCustomer
|
getMessagesFromCustomer()
|
Number of messages from the customer | |
messagesFromManagers
|
getMessagesFromManagers()
|
Number of messages from managers | |
avgAnswerTime
|
getAvgAnswerTime()
|
Manager's response time to messages | |
firstAnswerTime
|
getFirstAnswerTime()
|
Manager's response time to the first message | |
hasTag
|
hasTag(string name)
|
Check if an object has a tag | |
tags
|
getTags()
|
Tags
[array] Tag |
|
#
Message in chats
|
|||
isSent
|
isSent()
|
Indication of successful sending of a message to the chat | |
isFailed
|
isFailed()
|
Sign of an erroneous message sent to chat | |
channelType
|
channelType()
|
The type of channel the message was sent on | |
#
MessageGateway user
|
|||
externalId
|
getExternalId()
|
External ID of the user | |
user
|
getUser()
|
User
User |
|
#
Tag
|
|||
name
|
getName()
|
Tag name | |
#
Client's subscription
|
|||
subscription
|
getSubscription()
|
Subscription category
Subscription category |
|
subscribed
|
getSubscribed()
|
customer_subscription.subscribed
|
Subscription activity |
changedAt
|
getChangedAt()
|
Activity flag change date | |
#
Subscription category
|
|||
channelCode
|
getChannelCode()
|
Channel | |
name
|
getName()
|
Name | |
code
|
getCode()
|
Symbolic code | |
#
Code/value dictionary
|
|||
code
|
code()
|
Code | |
value
|
value()
|
Value | |
#
Package content
|
|||
orderProduct
|
orderProduct()
|
Order item
Order item |
|
quantity
|
quantity()
|
Quantity | |
#
Order item
|
|||
id
|
id()
|
ID of order item | |
externalId
|
externalId()
|
deprecated External ID of order item
|
|
externalIds
|
externalIds()
|
External IDs of order item
[array] Code/value dictionary |
|
#
Trigger data not associated with mailing
|