[i] Merchant allows you the ability to generate a Customer Order in an outside program (for example, taking the Order via the Internet) and then import the Order into the system. The Order will be assigned a Customer Order number, and all of the products in the Order will be carried over. However, you will still need to access the Order once it is imported and go through the titles on the Order, assigning how many copies of each title to order, or allocate, etc.
All Customer Order import files must be .xml files. And only one Order at a time can be imported.
Some information in the .xml field is mandatory, much is optional. The data is divided into header information and product information. Header information represents columns that correspond to global information within the Order. Product information represents the individual products that are placed onto the Order.
|
Note: |
Optional fields that are missing will be set to the Default values for the applicable field. Please refer to the "Notes" column in the tables below to see what the Default values are for each field. Optional fields that contain invalid data also will automatically be assigned the applicable Default value. |
Following is a list of the header fields allowed, both the required as well as the optional. Please look through the list.
Header Information Chart
|
Xml tag |
Data Type |
Required? |
Notes |
|
customer-id |
String (50) |
Required |
Must match an [i] Merchant Customer Short Name field. |
|
store-code |
String (50) |
Required |
Enter the code for the store that is taking the Order. |
|
order-type-code |
String (50) |
Optional |
[i] Merchant Customer Order Type code. Describes the Order--rush, seasonal, special handling, etc. Defaults to empty. |
|
origin |
String (50) |
Optional |
[i] Merchant Origin Code. Defines where the Order came from (Web, phone, etc.) Defaults to empty. |
|
customer-po |
String (50) |
Optional |
PO number given by the customer. Defaults to empty. |
|
charge-send |
Boolean |
Optional |
True = Ship Order to customer. False = Pick up in store. Default = False. |
|
needed-by |
String |
Optional |
When customer wants the Order. This field is informational only to [i] Merchant. Default = current date. |
|
header-note |
String (5000) |
Optional |
Free-form text about this Order. Default = Empty. |
|
total |
integer |
Required |
A control total indicating the number of product elements sent. If this does not agree with the number received, the Order is not added. |
Product Information Chart
No single product field is required, but you must have at least one product field filled in prior to the import.
|
Xml tag |
Data Type |
Required? |
Notes |
|
number |
String (20) |
Optional |
ISBN and EAN code for the product. If missing, a product number will be generated by [i] Merchant. |
|
item |
String (50) |
Optional |
Blank/null will indicate the normal item. When filled in, [i] Merchant will match to or create a line item with this code as ProductDetailCode 1 field. This should be filled in to indicate whether a bound version of the title is to be used or created. The same code should be sent for bound editions, otherwise [i] Merchant will create a third line item. |
|
description |
String (50)--Short |
Optional |
Title of book. Default = Product number. |
|
author |
String (100) |
Optional |
First name of the author. Default = Empty. |
|
author |
String (100) |
Optional |
Last name of the author. Default = Empty. |
|
price |
Decimal |
Optional |
Retail price for one item. Used as the promise price to the customer. If zero or missing, the standard Retail price on file will be used. When adding a title, this will become the Retail price. Default = Zero. |
|
qty-ordered |
Integer |
Optional |
Indicates the number of copies wanted. Default = 1 |
|
industry |
Integer |
Optional |
0 = Book |
|
product-note |
String (5000) |
Optional |
Free-form text about this Order. Default = Empty. |