Integration Management

Updated on June 25th, 2024

+ More

Participate in our Help Center User Experience Survey to shape its future enhancements. It's quick, under 5 minutes, and your feedback is invaluable.

Order Sources

Integration Management CSV Formats

The simple CSV file can be used when only one address and no credit card, amounts, or other special order information are needed.
The simple CSV file format is designed to be created using MS Excel.

Field	Name	Description	Req	Type	Length
1	Cust-ref	Client order number	Y	Char	16
2	Ship code	Ship code or ship method	Y	Char	30
3	Company	Company or First/Last required 1)		Char	30
4	first-name			Char	16
5	last-name			Char	20
6	address-1		Y	Char	60
7	address-2			Char	60
8	city		Y	Char	60
9	state	US state or Canadian province	Y	Char	30
10	zip	US zip or Canadian postal code	Y	Char	14
11	country	11 country 2 or 3 character ISO country code	Y	Char	3
12	phone			Char	14
13	E-mail	Used for order status notification		Char	80
14	Order-date	Order-date Order date in MM/DD/YY format		Char	10
15	Item	Product code or product alias	Y	Char	30
16	Quantity	Quantity	Y	Num	9

1) Either Company or First/Last name required but not both. Use Company if name is not split into first and last name.

2) Item and Quantity can be repeated if multiple products per order. They can be repeated either horizontal or vertical.

Sample CSV created in MS Excel and saved as MS DOS CSV format.

CSV CIODirect format - Version 5.3

Field	Name	Description	Req	Type	Length
1	Record-begin	Can be left blank	N	Char	5
2	Record-no	File record counter starting from 1	Y	Num	8
3	Version	File version - 5.2	N	Char	12
4	Format	File format	N	Char	32
5	Cust-ref	Client order number	Y	Char	16
6	Ship-code	Ship code or ship method	Y	Char	30
7	Cust-company	Company or First/Last required	Y	Char	30
8	Cust-title	Customer title		Char	30
9	Cust-first-name			Char	16
10	Cust-last-name		Y	Char	20
11	Cust-address-1		Y	Char	60
12	Cust-address-2			Char	60
13	Cust-address-3			Char	60
14	Cust-city			Char	60
15	Cust-state	US state or Canadian province	Y	Char	30
16	Cust-zip	US zip or Canadian postal code	Y	Char	14
17	Cust-country	2 or 3 character ISO country code	Y	Char	3
18	Cust-phone			Char	14
19	Cust-e-mail			Char	80
20	Ship-company	Company or First/Last required		Char	30
21	Ship-title			Char	30
22	Ship-first-name			Char	16
23	Ship-last-name		Y	Char	20
24	Ship-address-1		Y	Char	60
25	Ship-address-2			Char	60
26	Ship-address-3			Char	60
27	Ship-city		Y	Char	60
28	Ship-state	US state or Canadian province	Y	Char	30
29	Ship-zip	US zip or Canadian postal code	Y	Char	14
30	Ship-country	2 or 3 character ISO country code	Y	Char	3
31	Ship-phone			Char	14
32	Ship-email			Char	80
33	Ship-address-type	C=Commercial, R=Residential		Char	1
34	Special service	USPS special services		Char	16
35	Customer-id	Client customer id		Char	16
36	Order date	Order date in MM/DD/YY format	Y	Char	10
37	Sub-total	Summary of all extended amounts		Num	9
38	Order Discount	Order level discount amount		Num	9
39	Sales-tax	Order level sales tax		Num	9
40	Shipping/handling			Num	9
41	Grand-total	Sub-total + Sales-tax + Shipping/handling		Num	9
42	Balance	Grand-total – Order-credit		Num	9
43	Credit-card-no			Char	20
44	Expiration date	Format MMYY		Char	4
45	Pay-type	See table below. 'CA' for cash	Y	Char	2
46	Tax-exempt-sw	Y/N.Y = customer is tax exempt	Y	Char	1
47	Installment-program	Not used. Use item alias instead		Char	16
48	Key code/Offer code	Key code/Offer code		Char	16
49	Order-source	Vendor Order Source		Char	16
50	Promo-code			Char	16
51	Check-account-no			Char	17
52	Check-type	Type of account. See table below		Char	1
53	Check-no	Check number		Char	20
54	Check-bank-id	ABA/Routing number		Char	10
55	Check-cust-bank / Payment Terms	Name of bank / Payment terms for Invoices		Char	32
56	Check-cust-id-num/			Char	30
57	Check-cust-id-state			Char	2
58	Check-cust-id-mm			Char	2
59	Check-cust-id-dd			Char	2
60	Check-cust-id-yy			Char	2
61	Check-cust-id-type			Char	2
62	Location	Fulfillment location		Num	4
63	Shipping-instructions	Printed on picking document		Char	250
64	Cust-po-no			Char	30
65	Pre-auth-code	Pre-authorization code		Char	6
66	Pre-auth-amt	Pre-authorization amount		Num	9
67	Pre-auth-id	Pre-authorization transaction id		Char	30
68	CVV	CVC2, CVV2 or CID		Char	4
69	Custom-field-1	Client defined field 1		Char	40
70	Custom-field-2	Client defined field 2		Char	40
71	Custom-field-3	Client defined field 3		Char	40
72	Custom-field-4	Client defined field 4		Char	40
73	Custom-field-5	Client defined field 5		Char	40
74	ANI-phone	Customer call in phone number		Char	14
75	Vendor-Phone	Vendor called phone number		Char	14
76	Ship-carrier	3rd party shipping carrier		Char	16
77	Ship-account-no	3rd party shipping account number		Char	16
78	Item	Product code or product alias	Y	Char	30
79	Quantity	Quantity	Y	Num	9
80	Price	Unit Price		Num	9
81	Discount	Unit discount		Num	9
82	Extended-amt	(Price – Discount) * Quantity		Num	9
83	Tax	Line tax amount.		Num	9
84	Shipping-surcharge	Line shipping surcharge		Num	9
85	Line-item-id	Unique line identifier		Char	14
86	Line-comment	Line comment		Char	250
87	Record-end	Always: $END	Y	Char	4

