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