Reference book of objects

Objects

Object code	Name
	Order
	Customer
	Change set
	Call
	Data when the trigger occurs
	Corporate customer
	API key
	Service booking
	Booking change
	Booking service
	Attachment
	Birthday event
	Cart
	Cart item
	Catalog
	Google Analytics unique clientId
	Code/value dictionary
	Company
	Contragent
	Complementary products
	Cost
	Costs item
	Courier
	Courier delivery service data
	Courier phone
	Currency
	Directory element
	Custom event
	Customer address
	Contact person
	Contact person`s company
	Contragent
	Corporate customer change
	Customer change
	Note
	Customer phone
	Client's subscription
	Customer visit in site
	DDelivery delivery service data
	Delivery service
	Delivery type
	File
	Data of the delivery service, connected by API
	Users group
	Response to JS module backend request
	Response body to JS module backend request
	Leftover stock by warehouses
	KazPost delivery service data
	Knowledge base document
	Knowledge base document change
	Knowledge base section
	Legal entity
	Email
	Segment criterion value
	Loyalty program
	Participation in the loyalty program
	Information about the bonus account of the participation
	Change of participation in the loyalty program
	Discount on the event of the loyalty program
	Level of participation in the loyalty program
	MessageGateway bot
	MessageGateway channel
	MessageGateway customer
	MessageGateway Dialog
	Message in chats
	Customer reply to the message
	MessageGateway user
	SKU or product group
	Subscription confirmation link
	Operation with bonus account
	Coordinates
	Price range
	Recommendation group
	Group of recommedations for event "Item or item group view"
	Personal date event
	SLA
	Information on time range
	Unsubscribe url
	Link to the web version of the email
	Item movement
	New Post delivery service data
	New arrivals
	SKU
	Available prices
	Contragent
	Delivery address
	Order change
	Order method
	Printed form
	Order item
	Product marking code
	Pack - items pack, within the one item position, from one warehouse
	Set of changes in the collecting history
	Item status in order
	Order type
	Printed form
	Package
	Package content
	Order item
	Payment
	Payment status
	Payment type
	Personal recommendations
	Popular products
	Price type
	Product
	Item group
	Item property
	SKU
	Product group
	Recommended product view
	Product recommendations result
	Pack reservation
	Trigger
	Trigger data not associated with mailing
	Trigger data of "Message delivery"
	Trigger data of "Send message to chat"
	Trigger data of "SMS Delivery"
	Segment
	Abandoned session
	Product sets
	Similar products
	Store
	SMS
	Source
	Specialist
	Specialist phone
	Specialist service
	Order status
	Status color theme
	Status group
	Warehouse
	Warehouse address
	Warehouse phone
	Warehouse work time
	Subscription category
	Tag
	Task
	User comment on the task
	Task change
	Ticket
	Ticket channel
	Ticket comment
	Ticket change
	Ticket issue
	Ticket status
	Ticket status group
	Ticket subtopic
	Ticket topic
	Ticket topic SLA
	Ticket type
	Ticket type SLA
	Unit
	Frequently bought with this product
	User
	Welcome-bonuses event

Order `Order`

Object/Field History field code Description

additionalPhone

getAdditionalPhone()

additional_phone

Additional phone

anyEmail

getAnyEmail()

Any found e-mail

anyPhone

getAnyPhone()

Any found phone

getAttachments()

Attachments

getAvailableOrderProducts()

Items in order (recommended to use this method for getting order items)

bonusesChargeTotal

getBonusesChargeTotal()

Amount of debited bonuses

bonusesCreditTotal

getBonusesCreditTotal()

Amount of accrued bonuses

call

getCall()

call

Call required

getClientId()

Google Analytics clientId

clientIdString

getClientIdString()

Google Analytics unique clientId (string)

getCompany()

company

Company

getContact()

contact

Contact person

getContragent()

Requisites

getCosts()

Cost list

country

getCountry()

country

ISO country code (ISO 3166-1 alpha-2)

getCourier()

Courier assigned on this order (if order is delivered this way)

createdAt

getCreatedAt()

created_at

Order creation date

customField

getCustomField(string code)

Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.

customFields

getCustomFields()

Associative array of custom fields

getCustomer()

customer

Customer

Object code	Name
	Customer
	Corporate customer

customerComment

getCustomerComment()

customer_comment

Customer comment

getDeliveryAddress()

Delivery address

deliveryCost

getDeliveryCost()

delivery_cost

Delivery cost (in entity currency)

deliveryCostIsManual

getDeliveryCostIsManual()

Delivery cost is set manually

deliveryDate

getDeliveryDate()

delivery_date

Delivery date

deliveryNetCost

getDeliveryNetCost()

delivery_net_cost

Delivery net cost (in entity currency)

deliveryNetCostIsManual

getDeliveryNetCostIsManual()

Delivery net cost is set manually

getDeliveryService()

delivery_service

Delivery service

getDeliveryTime()

delivery_time

Delivery time

deliveryTimeCustom

getDeliveryTimeCustom()

deprecated Delivery time in free form

deliveryTimeFrom

getDeliveryTimeFrom()

deprecated Delivery time "from"

deliveryTimeString

getDeliveryTimeString()

deprecated Delivery time as string

deliveryTimeTo

getDeliveryTimeTo()

deprecatedDelivery time "to"

getDeliveryType()

delivery_type

Delivery type

deliveryVatRate

getDeliveryVatRate()

Delivery VAT rate

getDialog()

MessageGateway dialog

discount

getDiscount()

Monetary discount

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

discountPercent

getDiscountPercent()

Percentage discount

discountSumm

getDiscountSumm()

Total amount of items discount (in entity currency)

dpdDeliveryName

getDpdDeliveryName()

deprecated Delivery tariff of DPD. Use getIntegrationDeliveryData().deliveryName

dpdExternalId

getDpdExternalId()

deprecated Tracking number of DPD. Use getIntegrationDeliveryData().trackNumber

email

getEmail()

email

E-mail

expired

getExpired()

expired

Expired

externalId

getExternalId()

Order external ID

firstName

getFirstName()

first_name

Name

fromApi

getFromApi()

from_api

Order received through API

fullPaidAt

getFullPaidAt()

full_paid_at

Full payment date

height

getHeight()

height

Height

id

getId()

id

Order ID

initialProductSumm

getInitialProductSumm()

Total for goods/services without discounts (in entity currency)

getIntegrationDeliveryData()

Data of integrated delivery service

Object code	Name
	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

integrationDeliveryLocked

getIntegrationDeliveryLocked()

Do not synchronize with the delivery service (for integrational delivery)

integrationDeliveryTrackId

getIntegrationDeliveryTrackId()

deprecated Tracking number in integrated delivery service. Use getIntegrationDeliveryData().trackNumber

isDpdPickupPoint

isDpdPickupPoint()

deprecated Delivery to the terminal for DPD. Use getIntegrationDeliveryData().toPickuppoint

isShipmentAllowed

isShipmentAllowed()

Order is ready for shipping

lastName

getLastName()

last_name

Surname

length

getLength()

length

Length

getLoyaltyAccount()

loyalty_account

Participation in the loyalty program

getLoyaltyEventDiscount()

loyalty_event_discount

Discount on the event of the loyalty program

getLoyaltyLevel()

loyalty_level

Level of participation in the loyalty program

getManager()

manager

Order manager

managerComment

getManagerComment()

manager_comment

Operator comment

marginSumm

getMarginSumm()

Gross order profit (in entity currency)

mark

getMark()

mark

Order evaluation

markDatetime

getMarkDatetime()

mark_datetime

Date and time of getting evaluation from customer

nickName

getNickName()

Full name

number

getNumber()

number

Order number

getOrderMethod()

order_method

Order method

getOrderProducts()

order_product

Items in order (including cancelled)

getOrderType()

order_type

Order type

patronymic

getPatronymic()

patronymic

Middle name

paymentDetail

getPaymentDetail()

deprecated Payment details

getPaymentStatus()

deprecated Payment status

getPaymentType()

deprecated Payment type

getPayments()

payments

Payments

personalDiscountPercent

getPersonalDiscountPercent()

Personal discount on the order

phone

getPhone()

phone

Phone

prepaySum

getPrepaySum()

prepay_sum

Paid sum (in entity currency)

privilegeType

getPrivilegeType()

privilege_type

Privilege type. Possible values: none, personal_discount, loyalty_level, loyalty_event

purchaseSumm

getPurchaseSumm()

Total purchase sum (in base currency)

quantity

getQuantity(bool onlyAvailableProducts = true)

Total items quantity in order. If to call with parameter getQuantity(false), then quantity will also include cancelled items

russianPostDeliveryStatus

getRussianPostDeliveryStatus()

deprecated Delivery status of tracking by Russian Post or EMS. Use getIntegrationDeliveryData().status

russianPostTrackNumber

getRussianPostTrackNumber()

deprecated Tracking number of Russian POst or EMS (if order is delivered this way). Use getIntegrationDeliveryData().trackNumber

sdekExternalId

getSdekExternalId()

deprecated Tracking number of SDEK (if order is delivered this way). Use getIntegrationDeliveryData().trackNumber

secondsToNextOrder

getSecondsToNextOrder()

Time till next order, in seconds

shipmentDate

getShipmentDate()

shipment_date

Shipment date

getShipmentStore()

shipment_store

Shipping warehouse

shipped

getShipped()

shipped

Order is shipped

getSite()

site

Store

getSource()

source

Order source

getStatus()

status

Order status

statusComment

getStatusComment()

status_comment

Comment to the last status change

statusUpdatedAt

getStatusUpdatedAt()

Date of the last order status change

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

toPaySumm

getToPaySumm()

Sum to pay (in entity currency)

totalDiscount

getTotalDiscount()

deprecated Total order discount

totalSumm

getTotalSumm()

total_summ

Total sum with discount (in entity currency)

weight

getWeight(bool|null getMax = false)

weight

Weight. For getMax = true returns the maximum weight from common and volumetric weight

width

getWidth()

width

Width

Customer `Customer`

Object/Field	History field code	Description
		Customer address
	`address`	Customer addresses
`anyEmail`		Any found e-mail
`anyPhone`		Any found phone
		Attachments
`averageSumm`		Order average sum (in base currency)
`avgMarginSumm`		Average gross profit of customer orders (in base currency)
`avgSecondsBetweenOrders`		Average time between orders, in seconds
`bad`	`bad`	Bad customer
`birthday`	`birthday`	Birthday
`chatPreferredPhone`		Preferred MessageGateway phone
		Google Analytics unique clientIds
`commentary`	`commentary`	`deprecated` Comment
		`deprecated` Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
`createdAt`		Created at
`cumulativeDiscount`	`cumulative_discount`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customField`		Returns value of the specific custom field. Parameter `code` equals a symbolic code of custom field.
`customFields`		Associative array of custom fields
		Contact persons
	`customer_subscription`	Subscriptions
