OrderField Documentation

OrderField Documentation

  • Docs
  • App

Attributes

The following attributes can be used to configure an OrderField instance.

Tenant attributes

Collection: tenant > tenant__settings

AttributeFormatRemarks
ga_tracking_idOptional
GA Tracking ID

Example
{"key" : "ga_tracking_id", "value" : "UA-87774626-1"}
gtm_tracking_idOptional
GTM Tracking ID

Example
{"key" : "gtm_tracking_id", "value" : "UA-87774626-1"}
quantity_pickerOptional
Indicates which quantity picker should be used

Example
{"key" : "quantity_picker", "value" : "relative"}

Syntax
absolute (default) ; relative
  • absolute
    shows the absolute quantity and uses that value for calculations (e.g. 1 box of 12 pieces -> 12 pieces)
  • relative
    shows the number of sales units and uses that value for calculations (e.g. 1 box of 12 pieces -> 1 box)
MAIL_ORDER_CONFIRMATIONOptional
Settings of the order confirmation emails

Sub-attributes
  • mail_from
    From-address
  • mail_cc (array)
    CC to
  • mail_bcc (array)
    BCC to
  • default_template_id
    Postmark template ID
  • template_ids (array)
    Postmark template ID per language
  • logo_url
    Logo URL
  • mail_sender_name
    Name of the sender
  • If no settings are available, the default OrderField values are used
show_breadcrumbsOptional
Indicates if breadcumbs should be shown

Example
{"key" : "show_breadcrumbs","value" : false,"roles" : []}

Syntax
true (default) ; false

Page attributes

AttributeFormatRemarks
bannerBanner settings for this page

Sub-attributes
  • img
    Image url
  • title
    Title
  • subTitle
    Subtitle
  • buttonText
    Text in the button
  • linkToPage
    Link url
Applicable to
  • Home
  • Catalog
  • Favorites
Title, subtitle and buttontext can be translated
blocksBlock settings for this page

Sub-attributes
  • img
    Image url
  • title
    Title
  • subTitle
    Subtitle
  • buttonText
    Text in the button
  • linkToPage
    Link url
  • sortorder
    Sort order of this block
Applicable to
  • Home
Title, subtitle and buttontext can be translated
showThumbnails Indicates that thumbnails of the product pictures should be shown

Example
"settings" : [ {"platform" : "all", "key" : "showThumbnails", "value" : true} ]
Applicable to
  • Catalog
showFavoriteIcon Indicates that favorite icons should be shown

Example
"settings" : [ {"platform" : "all", "key" : "showFavoriteIcon", "value" : true} ]
Applicable to
  • Item tile
  • Item details
showAttributes Determines which attributes should be shown

Example
"settings" : [ {"platform" : "all", "key" : "showAttributes", "value" : [ ]} ]
Applicable to
  • Item details
showFacets Determines which facets should be shown

Example
"settings" : [ {"platform" : "all", "key" : "showFacets", "value" : ["scent", "color"]} ]
Applicable to
  • Item details
facetgroups Determines which facet groups should be shown as filters

Example
"facetgroups" : ["scent", "color","season","usage"]
Applicable to
  • Catalog
  • Favorites
  • Search
showSalesOrderAddressInfo Set this to false if no delivery address info is available for previous orders. The previous orders will then be shown in a more compact list.

Example
"settings" : [ {"platform" : "all", "key" : "showSalesOrderAddressInfo", "value" : true} ]
Applicable to
  • Item details
showDeliveryColumn Determines if delivery column is shown

Example
"settings" : [ {"platform" : "all", "key" : "showDeliveryColumn", "value" : true} ]
Applicable to
  • Checkout
showTermsAndConditionsCheckbox Determines if terms & conditions checkbox is shown

Example
"settings" : [ {"platform" : "all", "key" : "showTermsAndConditionsCheckbox", "value" : true} ]
Applicable to
  • Checkout
customerReferenceMaxLength Determines max length of the reference field

Example
"settings" : [ {"platform" : "all", "key" : "customerReferenceMaxLength", "value" : 25} ]
Applicable to
  • Checkout
showUomInfoForUoms Determines to which customer group the pallet calculation is shown

Example
"settings" : [ {"platform" : "all", "key" : "showUomInfoForUoms ", "value" : ["PL"]} ]
Applicable to
  • Checkout
showOrderType Determines if Order Type choice is shown

Example
"settings" : [ {"platform" : "all", "key" : "showOrderType", "value" : false} ]
Applicable to
  • Checkout

Customer (group) attributes

See ERP data

User settings

todo

Last updated on 6/12/2019
  • Tenant attributes
  • Page attributes
  • Customer (group) attributes
  • User settings
OrderField Documentation
Docs
Starten met OrderField
Meer
Over OrderFieldContact
Copyright © 2019 OrderField