File is in comma, double quote format.
File Header record is optional.
All fields are required as placeholders. The ‘Required’ column indicates if a value other than space is needed.
Fields 78 to 86 can be repeated for multiple items.
Field 83 – Tax should only be used if tax is calculated on the order line level.
Field 84 – Shipping surcharge should only be used if an extra order line level shipping surcharge is needed.
Ship-code is either a ship code or a ship method. The ship method can be mapped in Cart settings.

Pay type

The following pay type codes are used.

Code	Description
CA	Cash/Prepaid (Default)
CH	Check
AX	American Express
DC	Diners Club
DI	Discover Cards
MC	Master Card
VI	Visa

Check type

The following are types of checking accounts. ‘C’ is assumed if none is given.

Code	Description
C	Personal checking account
S	Personal savings account
X	Corporate checking account
Y	Corporate savings account

Multiple Products

Multiple products for one order can be defined in the file in two ways.

Horizontal

The eight fields with product information are repeated for each product. Up to 150 products for one order can be sent over this way.

Vertical

Each record is repeated. The only different fields are the record counter and the eight fields with product information. Up to 1,000 products per order can be sent this way. Please note that the Customer reference order number (field 4) MUST be the same for each record so that all records get loaded as one order

Sample CSV file

Confirmation file

Both Simple and CIODirect use the same Confirmation file format.

Field	Name	Description	Type	Length
1	cust_po_no	Client order number	Char	45
2	date	Shipment Date: YYYY-MM-DD	Char	10
3	tracking_no	Tracking Number	Char	45
4	num_packages	Currently, always 1	Int	1

Inventory file

Both Simple and CIODirect use the same Inventory file format.

Field	Name	Description	Type	Length
1	fclient_pk	Client order number	Char	45
2	date	Shipment Date: YYYY-MM-DD	Char	10
3	tracking_no	Tracking Number	Char	45

file formats csv integration