`discountCardNumber`	`discount_card_number`	Discount card number
`email`	`email`	E-mail
`emailMarketingUnsubscribedAt`		`deprecated` Date of unsubscription from emails
`externalId`	`external_id`	Customer external ID
`firstClientId`		First Google Analytics clientId
`firstName`	`first_name`	Name
		First uncancelled order of customer
		First customer visit on site
`frequencyClass`		Frequency-segment in RFM
`hasTag`		Check if an object has a tag
`id`	`id`	Customer ID
`lastClientId`		Last Google Analytics clientId
`lastName`	`last_name`	Surname
		Last uncancelled order of customer
		Last found phone
		Last customer visit on site
		Participation in the customer's Loyalty Program by the customer's main site
		Participation in the customer's Loyalty Program by the site code
	`main_address`	Main customer address
		Main contact person
	`manager`	Customer manager
`marginSumm`		LTV (in base currency)
`maturationTime`		Maturation time, in seconds
	`mg_customer`	MessageGateway customers
`monetaryClass`		Monetary-segment in RFM
`monetaryValue`		Monetary value in RFM
`nickName`		Full name
	`notes`	Notes
`ordersCount`		Orders quantity
`patronymic`	`patronymic`	Middle name
`personalDiscount`	`personal_discount`	Personal discount
`phone`		Phone
	`phones`	Phones
`presumableSexCode`		Guessed gender code by customer name
`recencyClass`		Recency-segment in RFM
`recencyValue`		Recency value in RFM
		[array] Segments
`sexCode`		Sex code (<code>"male"</code>, <code>"female"</code> or <code>null</codes>)
	`site`	Store, from which the customer came
	`source`	Customer source
		[array] Tags
`ticketsCount`		Tickets quantity
`totalSumm`		Orders total sum (in base currency)
`typeCode`		Customer type (`"customer"` - customer, `"customer_corporate"` - corporate customer)
		`deprecated` Google Analytics unique clientIds
`vip`	`vip`	VIP customer

Change set `Change\EntityChangeSet`

Object/Field History field code Description

getApiKeyOfChange(string field)

Returns an API key, that changed the specified field. Field code in the history should be specified in field

getAuthorOfChange(string field)

Returns a user, who changed the specified field. Field code in the history should be specified in field

getChangedField(string field)

Set of old and new values of the field. Field code in the history should be specified in field

Object code	Name
	Booking change
	Corporate customer change
	Customer change
	Order change
	Knowledge base document change
	Task change
	Ticket 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

hasChangesWithSource

hasChangesWithSource(string|null source)

Verification that there are changes from specified source

isCreate

isCreate()

Content is created

isDelete

isDelete()

Content is deleted

isUpdate

isUpdate()

Content is edited

newValue

getNewValue(string field)

New value of specified field. Field code in the history should be specified in field

oldValue

getOldValue(string field)

Old value of specified field. Field code in the history should be specified in field

getRuleOfChange(string field)

Returns a trigger, that changed the specified field. Field code in the history should be specified in field

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)

Call `Call`

Object/Field History field code Description

code

getCode()

Extension of user, who processed the call

getCustomer()

Customer, who received or initiated call (may be absent)

Object code	Name
	Customer
	Corporate customer

date

getDate()

Date/time of call

duration

getDuration()

Call duration (in seconds)

externalId

getExternalId()

Call ID in PBX

externalPhone

getExternalPhone()

External phone number

fullSummary

getFullSummary()

Detailed call summary

hasTag

hasTag(string name)

Check if an object has a tag

id

getId()

Call ID

isMissing

isMissing()

Call is missed

getManager()

User, who processed the call

getOrder()

Order related with call (may be absent)

phone

getPhone()

Phone number

result

getResult()

Call result (possible values: failed, answered, busy, no answer, not allowed, unknown)

shortSummary

getShortSummary()

Brief call summary

getSite()

Store

getSource()

Source

type

getType()

Call type (incoming in or outgoing out)

Data when the trigger occurs `RuleExecution`

Object/Field History field code Description

getActions()

Data list when trigger is activated

Object code	Name
	Trigger data not associated with mailing
	Trigger data of "Message delivery"
	Trigger data of "Send message to chat"
	Trigger data of "SMS Delivery"

Corporate customer `CustomerCorporate`

Object/Field	History field code	Description
	`address`	Corporate customer addresses
		Attachments
`averageSumm`		Order average sum (in base currency)
`avgMarginSumm`		Average gross profit of corporate customer orders (in base currency)
`avgSecondsBetweenOrders`		Average time between orders, in seconds
`bad`	`bad`	Bad corporate customer
		Google Analytics unique clientIds
	`company`	Companies
