OrderField Documentation

OrderField Documentation

  • Docs
  • App

›Configuration

Starten met OrderField

  • Introductie
  • ERP Data
  • Orders

Opties

  • Catalogusindeling
  • Order types
  • Toekomstige voorraad
  • Talen
  • Leverdagen
  • Huisstijl

Configuration

  • Pages
  • Tenants
  • Customers
  • Products
  • Prices
  • Customergroups

Pages

The following default pages can be configured in OrderField:

  • Home
  • Catalog
    • Item tile
    • Item detail
  • Favorites
  • Orderhistory
  • Checkout
  • Search

Home

Basic configuration

{
    "code" : "home",
    "i18n" : [],
    "name" : "Home",
    "sortOrder" : 1,
    "type" : "home"
}

Attributes

  • banner
  • blocks

Catalog

Basic configuration

{
    "code" : "catalog",
    "i18n" : [],
    "name" : "Catalog",
    "sortOrder" : 1,
    "type" : "catalog"
}

Attributes

  • showThumbnails
  • facetgroups
  • banner

Item tile

Determines the content of tiles shown on the catalog page

Basic configuration

{
    "code" : "item_catalog",
    "i18n" : [],
    "name" : "Item catalog",
    "sortOrder" : 1,
    "type" : "catalog"
}

Attributes

  • showFavoriteIcon
  • showAttributes
  • showFacets

Item details

Determines the content of the item details page

Basic configuration

{
    "code" : "item_details",
    "i18n" : [],
    "name" : "Item details",
    "sortOrder" : 1,
    "type" : "catalog"
}

Attributes

  • showFavoriteIcon
  • showAttributes
  • showFacets
  • showSalesOrderAddressInfo

Favorites

Basic configuration

{
    "code" : "favorites",
    "i18n" : [],
    "name" : "Favorites",
    "sortOrder" : 1,
    "type" : "catalog"
}

Attributes

  • showFavoriteIcon
  • showAttributes
  • showFacets
  • facetgroups
  • banner

Orderhistory

Basic configuration

{
    "code" : "orderhistory",
    "i18n" : [],
    "name" : "Order history",
    "sortOrder" : 1,
    "type" : "orderhistory"
}

Attributes

  • banner
  • facetgroups

Checkout

Basic configuration

{
    "code" : "checkout",
    "i18n" : [],
    "name" : "Checkout",
    "sortOrder" : 1,
    "type" : "checkout"
}

Attributes

  • showDeliveryColumn
  • showTermsAndConditionsCheckbox
  • customerReferenceMaxLength
  • showUomInfoForUoms
  • showOrderType

Search

Basic configuration

{
    "code" : "search",
    "i18n" : [],
    "name" : "Search",
    "sortOrder" : 1,
    "type" : "search"
}

Attributes

  • facetgroups

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" : ["barcode" ]} ]
Applicable to
  • Item details
Difference between facets and attributes is that attributes are unique per product
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
Last updated on 6/12/2019
← HuisstijlTenants →
  • Home
  • Catalog
  • Item tile
  • Item details
  • Favorites
  • Orderhistory
  • Checkout
  • Search
  • Page attributes
OrderField Documentation
Docs
Starten met OrderField
Meer
Over OrderFieldContact
Copyright © 2019 OrderField