Orders

A key entity in OrderFlow is the order, which represents a set of items that have been submitted for despatch, typically following the sale of items to end users.

The main relationships on the system for orders are shown below.

Order Entities

Address and Contact Information

Note where address and contact date can be stored:

Order delivery address: This will always be populated.
Order invoice address: The convention is to use the delivery address if this is not set.
Shipment address: The purpose of this is to override the order delivery address, if necessary, allowing different shipments for the same order to have different addresses).

The following are the address fields used in OrderFlow.

Address Fields

Field Name	Description
line1	Line 1 of address
line2	Line 2 of address
line3	Line 3 of address
line4	Line 4 of address
line5	Line 5 of address
line6	Line 6 of address
postCode	Post code, which will be present for countries and localities that support post codes
countryCode	2 character ISO code for country
OrderFlow provides some flexibility over which fields are used for specific purposes, such as city, region, etc.,
required in interactions with third party systems.

This is done through a set of application properties which can be used to refine:

Address Line Properties

Property Name	Description
`address.building.field`	Used to identify the 'building' element of an address.
`address.city.field`	Used to hold the city or town value for an address.
`address.locality.field`	Used to identify the 'locality' element of an address.
`address.region.field`	Used to hold the state or region value for an address.

For each set of addresss fields, there is a parallel set of contact fields available, which are described below:

Contact Fields

Field Name	Description
contactName	"The full name of the recipient or invoicee, usually consisting of first and last name in a single field."
salutation	The person's title. Only used in some environments.
firstName	The person's first name. Only used in some environments.
lastName	The person's last name. Only used in some environments.
emailAddress	The person's email address. This is almost always provided with incoming order data.
dayPhoneNumber	"The best number to reach the person during the day time, either a work or home number."
eveningPhoneNumber	"The best number to reach the person in the evening, typically the home number."
mobilePhoneNumber	The person's mobile phone number.
faxNumber	The person's fax number. Very rarely used these days.
companyName	The company name. Applies for orders placed to business addresses.

Address and contact fields are often used together, for obvious reasons.

Pricing Information

Orders typically are received with prices. This is generally for a number of reasons:

so that pricing information can be shown on customer paperwork.
pricing information is also necessary for international shipments for which customs documentation is required.
to be used in custom reports.
to be fed through to other back end systems.

It is useful to be aware of the pricing fields available and the convention for their use on OrderFlow.

We start with the elements that make up a 'price' or OrderFlow, then go on to the places where prices are applied.

Price Components

All price values on OrderFlow have the following components:

Currency: the currency in which the price value is given.
Gross: the gross price value, after tax.
Tax: the tax value applied to the price.
Net: the net price value, before tax.
Tax Code: optional tax code for the tax value of the price.

When price values are received, some but not all of these values may be provided. OrderFlow is able to calculate implicit values for price elements where necessary. For example, if the gross and tax values are given, OrderFlow can implicitly calculate the net value as the gross less the tax value.

Price Values

The following price values are set up on the system.

Price Values

Entity	Name	Description
Order	Total Price	The full price of the order, including goods and shipping. Normally received from the eCommerce system.
Order	Goods Price	The price of goods received in the order, but excluding shipping. Can be calculated from the individual line or even product prices.
Order	Shipping Price	The price charged for shipping the order to the customer.
Order Line	Total Price	The total price for the line. Normally received from the eCommerce system, but can be calculated from the unit price.
Order Line	Unit Price	The unit price for the order line. Represents the price applied to a single unit for the line.
Product	Price	The sale price for the product. Can be used to derive order line unit price, but may differ from the received value for the order line if a discount has been applied on the eCommerce system.

Note that where possible we encourage customers to leave price calculations to the eCommerce system, only doing price calculations on OrderFlow when it is absolutely necessary and there is no alternative.