`createdAt`		Created at
`cumulativeDiscount`	`cumulative_discount`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customField`		Returns value of the specific custom field. Parameter `code` equals a symbolic code of custom field.
`customFields`		Associative array of custom fields
	`contact`	Contact persons
`discountCardNumber`	`discount_card_number`	Discount card number
`emailMarketingUnsubscribedAt`		`deprecated` Date of unsubscription from emails
`externalId`	`external_id`	Corporate customer external ID
`firstClientId`		First Google Analytics unique clientId
		First uncancelled order of corporate customer
		First customer visit on site
`frequencyClass`		Frequency-segment in RFM
`hasTag`		Check if an object has a tag
`id`	`id`	Corporate customer ID
`lastClientId`		Last Google Analytics unique clientId
		Last uncancelled order of corporate customer
		Last customer visit on site
	`main_address`	Main corporate customer address
	`main_company`	Main company
	`main_contact`	Main contact person
	`manager`	Corporate customer manager
`marginSumm`		LTV (in base currency)
`monetaryClass`		Monetary-segment in RFM
`monetaryValue`		Monetary value in RFM
`nickName`	`nick_name`	Name
	`notes`	Notes
`ordersCount`		Orders quantity
`personalDiscount`	`personal_discount`	Personal discount
	`phones`	Phone numbers of the corporate customer
`recencyClass`		Recency-segment in RFM
`recencyValue`		Recency value in RFM
	`site`	Store, from which the corporate customer came
		[array] Tags
`ticketsCount`		Tickets quantity
`totalSumm`		Orders total sum (in base currency)
`typeCode`		Customer type (`"customer"` - customer, `"customer_corporate"` - corporate customer)
		`deprecated` Google Analytics unique clientIds
`vip`	`vip`	VIP corporate customer

Object/Field	History field code	Description
`id`		Internal identifier of the API key

Service booking `Appointment`

Object/Field History field code Description

comment

getComment()

comment

Comment

createdAt

getCreatedAt()

Booking creation date

getCustomer()

customer

Customer

Object code	Name
	Customer
	Corporate customer

duration

getDuration()

Duration in minutes

endAt

getEndAt()

end_at

Booking end

isActive

isActive()

Occupies the specialist time

getOrder()

order

Booking order

getServices()

service

Booking services

getSite()

Store

getSpecialist()

specialist

Specialist

startAt

getStartAt()

start_at

Booking start

statusCode

getStatusCode()

status

Status code (new, confirmed, completed, cancelled)

totalSum

getTotalSum()

Services total in the store currency (in entity currency)

Booking service `AppointmentService`

Object/Field	History field code	Description
`duration`	`service.duration`	Unit duration in minutes
	`service.offer`	Service offer
`price`	`service.price`	Unit price in the store currency (in entity currency)
`quantity`	`service.quantity`	Quantity
`sum`		Sum (in entity currency)

Birthday event `BirthdayLoyaltyEvent`

Object/Field	History field code	Description
`id`		Event ID
`privilegeSize`		Discount amount for products at a regular price (in entity currency)
`privilegeSizePromo`		Discount amount for products at a promotion price (in entity currency)
`privilegeType`		Type of privilege on the event. Possible values: `bonus`, `discount`

Cart `Cart`

Object/Field	History field code	Description
`createdAt`		Date/time when the cart was created
`droppedAt`		Date/time when the cart was dropped
`id`		Cart ID
		Products in the cart
`link`		Link to the cart
`linkPath`		Link to the cart (path)
		Store
`totalAmount`		Total cart amount

Cart item `CartItem`

Object/Field	History field code	Description
`createdAt`		Date/time when the item was added
		SKU
`price`		Price (in entity currency)
`quantity`		Quantity

Object/Field	History field code	Description
		Main store of catalog

Object/Field	History field code	Description
`clientId`		ClientId value
`createdAt`		Creation date

Company `Company`

Object/Field	History field code	Description
`active`	`company.active`	Activity
	`company.address`	Address
`averageSumm`		Order average sum (in base currency)
`avgMarginSumm`		Average gross profit of customer orders (in base currency)
`brand`	`company.brand`	Brand
		Requisites
`customField`		Returns value of the specific custom field. Parameter `code` equals a symbolic code of custom field.
`customFields`		Associative array of custom fields
`externalId`	`company.external_id`	Company external ID
`marginSumm`		LTV (in base currency)
`name`	`company.name`	Name
`ordersCount`		Orders quantity
`site`	`company.site`	Company website
`totalSumm`		Orders total sum (in base currency)

Contragent `CompanyContragent`

Object/Field	History field code	Description
`BIK`	`company.contragent.b_i_k`	RCBIC
`INN`	`company.contragent.i_n_n`	TIN
`KPP`	`company.contragent.k_p_p`	IECC
`OGRN`	`company.contragent.o_g_r_n`	PSRN
`OGRNIP`	`company.contragent.o_g_r_n_i_p`	PSRN of Individual entrepreneur
`OKPO`	`company.contragent.o_k_p_o`	RNNBO
`bank`	`company.contragent.bank`	Bank
`bankAccount`	`company.contragent.bank_account`	Settlement account
`bankAddress`	`company.contragent.bank_address`	Bank address
`certificateDate`	`company.contragent.certificate_date`	Certificate date
`certificateNumber`	`company.contragent.certificate_number`	Certificate number
`contragentType`	`company.contragent.contragent_type`	Contragent type (field can receive 2 values: <em>legal-entity</em> - legal entity, <em>entrepreneur</em> - individual entrepreneur)
`corrAccount`	`company.contragent.corr_account`	Corresponding account
`legalAddress`	`company.contragent.legal_address`	Registration address
`legalName`	`company.contragent.legal_name`	Legal name

Cost `Cost`

Object/Field	History field code	Description
`comment`		Comment
`costGroupCode`		Symbolic code of costs group
`costGroupName`		Costs group name
`costItemCode`		Symbolic code of costs item
`costItemName`		Costs item name
`dateFrom`		Date (from)
`dateTo`		Date (to)
`summ`		Sum (in base currency)

Courier `Courier`

Object/Field	History field code	Description
`active`		Activity status
`createdAt`		Courier creation date in the system
`description`		Description
`email`		Email
`firstName`		First name
`fullName`		Full name
`id`		Courier ID
`lastName`		Last name
`name`		`deprecated` Fullname. Use `fullName` instead
`patronymic`		Patronymic
		Contact phone

Courier delivery service data `CourierData`

Object/Field	History field code	Description
	`integration_delivery_data.courier`	Courier
`is`		Returns `true` if transmitted code matches to delivery service code (`.is('courier')`)

Object/Field	History field code	Description
`number`		Phone number
`type`		Phone type

Object/Field	History field code	Description
`code`		Currency code

Object/Field	History field code	Description
`active`		Available for usage or deleted
`code`		Symbolic code
`name`		Name

Custom event `CustomLoyaltyEvent`

Object/Field	History field code	Description
`id`		Event ID
`privilegeSize`		Discount amount for products at a regular price (in entity currency)
`privilegeSizePromo`		Discount amount for products at a promotion price (in entity currency)
`privilegeType`		Type of privilege on the event. Possible values: `bonus`, `discount`

Customer address `CustomerAddress`

Object/Field	History field code	Description
`block`	`address.block`	Entrance
`building`	`address.building`	Building
`city`	`address.city`	City (If `withType = true`, city will be displayed with locality type)
`cityType`		Locality type
`country`	`address.country`	Country
`flat`	`address.flat`	Flat/office
`floor`	`address.floor`	Floor
`fullAddressString`		Address as string collected from fields. Parameter `withIndex` allows to display postal code
`house`	`address.house`	House
`housing`	`address.housing`	Housing
`index`	`address.index`	Postal code
`isEmpty`		Address is empty
`metro`	`address.metro`	Underground
`name`	`address.name`	Name
`notes`	`address.notes`	Notes to address
`region`	`address.region`	Region
`street`	`address.street`	Street (If `withType = true`, street will be displayed with type)
`streetType`		Street type
`text`		Address as string

Contact person `CustomerContact`

Object/Field	History field code	Description
	`contact.contact_company`	Companies of the contact person
`id`	`contact.id`	Contact ID

Contact person`s company `CustomerContactCompany`

Object/Field	History field code	Description
	`contact.contact_company.company`	Company
`id`	`contact.contact_company.id`	Company ID

Contragent `CustomerContragent`

Object/Field	History field code	Description
`BIK`	`contragent.b_i_k`	RCBIC
`INN`	`contragent.i_n_n`	TIN
`KPP`	`contragent.k_p_p`	IECC
`OGRN`	`contragent.o_g_r_n`	PSRN
`OGRNIP`	`contragent.o_g_r_n_i_p`	PSRN of Individual entrepreneur
`OKPO`	`contragent.o_k_p_o`	RNNBO
`bank`	`contragent.bank`	Bank
`bankAccount`	`contragent.bank_account`	Settlement account
`bankAddress`	`contragent.bank_address`	Bank address
`certificateDate`	`contragent.certificate_date`	Certificate date
`certificateNumber`	`contragent.certificate_number`	Certificate number
`contragentType`	`contragent.contragent_type`	Contragent type (field can receive 3 values: <em>individual</em> - private individual, <em>legal-entity</em> - legal entity, <em>entrepreneur</em> - individual entrepreneur)
`corrAccount`	`contragent.corr_account`	Corresponding account
`legalAddress`	`contragent.legal_address`	Registration address
`legalName`	`contragent.legal_name`	Legal name

