OrderField Documentation

OrderField Documentation

  • Docs
  • App

›Starten met OrderField

Starten met OrderField

  • Introductie
  • ERP Data
  • Orders

Opties

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

Configuration

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

ERP Data

Tijdens het aansluiten van je bedrijf wordt je ERP data 'gemapt' naar het datamodel van OrderField. Hieronder de belangrijkste entiteiten en attributes.

  • Klanten
  • Producten
  • Prijzen

Klanten

Klanten hebben doorgaans onderstaande attributes

AttributeFormatRemarks
codeRequired
Your customers's unique identifier

Example
12345

Syntax
Max 50 characters
  • Use a unique value for each customer
  • Keep the code the same when updating your data
  • Use only valid unicode characters. Avoid invalid characters like control, function, or private area characters
  • Use the same code for the same customer - across countries or languages
nameRequired
Your customer's name

Example
Acme Company

Syntax
Max 150 characters
  • Try to keep the name clean (avoid codes, remarks, unnecessary characters)
addressesRequired
Array with your customer's address(es)

Example
["isPrimary":true, "code":"123456", "type":"Delivery", "name":"Cantona Olsztyn", "addressLine1":"ul. Kanta 230", "zipCode":"10-691", "city":"Olsztyn", "countryCode":"PL", "country":"Polska"]

Syntax
addresses uses 9 sub-attributes:
  • isPrimary (optional)
    The default address
  • code (optional)
    The unique address Id
  • type (optional)
    The address type: shipping or delivery
  • name (required)
    Name of the company
  • addressLine1 (required)
    Street and number
  • zipCode (required)
    Zip code
  • city (required)
    City
  • countryCode (required)
    Two character country code
  • country (optional)
    Country name
  • If your customer has one address, that's fine. Just make sure the required sub-attributes are filled.
phonenumberOptional
Your customer's phone number

Example
061234567

Syntax
Numeric max 12 characters
currencyOptional
Your customer's currency

Example
EUR

Syntax
3 character currency code (ISO 4217)
languageOptional
Your customer's preferred language

Example
en

Syntax
2 character language code (ISO 639-1)
  • Sets the default language in which the apps are initially displayed
  • Can be overridden by the customer accounts
blockedOptional
Indicates the customer is blocked

Example
true

Syntax
true ; false
1 ; 0
  • Blocked customers are not allowed to login or create user accounts
showpricesOptional
Indicates the customer is allowed to see prices

Example
true

Syntax
true ; false
1 ; 0
  • For (potential) customers that are allowed to view the products without prices or the ability place orders
minOrderValueOptional
Minimum order value

Example
360

Syntax
Numeric
  • Orders below this value can not be submitted
customergroupsOptional
The customer group(s) of the customer

Example
["country_10", "customergroup_9999"]

Syntax
Max 50 characters per customergroup
pricegroupsOptional
The price group(s) of the customer

Example
["retail_eu", "export"]

Syntax
Max 50 characters per pricegroup
  • Pricegroups can be applied to any number of customers

Producten

Productdata bestaat uit een aantal standaard gegevens

AttributeFormatRemarks
codeRequired
Your product’s unique identifier

Example
12345

Syntax
Max 50 characters
  • Use a unique value for each product. Use the product's SKU where possible
  • Keep the code the same when updating your data
  • Use only valid unicode characters. Avoid invalid characters like control, function, or private area characters
  • Use the same code for the same product - across countries or languages
nameRequired
Your product’s name

Example
Demo Guitar Deluxe

Syntax
Max 150 characters
  • Accurately describe your product
descOptional
Your product’s description

Example
The Demo Guitar Deluxe has a solid mahogany body with maple top and a rounded 50's-style mahogany neck with a rosewood fingerboard and trapezoid inlays.

Syntax
Max 5000 characters
  • Accurately describe your product
  • Don’t include promotional text like "free shipping," all capital letters, or gimmicky foreign characters
  • Include only information about the product
facetsOptional
Characteristics of your product

Example
["color=green","height=12","safety-class=S3","brand=10","producttype=12"]

Syntax
Max 50 characters per facet
  • Include one value per facet
  • Can be used to create (catalogue) filters on characteristics like brand or category
  • Can be displayed on the item details screen
  • Can be used for search
barcodeOptional
The barcode of your product

Example
8717847129192

Syntax
Max 50 numeric characters
  • Exclude dashes and spaces
  • Supported values include EAN, JAN, UPC, ISBN, ITF-14
  • Different barcodes for multipacks or bundles are supported
  • Can be used for scanning

Prijzen

Prijzen kunnen worden aangeleverd per product of per product / klant(groep).

AttributeFormatRemarks
productcodeRequired
Product code to which the price applies

Example
12345

Syntax
Max 50 characters
  • The product code should match one product
pricesRequired
Price(s) of your product

Example
[ "price" : 1.6, "currency" : "EUR", "minQuantity" : 1]

Syntax
prices uses 3 sub-attributes:
  • price (required)
    Numeric
  • currency (optional)
    ISO 4217
  • minQuantity (optional)
    Numeric
  • Multi currency is supported
pricegroupOptional
Price group to which the price applies

Example
pricegroup=ALL

Syntax
Max 50 characters
  • Price groups link customers to prices
minQuantityOptional
Minimum quantity

Example
120

Syntax
Numeric
  • The minimum quantity that can be ordered
steppingOptional
Number of products per sales unit

Example
12

Syntax
Numeric
  • Is used when a product ships in bundles of more than one piece per sales unit (e.g. 12 pieces in a box)
  • Can be used for pricing per sales unit (instead of pricing per piece)
Last updated on 6/11/2019
← IntroductieOrders →
  • Klanten
  • Producten
  • Prijzen
OrderField Documentation
Docs
Starten met OrderField
Meer
Over OrderFieldContact
Copyright © 2019 OrderField