Order Transitional Feed

Overview

The Transitional Order Feed receives historical order data for closed orders. Typically a client uses this feed as part of migrating to Radial Order Management from another order management platform.

For an overview of the data migration process, see Order Data Migration.

Order data comprises all data associated with a webstore order. Typically, transitional order data is limited to orders that customers have placed through the webstore. This data is used to populate customers' order history, and the historical orders can be made available to customer support systems.

Radial only receives the orders that are new to Radial Order Management and that are in a closed state in the transitional order data file.

Notes

• Default Format: XML
• Default Character Encoding: Unicode: UTF-8
• Recipient Acknowledgment Required: Yes
• Exchange Frequency: Client-specific. This data is typically transferred once just prior to the launch of the store on Radial Order Management. Additional order data can be transferred to Radial on an ongoing basis if it is necessary to update the initial set of data, or if needed for marketing.
• Production Mailbox Location: Client-specific
• Test Mailbox Location: Client-specific

Filename

The filename combined with the mailbox enables Radial middleware (the Order Data Hub) to determine the destination of the order data. The filename follows this pattern:

{client id}_{store id}_order-transitional_{date time stamp}.xml

• client id is the Radial-provided code that uniquely identifies a client.
• store id is the Radial-provided code that uniquely identifies a store.
• order-transitional is Radial-provided literal text that must follow store id.
• Date time stamp in YYYYMMDDHH24MISS format
  • YYYY = Year with Century
  • MM = Month of Year - number 01 -12, zero padded
  • DD = Day of Month - number 01-31, zero padded
  • HH24 = Hour of Day - number 00-23, zero padded
  • MI = Minute of Hour - number 00-59, zero padded
  • SS = Second of Minute - number 00-59, zero padded
• xml is the file extension that indicates the format of the file

Filename example: TMSNA_TMSUS_order-transitional_20180901062356.xml

Closed Orders Only

Radial receives only closed orders through this feed. A closed order is an order that:

• has been invoiced and fulfilled
• is not wholly or partly on a hold of any kind
• has had payment provided, the payment has been approved, the transaction has completed
• has been placed in state that denotes the full order has been ‘paid’.
• has been shipped from the fulfillment center and has been placed in state that denotes that the entire order has been ‘shipped’ and ‘fulfilled’.

Data Notes

A purchase order or sales order chained with purchase is not in scope. If this is required for your store's order data, talk to your Radial representative.

A return order is a separate transaction order with its own unique Order ID that should not be same as any other order (sales or return). We can allow migrating return orders into system after sales order. A return order should reference the sales order as indicated in this specification.

The Order ID in submitted order data must be a unique value for each customer sales order.

Orders placed by guest customers can be migrated as long as the order data is sent with all the required fields.

If other additional fields are needed, talk to your Radial representative.

Data Security

To secure data at the file level, SFTP is the preferred protocol for delivery of transitional order data files. All transitional order data files will be delivered to a pre-defined, client-specific mailbox. Radial will provide the location of the mailbox.

Best Practices

To ensure that your order data is loaded into Radial Order Management efficiently and accurately, follow the Data Migration Best Practices.

Schemas

• Order History Migration Feed schema
• Order History Datatypes schema

API Structure

Transitional Order element tables:

• Transitional Order XML Structure (Order Fields)
• Transitional Order XML Structure (Shipment Fields)

Examples

The following example files can be used as a reference for preparing your own order data.

• XML_DYO_Customization.xml
• XML_Exchange.xml
• XML_FullReturn.xml
• XML_FullyCancelled.xml
• XML_MultipleStatus.xml
• XML_MultipleTransactions.xml
• XML_PartialCancel.xml
• XML_PartialReturn.xml
• XML_PriceAdjustment.xml
• XML_Reship.xml
• XML_SingleOrder_MultiShip.xml
• XML_SingleOrder_SingleShip.xml
• XML_VGCPurchase.xml

When working with the example scenarios, refer to the following tables of key data values.

Data Keys

ISO Standards

Currency Xpath:

• Order\PriceInfo\@Currency
• Shipment\@Currency

Currency: http://www.wipo.int/wipostad/en/standards/isocurrencycodetype-v2001-1-en/1-0/xsd

Country Xpath:

• Order\PersonInfoBillTo\@Country
• Order\PersonInfoShipTo\@Country
• Order\OrderLines\OrderLine\PersonInfoShipTo\@Country
• Shipment\ToAddress\@Country
• Shipment\FromAddress\@Country

Country: http://www.wipo.int/standards/XMLSchema/trademarks/romarin/romarin_st66_doc/index_ISOCountryCodeType.html

Locale / Language: Locale code standards (the lower-case, two-letter language code, followed by an underscore, followed by the upper-case, two-letter territory code – i.e. fr_CA

http://www.wipo.int/standards/XMLSchema/trademarks/romarin/romarin_st66_doc/index_ISOLanguageCodeType.html

Other Standards

US State Codes: US state code standards: http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Canadian Province and Territory Codes: Canadian province and territory code standards: http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp#1380608

AVS Codes: Address Verification Response code standards: http://www.goemerchant.com/wiki/AVS%20and%20CVV2.ashx