Corporate customer change `CustomerCorporateHistory`

Object/Field	History field code	Description
		Company
		Customer address
		Contact person
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value

Customer change `CustomerHistory`

Object/Field	History field code	Description
		Client's subscription
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value

Object/Field	History field code	Description
`createdAt`		Date/time of creation
`id`		Note ID
		Manager
`text`		Note text

Object/Field	History field code	Description
`number`		Phone number
`type`		Phone type

Client's subscription `CustomerSubscription`

Object/Field	History field code	Description
`changedAt`		Activity flag change date
`subscribed`	`customer_subscription.subscribed`	Subscription activity
		Subscription category

Customer visit in site `CustomerVisit`

Object/Field	History field code	Description
		ClientId of the visit
`createdAt`		Datetime of visit starting
`exitPage`		Exit page
`finishedAt`		Datetime of visit ending
`landingPage`		Enter page
`pageDepth`		Page depth
`pageviews`		Pages quantity per visit
`visitLength`		Visit duration in seconds

DDelivery delivery service data `DDeliveryData`

Object/Field	History field code	Description
`days`		Approximate delivery time
`declaredSum`		Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account)
`deliveryName`	`integration_delivery_data.delivery_name`	Delivery service name
`externalId`		Delivery id in delivery service
`is`		Returns `true` if transmitted code matches to delivery service code (`.is('ddelivery')`)
`isLocked`		Do not synchronize with the delivery service
`pickuppointAddress`	`integration_delivery_data.pickuppoint_address`	Pickup point address
`state`	`integration_delivery_data.state`	Status of delivery registration (`none` - Didn’t pass registration, `processing` - Waiting for registration, `cancel` - Cancellation, `success` - Successfully, `error` - Error)
`status`	`integration_delivery_data.status`	Delivery status code
`trackNumber`	`integration_delivery_data.track_number`	Track number

Delivery service `DeliveryService`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
		Delivery type
`name`		Name

Delivery type `DeliveryType`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultCost`		Default cost (in entity currency)
`defaultForCrm`		Set by default for orders created in system
`defaultNetCost`		Default net cost (in entity currency)
		Delivery services included in this delivery type
`description`		Comment
`isCourier`		`deprecated` Courier delivery. Use `getIntegrationDeliveryData().is('courier')`
`isDpd`		`deprecated` Delivery is integrated with DPD. Use `getIntegrationDeliveryData().is('dpd')`
`isMultiShip`		`deprecated` Delivery is integrated with MultiShip. Use `getIntegrationDeliveryData().is('multiship')`
`isRussianPost`		`deprecated` Delivery is integrated with Russian Post. Use `getIntegrationDeliveryData().is('russianpost')`
`isSdek`		`deprecated` Delivery is integrated with SDEK. Use `getIntegrationDeliveryData().is('sdek')`
`name`		Name
		`deprecated` Allowed payment types. Use `deliveryPaymentTypes`

File `File`

Object/Field	History field code	Description
`createdAt`		Creation date
`filename`		File name
`isImage`		File is an image
`originalName`		Original file name
`size`		File size in bytes
`type`		File MIME-type

Data of the delivery service, connected by API `GenericData`

Object/Field	History field code	Description
`cost`		Delivery cost received from delivery service (in entity currency)
`declaredSum`		Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account)
`deliveryTerm`		Approximate delivery time
`externalId`		Delivery id in delivery service
`extraData`		Additional delivery data (`deliveryDataField.code => value`)
`is`		Returns `true` if transmitted code matches to delivery service code (`.is('generic')`)
`isLocked`		Do not synchronize with the delivery service
`packagesCount`		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.
`pickuppointAddress`	`integration_delivery_data.pickuppoint_address`	Pickup point address
`pickuppointCoordinateLatitude`		Pickup point coordinates, latitude
`pickuppointCoordinateLongitude`		Pickup point coordinates, longitude
`pickuppointId`		Pickup point ID
`pickuppointPhone`		Pickup point phone
`pickuppointSchedule`		Pickup point working time
`presentationPackages`		Packages
`shipmentpointAddress`		Shipment terminal address
`shipmentpointId`		Shipment terminal ID
`shipmentpointPhone`		Shipment terminal phone
`shipmentpointSchedule`		Pickup point working time shipment terminal
`state`	`integration_delivery_data.state`	Status of delivery registration (`none` - Didn’t pass registration, `processing` - Waiting for registration, `cancel` - Cancellation, `success` - Successfully, `error` - Error)
`status`	`integration_delivery_data.status`	Delivery status code
`statusComment`		Comment to delivery status
`statusDate`		Delivery status date
`statusText`		Delivery status name
`tariff`		Tariff code
`tariffName`	`integration_delivery_data.tariff_name`	Tariff name
`trackNumber`	`integration_delivery_data.track_number`	Track number (`deprecated` for write)

Users group `Group`

Object/Field	History field code	Description
`code`		Code
`filterTicketIssuesByTopics`		Considers topics and subtopics when distributing ticket issues
`handlesTicketIssues`		Processes ticket issues
`id`		ID
`isManager`		Group processes orders
`name`		Name
		Stores of ticket issues distributed to users of this group
		Subtopics of ticket issues distributed to users of this group
		Topics of ticket issues distributed to users of this group
		Types of ticket issues distributed to users of this group

Leftover stock by warehouses `Inventory`

Object/Field	History field code	Description
`purchasePrice`		Purchasing price (in base currency)
`quantity`		Quantity
		Warehouse

KazPost delivery service data `KazPostData`

Object/Field	History field code	Description
`is`		Returns `true` if transmitted code matches to delivery service code (`.is('kazpost')`)
`status`	`integration_delivery_data.status`	Delivery status code
`trackNumber`	`integration_delivery_data.track_number`	Track number

Knowledge base document `KnowledgeBaseDocument`

Object/Field	History field code	Description
`content`		Text
`contentHash`	`content`	Content hash
`createdAt`		Created at
		Created by
`externalId`	`external_id`	External ID
`id`	`id`	Document ID
`isAvailableForCopilot`		Available to the AI assistant
	`section`	Section
`title`	`title`	Title
`updatedAt`		Updated at
		Updated by

Knowledge base document change `KnowledgeBaseDocumentHistory`

Object/Field	History field code	Description
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value

Knowledge base section `KnowledgeBaseSection`

Object/Field	History field code	Description
		Subsections
`createdAt`		Created at
		Created by
`id`		Section ID
`name`		Name
		Parent section
`path`		Section path
`updatedAt`		Updated at
		Updated by

Legal entity `LegalEntity`

Object/Field	History field code	Description
`BIK`		RCBIC
`INN`		TIN
`KPP`		IECC
`OGRN`		PSRN
`OGRNIP`		PSRN of Individual entrepreneur
`OKPO`		RNNBO
`bank`		Bank
`bankAccount`		Settlement account
`bankAddress`		Bank address
`certificateDate`		Certificate date
`certificateNumber`		Certificate number
`code`		Symbolic code
`contragentType`		Legal entity type (field can receive 2 values: <em>legal-entity</em> - legal entity, <em>entrepreneur</em> - individual entrepreneur)
`corrAccount`		Corresponding account
`legalAddress`		Registration address
`legalName`		Legal name
`vatRate`		VAT rate

Email `Letter`

Object/Field	History field code	Description
`isClicked`		Returns a flag that determines whether the link in the message was clicked
`isOpened`		Returns the flag that determines whether the message was opened

Segment criterion value `Literal`

Object/Field	History field code	Description
`isNegated`		Criterion on this value was inverted
`isNotEmpty`		Object contains criterions
`max`		Maximum value for numeric and monetary filter
`min`		Minimum value for numeric and monetary filter
`value`		The scalar value of filter

Participation in the loyalty program `LoyaltyAccount`

Object/Field	History field code	Description
`amount`		Active bonus amount
`awaitingAmount`		Bonuses waiting to be activated
`cardNumber`		Card number
`createdAt`		Creation date
`customField`		Returns value of the specific custom field
`customFields`		Associative array of custom fields
`id`		Participation ID
`isActive`		Flag of active participation
		Level of participation
		Loyalty program
`ordersSum`		Orders total sum (in entity currency)
`phoneNumber`		Phone number
`status`		Participation status. Possible values: `not_confirmed`, `activated`, `deactivated`

Information about the bonus account of the participation `LoyaltyAccountInfo`

Object/Field	History field code	Description
`activeAmount`		Active bonuses
`addedAmount`		Bonuses accrued for the entire time of participation
`burnSoonAmount`		Bonus amount that will soon expire (you can pass the expiration period in days in the argument)
`burnedAmount`		Bonuses expired for the entire time of participation
`requiredSumForNextLevel`		Remaining purchase amount to reach the next level (in entity currency)
`spentAmount`		Bonuses redeemed for the entire time of participation
`waitingActivationAmount`		Bonus amount waiting to be activated

Change of participation in the loyalty program `LoyaltyAccountTimeline`

Object/Field	History field code	Description
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value

Discount on the event of the loyalty program `LoyaltyEventDiscount`

Object/Field History field code Description

discount

getDiscount()

Discount amount for products at a regular price

discountPromo

getDiscountPromo()

Discount amount for products at a promotion price

isExpired

isExpired()

Expired

getLoyaltyEvent()

Event

Object code	Name
	Birthday event
	Custom event
	Welcome-bonuses event

Level of participation in the loyalty program `LoyaltyLevel`

Object/Field	History field code	Description
`id`		Level ID
`isBonusPrivilegeType`		Type of privileges - bonuses
`isDiscountPrivilegeType`		Type of privileges - discount
`name`		Level name
`privilegeSize`		Discount amount, percentage or rate of bonus accrual for products at a regular price (in entity currency)
`privilegeSizePromo`		Discount amount, percentage or rate of bonus accrual for promotional products (in entity currency)
`type`		Level type. Possible values: `bonus_converting`, `bonus_percent`, `discount`

MessageGateway customer `MGCustomer`

Object/Field	History field code	Description
		MessageGateway channel
		Customer
		MessageGateway dialogs
`externalId`		External ID of the MessageGateway customer

MessageGateway Dialog `MGDialog`

Object/Field	History field code	Description
`avgAnswerTime`		Manager's response time to messages
`closedAt`		Date of closing the dialog
`createdAt`		Date of creating the dialog
`externalId`		External ID of the dialog
`firstAnswerTime`		Manager's response time to the first message
`hasTag`		Check if an object has a tag
		User
`messagesFromBots`		Number of messages from bots
`messagesFromCustomer`		Number of messages from the customer
`messagesFromManagers`		Number of messages from managers
		MessageGateway Bot
		MessageGateway Customer
		Tags

Message in chats `MGMessage`

Object/Field	History field code	Description
`channelType`		The type of channel the message was sent on
`deliveredAt`		Message delivery date
`isFailed`		Sign of an erroneous message sent to chat
`isSent`		Indication of successful sending of a message to the chat

Customer reply to the message `MGReply`

Object/Field	History field code	Description
`dateFromReplyDdMmYyyy`		Date from reply DD.MM.YYYY
`dateFromReplyMmDdYyyy`		Date from reply MM.DD.YYYY
`dateFromReplyYyyyMmDd`		Date from reply YYYY.MM.DD
`text`		Reply text

Operation with bonus account `Model\LoyaltyBonusOperation`

Object/Field	History field code	Description
`amount`		Sum of operation
`comment`		Comment
`createdAt`		Date of operation
		Customer
		Participation in loyalty program
		Initiator
		Order
`reason`		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`, `import`
`type`		Type of operation. Possible values: `credit`, `charge`

