This Standard Operating Procedure (SOP) describes different scenarios & processes for setting up order header settings & preferences utilizing IP1 Web Services.

This is sub-process for the different ordering scenarios outlined in:

Contact details & Delivery address selections for orders are covered off in the order process SOPs above. They are not included in this SOP.

Procedure

It is your responsibility to ensure that you understand this procedure before performing the following tasks.

Note	Deviations from this procedure should be covered by procedures written by your company. Before performing any tasks please ensure all the business rules are set-up accordingly.

Process overview This section documents the Headline Processes for the website and web user to manage order settings & preferences in IP1. It assumes: Website has already created an anonymous or registered session For registered session (particularly B2B), confirmed selection of customer account. Refer Logging In and Out – Multiple Accounts For registered session, established order type (eg. B2B vs B2C) Refer Establish Order Type Depending on business requirements for the implementation, some of these settings may be determined before or during build of the shopping cart details. For example, there may be a business requirement to override Type of Sales at order header level. In that case, it would be better to do this up front, as the pricing & availability for different items could be affected by this selection. However, most selections will normally be managed at the ‘check out’ phase of ordering, after user has made their delivery address selections and customerReference has been determined, and before proceeding to payment for the order. User is presented with freight and payment options from viewCart. Refer Entry Option Rule scenario and Individual Field settings in updateHeader sections of this SOP Refer Payment Method Selection. User selects freight and payment option and website executes updateHeader then viewCart to display revised shopping cart details and total amounts based on revised order settings & preferences. Website also displays the revised total order amount based on selected freight option.
Additional notes and scenario variations Entry option rule scenario Each order has a number of fields at header level which define how the order will behave in IP1 and also how it is reported. These fields will pick up default values initially based on the selected orderType (refer TMSDS/OM* configurations) or simply from the customer account. In some cases, there may be a need to override some of these defaults. Most commonly, this would be to allow the web user to nominate their preferred freight options, which will typically attract a different charge fee (eg. Overnight courier, Air freight, Road freight, or specific carrier / priority selection). Although it is possible to individually override most of these using updateHeader, IP1 has a facility called “Order Entry Options” which can be configured in IP1 then used by the website to present one or more check box or drop down list selections that would then override one or more of the following fields: Immediate picking slip flag Immediate document flag Minimum invoice flag Order priority Carrier Payment terms Due month Payment terms description Release priority Forwarding agent Order pick category W/h instruction Special instruction The main advantages of utilizing the Order Entry Options approach are: Enables simple presentation of available options to the end user via viewCart response data Assuming freight charge configurations are in place in IP1, viewCart also returns associated charge fees for each option which can be presented by website to the user to assist their selection. Allows website to simply nominate the selected option(s) on updateHeader rather than website needing knowledge of all the business rules/options and valid codes for each field. entryOptionForm – Values are retrieved from viewCart, changes the freight and priority methods entryOptionInput entryOptionType entryOptionValue Refer to “Order Entry Options” in Basic Information & Terminology.
Individual field settings in updateHeader If the business DOES NOT utilize Entry Option Rules, those fields described in section above can be individually overridden using updateHeader. Even if the business DOES decide to utilize Entry Option Rules, there may also be a business requirement to override some other field settings which cannot be set using the Entry Option Rules. Most common examples are: orderTypeOfSale salesRepCode promotionId couponCode Important note: When modifying the header orderTypeOfSale code, updateHeader must be executed twice. updateHeader may also be used to update other fields such as: orderType (refer Establish Order Type) emailAddress (but this is normally taken from contact details by default) Delivery address details (refer to the different SOPs for B2C and B2B ordering processes) Billing address details (normally left as default) Etc Refer to Basic Information & Terminology for detailed description of all input & response fields available.

Process overview

This section documents the Headline Processes for the website and web user to manage order settings & preferences in IP1.

It assumes:

Website has already created an anonymous or registered session
For registered session (particularly B2B), confirmed selection of customer account.
- Refer Logging In and Out – Multiple Accounts
For registered session, established order type (eg. B2B vs B2C)
- Refer Establish Order Type

Depending on business requirements for the implementation, some of these settings may be determined before or during build of the shopping cart details. For example, there may be a business requirement to override Type of Sales at order header level. In that case, it would be better to do this up front, as the pricing & availability for different items could be affected by this selection.

However, most selections will normally be managed at the ‘check out’ phase of ordering, after user has made their delivery address selections and customerReference has been determined, and before proceeding to payment for the order.

User is presented with freight and payment options from viewCart.
- Refer Entry Option Rule scenario and Individual Field settings in updateHeader sections of this SOP
- Refer Payment Method Selection.
User selects freight and payment option and website executes updateHeader then viewCart to display revised shopping cart details and total amounts based on revised order settings & preferences.
Website also displays the revised total order amount based on selected freight option.

Additional notes and scenario variations

Entry option rule scenario

Each order has a number of fields at header level which define how the order will behave in IP1 and also how it is reported. These fields will pick up default values initially based on the selected orderType (refer TMSDS/OM* configurations) or simply from the customer account.

In some cases, there may be a need to override some of these defaults. Most commonly, this would be to allow the web user to nominate their preferred freight options, which will typically attract a different charge fee (eg. Overnight courier, Air freight, Road freight, or specific carrier / priority selection).

Although it is possible to individually override most of these using updateHeader, IP1 has a facility called “Order Entry Options” which can be configured in IP1 then used by the website to present one or more check box or drop down list selections that would then override one or more of the following fields:

Immediate picking slip flag
Immediate document flag
Minimum invoice flag
Order priority
Carrier
Payment terms
Due month
Payment terms description
Release priority
Forwarding agent
Order pick category
W/h instruction
Special instruction

The main advantages of utilizing the Order Entry Options approach are:

Enables simple presentation of available options to the end user via viewCart response data
Assuming freight charge configurations are in place in IP1, viewCart also returns associated charge fees for each option which can be presented by website to the user to assist their selection.
Allows website to simply nominate the selected option(s) on updateHeader rather than website needing knowledge of all the business rules/options and valid codes for each field.
entryOptionForm – Values are retrieved from viewCart, changes the freight and priority methods
- entryOptionInput
  - entryOptionType
  - entryOptionValue

Refer to “Order Entry Options” in Basic Information & Terminology.

Individual field settings in updateHeader

If the business DOES NOT utilize Entry Option Rules, those fields described in section above can be individually overridden using updateHeader.

Even if the business DOES decide to utilize Entry Option Rules, there may also be a business requirement to override some other field settings which cannot be set using the Entry Option Rules. Most common examples are:

orderTypeOfSale
salesRepCode
promotionId
couponCode

Important note: When modifying the header orderTypeOfSale code, updateHeader must be executed twice.

updateHeader may also be used to update other fields such as:

orderType (refer Establish Order Type)
emailAddress (but this is normally taken from contact details by default)
Delivery address details (refer to the different SOPs for B2C and B2B ordering processes)
Billing address details (normally left as default)
Etc

Refer to Basic Information & Terminology for detailed description of all input & response fields available.