Group of recommedations for event "Item or item group view" `Model\RuleActivationItem`

Object/Field	History field code	Description
		Recommended SKUs and product groups collection (Type `Model\CatalogItem`)

SLA `Model\TicketSla`

Object/Field	History field code	Description
`closedAt`		Closed at
`createdAt`		Started at
`duration`		Duration
`remainingDuration`		Remaining duration
`statusCode`		Status
`urgentAt`		Urgent at
`warningAt`		Warning at

Information on time range `Model\TimeInterval`

Object/Field	History field code	Description
`custom`		Time range in free form
`from`		Time "from"
`isEmpty`		Check if the information on time range is specified
`string`		Time range as string
`to`		Time "to"

Item movement `Movement`

Object/Field	History field code	Description
`completed`		Movement has been carried out
		Courier
`shipmentDate`		Date of collection from warehouse
		Collection warehouse
		Bringing warehouse

New Post delivery service data `NewPostData`

Object/Field	History field code	Description
`afterpaymentOnGoodsCost`		Payment control (in entity currency)
`days`		Approximate delivery time
`declaredSum`		Declared value of the order(the option of the integration settings "Zero declared value by default" is not taken into account)
`is`		Returns `true` if transmitted code matches to delivery service code (`.is('newpost')`)
`isLocked`		Do not synchronize with the delivery service
`price`		Delivery cost received from delivery service
`receiverWarehouse`	`integration_delivery_data.receiver_warehouse`	Post office number and address
`state`	`integration_delivery_data.state`	Status of delivery registration (`none` - Didn’t pass registration, `processing` - Waiting for registration, `cancel` - Cancellation, `success` - Successfully, `error` - Error)
`status`	`integration_delivery_data.status`	Delivery status code
`trackNumber`	`integration_delivery_data.track_number`	Track number

SKU `Offer`

Object/Field	History field code	Description
`active`		Activity
`actualPrice`		Returns SKU price or item price, which refers to SKU
`anyArticle`		SKU or item vendor code, if SKU vendor code is absent
`article`		Vendor code
`barcode`		Barcode
		Catalog
`createdAt`		System creation date and time
`description`		Description
`displayName`		SKU name
`duration`		DurationService duration in minutes
`externalId`		SKU ID in store
`height`		Height
`id`		SKU ID
`imageUrl`		Image URL
`length`		Length
`name`		Name
`offerName`		Returns item name or SKU name
		SKU price object (`priceType` - price type code, if a certain price type required or default price type will be applied)
`price`		SKU price (`priceType` - price type code, if a certain price type required)
		Item, which refers to SKU
`properties`		SKU properties
`purchasePrice`		SKU purchasing price (in base currency)
`quantity`		Available quantity
		`deprecated` Store. Use `getCatalog()`
		Unit
`url`		Link to item page in the web-store
`vatRate`		VAT rate
`weight`		Weight
`width`		Width
`xmlId`		SKU ID in the warehouse system

Available prices `OfferPrice`

Object/Field	History field code	Description
		Currency
`ordering`		Ordering
`previousPrice`		Previous price (in entity currency)
`price`		Price (in entity currency)
		Price type

Contragent `OrderContragent`

Object/Field	History field code	Description
`BIK`	`contragent.b_i_k`	RCBIC
`INN`	`contragent.i_n_n`	TIN
`KPP`	`contragent.k_p_p`	IECC
`OGRN`	`contragent.o_g_r_n`	PSRN
`OGRNIP`	`contragent.o_g_r_n_i_p`	PSRN of Individual entrepreneur
`OKPO`	`contragent.o_k_p_o`	RNNBO
`bank`	`contragent.bank`	Bank
`bankAccount`	`contragent.bank_account`	Settlement account
`bankAddress`	`contragent.bank_address`	Bank address
`certificateDate`	`contragent.certificate_date`	Certificate date
`certificateNumber`	`contragent.certificate_number`	Certificate number
`contragentType`	`contragent.contragent_type`	Contragent type (field can receive 3 values: <em>individual</em> - private individual, <em>legal-entity</em> - legal entity, <em>entrepreneur</em> - individual entrepreneur)
`corrAccount`	`contragent.corr_account`	Corresponding account
`legalAddress`	`contragent.legal_address`	Registration address
`legalName`	`contragent.legal_name`	Legal name

Delivery address `OrderDeliveryAddress`

Object/Field	History field code	Description
`block`	`delivery_address.block`	Entrance
`building`	`delivery_address.building`	Building
`city`	`delivery_address.city`	City (If `withType = true`, city will be displayed with locality type)
`cityType`		Locality type
`country`	`delivery_address.country`	Country ISO code (ISO 3166-1 alpha-2)
`deliveryTime`		`deprecated` Delivery time
`flat`	`delivery_address.flat`	Flat/office
`floor`	`delivery_address.floor`	Floor
`fullAddressString`		Address as string collected from fields. Parameter `withIndex` allows to display postal code
`house`	`delivery_address.house`	House
`housing`	`delivery_address.housing`	Housing
`index`	`delivery_address.index`	Postal code
`isEmpty`		Address is empty
`metro`	`delivery_address.metro`	Underground
`notes`	`delivery_address.notes`	Notes to address
`region`	`delivery_address.region`	Region
`street`	`delivery_address.street`	Street (If `withType = true`, street will be displayed with type)
`streetType`		Street type
`text`		Address as string

Order change `OrderHistory`

Object/Field	History field code	Description
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value
		Order item to which the change of the field relates
		Payment to which the change of the field relates

Order method `OrderMethod`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for orders received through API
`defaultForCrm`		Set by default for orders created in system
`name`		Name

Order item `OrderProduct`

Object/Field	History field code	Description
		Available item packs, within the one item position (recommended to use this method for getting items packs)
`basePurchasePrice`	`order_product.base_purchase_price`	Base purchasing price (in base currency)
`bonusesCharge`	`order_product.bonuses_charge`	Amount of debited bonuses
`bonusesCredit`	`order_product.bonuses_credit`	Amount of accrued bonuses
`comment`	`order_product.comment`	Comment to the order item
`createdAt`		Date of order item creation in the system
`discount`		`deprecated` Monetary discount per item
`discountManualAmount`	`order_product.discount_manual_amount`	Monetary discount per item (in entity currency)
`discountManualPercent`	`order_product.discount_manual_percent`	Percentage discount per item. System rounds this value up to 2 decimals
`discountPercent`		`deprecated` Percentage discount per item
`discountSumm`		Item discount considering quantity (in entity currency)
`discountTotal`	`order_product.discount_total`	Final monetary discount per item including all item and order discounts (in entity currency)
`id`	`order_product.id`	ID of order item
`initialPrice`	`order_product.initial_price`	Item price/SKU (in entity currency)
`initialSumm`		Item price considering quantity (in entity currency)
`isCanceled`		This order item is cancelled in the order
`isCanceledForApi`		This order item is cancelled in the order
		`deprecated` Marking codes. Use `markingObjects`
		Marking data
		SKU
		Order
`orderStatus`		Order status when changing of item status
		Item packs, within the one item position (including cancelled)
`price`		Item price with discount (in entity currency)
	`order_product.price_type`	Price type
`properties`		[array] Additional properties of the order item
`purchasePrice`		Purchasing price (in base currency)
`purchaseSumm`		Item purchasing price considering quantity (in base currency)
`quantity`	`order_product.quantity`	Quantity
	`order_product.status`	Status of the order item
`statusUpdatedAt`		Date of last status change of the order item
`summ`	`order_product.summ`	Item total sum considering discount and quantity (in entity currency)
		Unit
`vatRate`	`order_product.vat_rate`	VAT rate

Product marking code `OrderProductMarkingCode`

Object/Field	History field code	Description
`code`		Marking code value
`id`		ID code marking
`providerCode`		Provider code of marking codes. Possible values: `chestny_znak`, `giis_dmdk`

Pack - items pack, within the one item position, from one warehouse `OrderProductPack`

Object/Field	History field code	Description
`comment`		Comment to status
`deliveryNoteNumber`		Packing list number
`id`		ID
`invoiceNumber`		Invoice number
`isCanceled`		Pack transferred to cancellation status
		Item movement
		SKU
		Order
		Related item position in order
`purchasePrice`		Purchasing price (in base currency)
`purchaseSumm`		Purchasing sum for pack (in base currency)
`quantity`		Item quantity in pack
		Pack reservation
		Reservation warehouse
`shipmentDate`		Pack shipment date
		Shipping warehouse
		Item pack status
		Warehouse
`summ`		Total sum for pack (in entity currency)

Item status in order `OrderProductStatus`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`createdAt`		Creation date
`isCancelStatus`		Is cancellation status
`name`		Name
`ordering`		Ordering

Order type `OrderType`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for orders received through API
`defaultForCrm`		Set by default for orders created in system
`name`		Name
`ordering`		Ordering

Package `Package`

Object/Field	History field code	Description
`height`		Height
`items`		Package content
`length`		Length
`packageId`		Package number
`weight`		Weight
`width`		Width

Order item `PackageItemOrderProduct`

Object/Field	History field code	Description
`externalId`		`deprecated`External ID of order item
		External IDs of order item
`id`		ID of order item

Payment `Payment`

Object/Field	History field code	Description
`amount`	`payments.amount`	Amount (in entity currency)
`comment`	`payments.comment`	Comment
`externalId`	`payments.external_id`	External ID
`id`	`payments.id`	Payment ID
`paidAt`	`payments.paid_at`	Payment date. Don't forget to check the status of payment
	`payments.status`	Payment Status
	`payments.type`	Payment Type

Payment status `PaymentStatus`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for orders received through API
`defaultForCrm`		Set by default for orders created in system
`description`		Comment
`externalId`		External ID
`isPaymentComplete`		The sigh that order is paid
`name`		Name
`ordering`		Ordering
`paymentComplete`		The sigh that order is paid

Payment type `PaymentType`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for orders received through API
`defaultForCrm`		Set by default for orders created in system
`description`		Comment
`name`		Name

Product `Product`

Object/Field	History field code	Description
`abcClass`		ABC-classification of item
`active`		Activity
`article`		Vendor code
		Catalog
`createdAt`		Order creation date in the system
`description`		Description
`displayName`		Manufacturer + item name
`externalId`		Item external ID
		Item groups, which contains this item
`id`		Product ID
`imageUrl`		Image URL
`manufacturer`		Manufacturer
`maxPrice`		Maximum item price (in base currency)
`maxPurchasePrice`		Maximum item purchasing price (in base currency)
`maxWeight`		Maximum weight
`minPrice`		Minimum item price (in base currency)
`minPurchasePrice`		Minimum item purchasing price (in base currency)
`minWeight`		Minimum weight
`name`		Name
`novelty`		Mark New
		SKUs
		[array] Array of minimum and maximum item price
`popular`		Mark Sales leader
`quantity`		Quantity
`recommended`		Mark Recommended
		`deprecated` Store. Use `getCatalog()`
`stock`		Mark Best price
`typeCode`		Type (product `product` or service `service`)
		Unit
`updatedAt`		Date of editing the product in the system
`url`		Link to item page in the web-store
`weight`		Weight
`xyzClass`		XYZ-classification of item

Item group `ProductGroup`

Object/Field	History field code	Description
		Catalog
`description`		Description
`externalId`		Item group external ID
`id`		ID
`lvl`		Nesting level
`name`		Name
`nameWithDepth`		The name with indent, which matches to level of nesting
		Parental item group
		Store

Recommended product view `RecommendationProductView`

Object/Field	History field code	Description
`article`		Product article
`id`		Product ID
`imageUrl`		Product image URL
`name`		Product name
		Offer
		Product
`url`		Product URL

Pack reservation `Reserve`

Object/Field	History field code	Description
`createdAt`		Reservation creation date
`id`		ID
		Related pack
`purchasePrice`		Purchasing price (in base currency)
`quantity`		Quantity
		Warehouse

Trigger data of "Send message to chat" `RuleActionSendMGMessageExecution`

Object/Field	History field code	Description
		The list of messages sent as a result of the trigger action

Segment `Segment`

Object/Field	History field code	Description
`code`		Symbolic code
`customersCount`		Customer quantity in segment
`generatedAt`		Time of the last segment generation
`isDynamic`		Is this segment dynamic
`name`		Segment name

Abandoned session `SessionFinishedEvent`

Object/Field	History field code	Description
`beganAt`		Session started at
`finishedAt`		Session finished at
`lastActivityAt`		Last activity at
`sessionId`		Session ID
`systemSiteId`		Site ID

Store `Site`

Object/Field	History field code	Description
`active`		Activity status
`address`		Store address
`code`		Store symbolic code
		Legal entity
`corrAccount`		`deprecated` Corresponding account. Use `LegalEntity.corrAccount`
`country`		Default country
`createdAt`		Store creation date in the system
`currencyCode`		Currency symbolic code
`defaultForCrm`		Set by default for orders created in system
`description`		Comment
`giro`		`deprecated` Settlement account. Use `LegalEntity.bankAccount`
`id`		ID
`inn`		`deprecated` TIN. Use `LegalEntity.INN`
`legalEntity`		`deprecated` Legal entity. Use `LegalEntity.legalName`
`name`		Name
`ordering`		Ordering
`phones`		Store phones
`url`		Store URL
`zip`		Zip code

Source `Source`

Object/Field	History field code	Description
`adContentName`		Ad content
`campaignName`		Campaign
`id`		Source ID
`keywordName`		Keyword
`mediumName`		Medium
`sourceName`		Source as string

Specialist `Specialist`

Object/Field	History field code	Description
`active`		Activity status
`createdAt`		Specialist creation date
`description`		Description
`email`		Email
`firstName`		First name
`fullName`		Full name
`id`		Specialist ID
`lastName`		Last name
`patronymic`		Patronymic
		Contact phone
		Services provided
		Store
`specialization`		Specialization
		User

Specialist service `SpecialistService`

Object/Field	History field code	Description
`duration`		Duration for the specialist in minutes
`id`		Specialist service ID
		Service offer
`price`		Price for the specialist (in entity currency)
		Specialist

Order status `Status`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
		Status group, which contains this status
`groupCode`		Symbolic code of the status group, which contains this status
`name`		Name
`ordering`		Ordering

Status color theme `StatusColorTheme`

Object/Field	History field code	Description
`background`		Background color
`border`		Border color
`codeString`		Color theme symbolic code
`icon`		Icon color
`text`		Text color

Status group `StatusGroup`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`color`		Color used when displaying group
		Status group color theme
`custom`		The sign that group is added by user
`editable`		Is the group editable
`name`		Name
`ordering`		Ordering
`process`		Is the order processing status or not
		Orders statuses included in this group
`statusesCode`		[array] Symbolic codes of order statuses included in this group

Warehouse `Store`

Object/Field	History field code	Description
`active`		Activity status
		Warehouse address
`code`		Symbolic code
`contact`		Contact person at the warehouse
`createdAt`		Warehouse creation date in the system
`description`		Warehouse description
`email`		Warehouse email
`externalId`		External ID
`id`		Warehouse ID
`name`		Name
`ordering`		Ordering
		Warehouse phone
`type`		Warehouse type (`store-type-retail` - retail store, `store-type-online` - online-store, `store-type-warehouse` - warehouse, `store-type-supplier` - the supplier's warehouse)
		Working time

Warehouse address `StoreAddress`

Object/Field	History field code	Description
`block`		Entrance
`building`		Building
`city`		City (If `withType = true`, city will be displayed with locality type)
`cityType`		Locality type
		Coordinates (Type `Model\Point`)
`country`		Country
`flat`		Flat/office
`floor`		Floor
`fullAddressString`		Address as string collected from fields. Parameter `withIndex` allows to display postal code
`house`		House
`housing`		Housing
`index`		Postal code
`isEmpty`		Address is empty
`metro`		Underground
`notes`		Notes to address
`region`		Region
`street`		Street (If `withType = true`, street will be displayed with type)
`streetType`		Street type
`text`		Address as string

Warehouse work time `StoreWorkTime`

Object/Field	History field code	Description
`day`		Day of the week (0 - Sunday, 6 - Saturday)
`lunchFrom`		Start of the lunch time interval (in `H:i` format)
`lunchUntil`		End of the lunch time interval (in `H:i` format)
`workFrom`		Start of the warehouse work time interval (in `H:i` format)
`workUntil`		End of the warehouse work time interval (in `H:i` format)

Task `Task`

Object/Field History field code Description

getAttachments()

Files

commentary

getCommentary()

commentary

Commentary, related to the task

complete

getComplete()

complete

Sign of the task execution

completedAt

getCompletedAt()

completed_at

Task completion time

createdAt

getCreatedAt()

created_at

Creation date

getCustomer()

customer

Customer, related to the task

Object code	Name
	Customer
	Corporate customer

datetime

getDatetime()

datetime

Task execution date

hasTag

hasTag(string name)

Check if an object has a tag

id

getId()

id

Task ID

getOrder()

order

Order, related to the task

getPerformer()

performer

Task executor

Object code	Name
	Users group
	User

phone

getPhone()

phone

Phone number, related to the task

getPhoneSite()

phone_site

Store, related to recall task

priority

getPriority()

priority

Task priority

getTags()

Task change `TaskHistory`

Object/Field	History field code	Description
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value
		User comment on the task

Ticket `Ticket`

Object/Field History field code Description

getAttachments()

Attachments

getAuthor()

Ticket author

getComments()

comments

Comments

getCompany()

company

Company

getContact()

contact

Contact

createdAt

getCreatedAt()

created_at

Created at

customField

getCustomField(string code)

Returns value of the specific custom field. Parameter code equals a symbolic code of custom field.

customFields

getCustomFields()

Associative array of custom fields

getCustomer()

customer

Customer

Object code	Name
	Customer
	Corporate customer

customerType

getCustomerType()

Customer type

description

getDescription()

description

Description

externalId

getExternalId()

External identifier

fromApi

getFromApi()

from_api

Ticket from API

hasTag

hasTag(string name)

Check if an object has a tag

id

getId()

id

Identifier

getIssues()

issues

Ticket issues

number

getNumber()

number

Number

getOrderProducts()

Linked order items

getOrders()

Linked orders

realNumber

getRealNumber()

Real number

getSite()

site

Store

getSla(datetime|null now = null)

Ticket SLA

getStatus()

Ticket status

systemCreatedAt

getSystemCreatedAt()

Added to system at

getTags()

Ticket channel `TicketChannel`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for ticket channels received through API
`defaultForCrm`		Set by default for ticket channels created in system
`name`		Name
`ordering`		Ordering

Ticket comment `TicketComment`

Object/Field	History field code	Description
`createdAt`		Created at
`id`		Identifier
`text`	`comments.text`	Text
`updatedAt`		Updated at

Ticket change `TicketHistory`

Object/Field	History field code	Description
`fieldName`		Field name
`newValue`		New value
`oldValue`		Old value
		Ticket comment to which the field change relates
		Ticket issue to which the field change relates

Ticket issue `TicketIssue`

Object/Field History field code Description

closedAt

getClosedAt()

Closed at

id

getId()

Identifier

getResponsible()

issues.responsible

Responsible

Object code	Name
	Users group
	User

getSla(datetime|null now = null)

Ticket issue SLA

getStatus()

issues.status

Ticket status

getTicketSubtopic()

issues.ticket_subtopic

Ticket subtopic

getTicketType()

issues.ticket_type

Ticket type

urgentAt

getUrgentAt()

SLA urgent at

warningAt

getWarningAt()

SLA warning at

Ticket status `TicketStatus`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
		Status group
`groupCode`		Status group symbolic code
`isCompleted`		Ticket completed
`name`		Name
`ordering`		Ordering

Ticket status group `TicketStatusGroup`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`colorCode`		Color theme symbolic code
		Status group color theme
`isCustom`		Custom group
`name`		Name
`ordering`		Ordering

Ticket subtopic `TicketSubtopic`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`name`		Name
`ordering`		Ordering
		Topic

Ticket topic SLA `TicketTopicSla`

Object/Field	History field code	Description
`durationUrgent`		Urgency threshold
`durationWarning`		Warning threshold
`id`		Identifier
		Ticket topic
		User group

Ticket type `TicketType`

Object/Field	History field code	Description
`active`		Activity status
`code`		Symbolic code
`defaultForApi`		Set by default for tickets received through API
`defaultForCrm`		Set by default for tickets created in system
`name`		Name
`ordering`		Ordering

Ticket type SLA `TicketTypeSla`

Object/Field	History field code	Description
`durationUrgent`		Urgency threshold
`durationWarning`		Warning threshold
`id`		Identifier
		Ticket type
		User group

User `User`

Object/Field	History field code	Description
`active`		Active
		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
`avgMarginSumm`		Average margin of orders assigned to a manager (in base currency)
`avgSaleSumm`		Average value of orders assigned to a manager (in base currency)
`createdAt`		User creation date
`customersCount`		The average number of customers assigned to a manager
`cutName`		Name and surname
`emailAddress`		User email
`firstName`		Name
`groupCodes`		Symbolic codes of user groups
`hasGroup`		Verification that the user included in specified group
`id`		User ID
`isAdmin`		Is an administrator
`isDeliveryMan`		User is responsible for delivery
`isManager`		User is a manager
`language`		Language
`lastName`		Surname
`marginSumm`		Total margin of orders assigned to a manager (in base currency)
`nickName`		Full name
`ordersCount`		The average number of orders assigned to a manager
`patronymic`		Middle name
`phone`		Phone
`phoneTfa`		Phone number for authentication
`position`		Position
`restrictedByDeliveryTypes`		User access to order is restricted by delivery types
		`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
`totalSaleSumm`		Total sum of orders aasigned to a manager (in base currency)

Welcome-bonuses event `WelcomeLoyaltyEvent`

Object/Field	History field code	Description
`id`		Event ID
`privilegeSize`		Discount amount for products at a regular price (in entity currency)
`privilegeSizePromo`		Discount amount for products at a promotion price (in entity currency)
`privilegeType`		Type of privilege on the event. Possible values: `bonus`, `discount`

Thank you for your feedback.

Was this article helpful?

Yes

Object/Field	History field code	Description
`json`		JSON-decoded response body
`raw`		Raw response body

Object/Field	History field code	Description
`id`	`comments.id`	Task comment ID
`text`	`comments.text`	Task comment text

Copy the link to the article Copied Reference book of objects Copy the link to the article Copied

Objects

Order Order

Customer Customer

Change set Change\EntityChangeSet

Call Call

Data when the trigger occurs RuleExecution

Corporate customer CustomerCorporate

API key ApiKey

Service booking Appointment

Booking change AppointmentHistory

Booking service AppointmentService

Attachment Attachment

Birthday event BirthdayLoyaltyEvent

Cart Cart

Cart item CartItem

Catalog Catalog

Google Analytics unique clientId ClientId

Code/value dictionary CodeValueModel

Company Company

Contragent CompanyContragent

Complementary products ComplementaryProductRecommendationMechanic

Cost Cost

Costs item CostItem

Courier Courier

Courier delivery service data CourierData

Courier phone CourierPhone

Currency Currency

Directory element CustomDictionaryElement

Custom event CustomLoyaltyEvent

Customer address CustomerAddress

Contact person CustomerContact

Contact person`s company CustomerContactCompany

Contragent CustomerContragent

Corporate customer change CustomerCorporateHistory

Customer change CustomerHistory

Note CustomerNote

Customer phone CustomerPhone

Client's subscription CustomerSubscription

Customer visit in site CustomerVisit

DDelivery delivery service data DDeliveryData

Delivery service DeliveryService

Delivery type DeliveryType

File File

Data of the delivery service, connected by API GenericData

Users group Group

Response to JS module backend request HttpCallResponse

Response body to JS module backend request HttpCallResponseBody

Leftover stock by warehouses Inventory

KazPost delivery service data KazPostData

Knowledge base document KnowledgeBaseDocument

Knowledge base document change KnowledgeBaseDocumentHistory

Knowledge base section KnowledgeBaseSection

Legal entity LegalEntity

Email Letter

Segment criterion value Literal

Loyalty program Loyalty

Participation in the loyalty program LoyaltyAccount

Information about the bonus account of the participation LoyaltyAccountInfo

Change of participation in the loyalty program LoyaltyAccountTimeline

Discount on the event of the loyalty program LoyaltyEventDiscount

Level of participation in the loyalty program LoyaltyLevel

MessageGateway bot MGBot

MessageGateway channel MGChannel

MessageGateway customer MGCustomer

MessageGateway Dialog MGDialog

Message in chats MGMessage

Customer reply to the message MGReply

MessageGateway user MGUser

SKU or product group Model\CatalogItem

Subscription confirmation link Model\ConfirmUrlSandbox

Operation with bonus account Model\LoyaltyBonusOperation

Coordinates Model\Point

Price range Model\PriceRange

Recommendation group Model\RecommendationGroup

Group of recommedations for event "Item or item group view" Model\RuleActivationItem

Personal date event Model\RulePersonalSandbox

SLA Model\TicketSla

Information on time range Model\TimeInterval

Unsubscribe url Model\UnsubscribeSandbox

Reference book of objects

Order `Order`

Customer `Customer`

Change set `Change\EntityChangeSet`

Call `Call`

Data when the trigger occurs `RuleExecution`

Corporate customer `CustomerCorporate`

API key `ApiKey`

Service booking `Appointment`

Booking change `AppointmentHistory`

Booking service `AppointmentService`

Attachment `Attachment`

Birthday event `BirthdayLoyaltyEvent`

Cart `Cart`

Cart item `CartItem`

Catalog `Catalog`

Google Analytics unique clientId `ClientId`

Code/value dictionary `CodeValueModel`

Company `Company`

Contragent `CompanyContragent`

Complementary products `ComplementaryProductRecommendationMechanic`

Cost `Cost`

Costs item `CostItem`

Courier `Courier`

Courier delivery service data `CourierData`

Courier phone `CourierPhone`

Currency `Currency`

Directory element `CustomDictionaryElement`

Custom event `CustomLoyaltyEvent`

Customer address `CustomerAddress`

Contact person `CustomerContact`

Contact person`s company `CustomerContactCompany`

Contragent `CustomerContragent`

Corporate customer change `CustomerCorporateHistory`

Customer change `CustomerHistory`

Note `CustomerNote`

Customer phone `CustomerPhone`

Client's subscription `CustomerSubscription`

Customer visit in site `CustomerVisit`

DDelivery delivery service data `DDeliveryData`

Delivery service `DeliveryService`

Delivery type `DeliveryType`

File `File`

Data of the delivery service, connected by API `GenericData`

Users group `Group`

Response to JS module backend request `HttpCallResponse`

Response body to JS module backend request `HttpCallResponseBody`

Leftover stock by warehouses `Inventory`

KazPost delivery service data `KazPostData`

Knowledge base document `KnowledgeBaseDocument`

Knowledge base document change `KnowledgeBaseDocumentHistory`

Knowledge base section `KnowledgeBaseSection`

Legal entity `LegalEntity`

Email `Letter`

Segment criterion value `Literal`

Loyalty program `Loyalty`

Participation in the loyalty program `LoyaltyAccount`

Information about the bonus account of the participation `LoyaltyAccountInfo`

Change of participation in the loyalty program `LoyaltyAccountTimeline`

Discount on the event of the loyalty program `LoyaltyEventDiscount`

Level of participation in the loyalty program `LoyaltyLevel`

MessageGateway bot `MGBot`

MessageGateway channel `MGChannel`

MessageGateway customer `MGCustomer`

MessageGateway Dialog `MGDialog`

Message in chats `MGMessage`

Customer reply to the message `MGReply`

MessageGateway user `MGUser`

SKU or product group `Model\CatalogItem`

Subscription confirmation link `Model\ConfirmUrlSandbox`

Operation with bonus account `Model\LoyaltyBonusOperation`

Coordinates `Model\Point`

Price range `Model\PriceRange`

Recommendation group `Model\RecommendationGroup`

Group of recommedations for event "Item or item group view" `Model\RuleActivationItem`

Personal date event `Model\RulePersonalSandbox`

SLA `Model\TicketSla`

Information on time range `Model\TimeInterval`

Unsubscribe url `Model\UnsubscribeSandbox`

Link to the web version of the email `Model\WebVersionUrlSandbox`