FILE LAYOUTS

API Transaction Set for v.9.3

Introduction
The following describes the le format necessary for utilizing the
APIs:
File Format:
Record Format:

ASCII Sequential
Variable Length,
Field Delimited

(The UNIX pipe character | will be used to delimit elds in the

record.)
Record terminated with a Line Feed character ^J.
For further information regarding specic eld denitions and specications contact a Sigma Client Services Representative.

Copyright 2000-2006 Sigma Micro Corporation. All Rights Reserved.

08-22-06

Internet Connectivity API Transaction Set

The Controller+ Internet APIs
api api
#
name
1
Zip Code Lookup
2

Catalog RequestEdit Only

Catalog RequestEdit & Capture

Catalog RequestForce Capture

Product Narrative

Product Availability

(Customer) OrderEdit Only

7RX (Customer) OrderEdit Only with Item Pricing

Returned
8

(Customer) OrderEdit & Capture

(Customer) OrderForce Capture

10

Customer Activity Summary Inquiry

11

Customer Activity Detail Inquiry

12

Webserver Heartbeat RequestInbound

13

Webserver Heartbeat RequestOutbound

14

Product Lister

15

Customer Authentication

16

Factory Order Conrmation

17

Maintain Customer Information (Customer Update)

18

Controller+ Version/Options

19

Product Database Sync

20

Gift Certicates & Coupons

21

DemographicsDenitions

22

DemographicsInquiry

23

DemographicsUpdateEdit Only

24

DemographicsUpdateEdit & Capture

25

Advanced Personalization

26

Club Processing

++ 27
2

9.3 File Layouts

Stored Value Card Balance Inquiry

++ = New in 9.3

Internet Connectivity API Transaction Set

ZIP Code Lookup API
This transaction is to allow retrieval of City/State combinations for
any given US ZIP Code. For example, if the request was issued for
ZIP code 46259, the Controller+ would return all city/state combinations that are valid for that ZIP code: ACTON, IN and INDIANAPOLIS, IN
Each eld in request and response are separated by a UNIX pipe
symbol |.

Transaction Field Denition:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Zip Code
End of Transaction

R
R
R
R
R

4/A
20/A
2/N
9/A
5/A

Example:

Transaction Code
Transaction ID
Response Code
City, State

<EOT>

1R|123|02|46259|<EOT>

Controller+ Response
Field Description

1R

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

R
4/A
1A
R
20/A
R
3/N
(Refer to Response Codes at end of document.)
O
40 / A

If Response Code = 000, then a city/state combination will be supplied.

Multiple responses will be issued if there are more than one city/ state combinations valid for the supplied
ZIP Code.

9.3 File Layouts 3

Internet Connectivity API Transaction Set

Catalog Request Pre-Edit /Capture / Force Capture API
Functionality will exist in the Internet Commerce Application,
which will allow for the capture of customer catalog requests. After the information is captured is must be submitted to the Sigma
APIs for proper editing and host capture of information.
The available transactions for editing and capturing customer
catalog requests are:
1. Request for Pre-Edit of a Catalog Request
Catalog request information will be edited and edit
results / errors will be returned.
2. Request for Capture of a Catalog Request
Catalog request information will be edited. If edit
of information is successful, the catalog request
will be captured for processing by the host system.
If edit errors are encountered, the error
information will be returned.
3. Request for Forced Capture of a Catalog Request
ICA cannot resolve catalog request edit problems
and request a forced capture of the catalog request
be performed.

Each eld in request and response are separated by a UNIX pipe

symbol |.

9.3 File Layouts

Internet Connectivity API Transaction Set

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code

4/A

Transaction ID

20 / A

2R - (Edit Only)
3R - (Edit and Capture)
4R (Force Capture)

Refer to Format B, Import Third Party Orders chapter for further details on Remainder of
elds to supply with transaction.
End of Transaction

5/A

<EOT>

Example:
2R|123|00000000000000000000|C|02|||SIGMA/MICRO CORP.|TIMOTHY|LANIE|714|N. SENATE AVE|200||INDIANAPOLIS|IN|46202||tjlanie@sigma-micro.com|I|9710INET|N|<EOT>

Controller+ Response
Field Description
Transaction Code
Transaction ID
Response Code
Assigned Customer Number
Error Message

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

R
4/A
2A 3A 4A
R
20 / A
R
3/N
(Refer to Response Codes at end of document.)
O
9/N
O
50 / A

Examples:
2A|123|000|
<EOT>
----------------2A|123|031|First & Last Name are Required|
<EOT>
----------------3A|123|000|123456789|
<EOT>

----------------3A|123|031|Invalid Zip Code For State Specied|

<EOT>
-------------------4A|123|000|123456789|
<EOT>

9.3 File Layouts 5

Internet Connectivity API Transaction Set

Product Narrative API

The Controller+ on the host system maintains narrative
information about each product in the system. Functionality should exist in the Internet Commerce Application,
which will allow for the retrieval of this information from
The Controller+ on the host system.
The following transaction is to be used for requesting
product narrative information.
Each eld in request and response are separated by a
UNIX pipe symbol |.

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Product Number
Narrative Page Number
End of Transaction

R
R
R
R
R
R

4/A
20 / A
2/N
20 / A
1/A
5/A

5R

<EOT>

The Controller+ supports 3 pages of narrative information.

Supply a number between 1 and 3 to indicate which page of narrative is desired.
Example:

9.3 File Layouts

5R|123|02|100|1|<EOT>

Internet Connectivity API Transaction Set

Controller+ Response
Field Description
Transaction Code
Transaction ID
Response Code
Narrative Text

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

R
4/A
5A
R
20 / A
R
3/N
(Refer to Response Codes at end of document.)
O
1580 / A

Examples:
5A|123|000|This item is made in Japan. . . . . . . . >|
<EOT>
--------------------5A|123|135|
<EOT>

9.3 File Layouts 7

Internet Connectivity API Transaction Set

Product Availability API

Controller+ on the host system maintains total product
availability information about each product in the system. Functionality should exist in the Internet Commerce Application, which will allow for the retrieval of
this information from Controller+ on the host system.
The following transaction is to be used for requesting
product availability information.
Each eld in request and response are separated by a
UNIX pipe symbol |.

Transaction Field Denitions:

ICA Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Product Number
Order Quantity

R
R
R
R
R

4/A
20 / A
2/N
20 / A
8/N

Source Code

8/A

Ship To State
Ship To ZIP

O
O

3/A
9/A

Customer Number

9/N

Ship Method

1/A

9.3 File Layouts

6R

If item can be sold in

fractional units, then the
quantity # can be submitted
as: 9999.999; otherwise,
submit quantity as a whole
number: 9999.
Required for determining
proper pricing of product.
Above two elds needed
to compute availability and
restricted selling regulations.
If supplied, will perform
Customer-specic pricing.
If supplied, will perform
Shipment Restriction Logic

Internet Connectivity API Transaction Set

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Response Type

1/A

End of Transaction

5/A

D for Detail Response

Requested; S for Summary
Response Requested; C for
Style Master Response
Requested (sends back all
style items); M for Multiple
Response Requested (up to
49 products to follow); If no
response type supplied, will
default to D.
Division
O
1/A
Customers division for this
order. This eld may be used
to override the customers
normal division. If pricing
is based off of divisions, this
will have an impact.
******Note, for an M response request ONLY the following two elds may be
repeated up to a max 49 times delimited by tab.
<TAB>
R
1/A
TAB (^ I or HEX 09) Note:
the <TAB> is the delimiter;
the <TAB> itself is not
delimited by a pipe (|).
Product Number
O
20 / A
Order Qty
O
9999.999
<EOT>

Examples:
6R|123|02|100|00002|1997INO|IN|46202|123456789|3|S|<EOT>
6R|123|02|100|00002|1997INO|IN|46202|123456789|3|M|<TAB>200|1|<TAB>300|1|<EOT>

Controller+ Response Format

******Note, the response provided will depend on the Response Type
specied with the original request.
If a Response Type of S (Summary) is requested, the following response will be returned.

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

6A
(Refer to Response Codes at
end of document.)
9.3 File Layouts 9

Internet Connectivity API Transaction Set

Response Type S (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Expected Date

8/A

10

9.3 File Layouts

(MM/DD/YY)
Potential response values:
SpacesIndicates requested
quantity of product is available in stock.
Date (MM/DD/YY)Indicates
product is out of stock.
Requested quantity will be
available from purchase
order expected to be
received in warehouse on
date returned. OK to place
order; order will be put on
Backorder.
UNKNOWNIndicates
product is out of stock.
Requested quantity will
not become available
from expected purchase
order receipt. OK to place
order; order will be put on
Backorder.
(NO BO)Indicates product
is out of stock and no back
orders are being accepted.
Item has been agged as
Back Orders Are Not Permitted, (NO BO). Do NOT
order; if attempt to order,
item will be cancelled immediately.
(NLA)Indicates product is
out of stock. Item status
has been agged as No
Longer Available, (NLA).
Do NOT order; if attempt
to order, item will be cancelled immediately.

Internet Connectivity API Transaction Set

Response Type S (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Quantity Available
Price

R
R

9/N
7/N

Kit Flag

1/A

Truck Ship Flag

1/A

Drop Ship Flag

1/A

Special Order Flag

Gift Certicate Flag

1/A

Club Flag

1/A

Sales Restriction Flag

1/A

Shipment Restriction Flag

1/A

Up-Sell Available Flag

1/A

No Decimal Positions
(Assume 2 decimal positions)
Customer Specic Unit Price
if customer number supplied.
Source Code specic price if
source code provided.
Otherwise, default retail/
quantity break price from
product database.
(Y) if item is a Kit, (F) if item
is a Kit with selections OR if
Kit has Style Master Item, (N/
blank) if not a Kit.
(Y) if item requires shipment
by truck, (N/blank) if truck
shipment is not required.
(Y) if item will be shipped
directly from supplier, (N/
blank) if not drop shipped.
(Y) if item requires special
ordering, (N/blank) if special
ordering not required.
(F) if item is a xed value gift
certicate, (V) if item is a
variable value gift certicate,
(N/blank) if item is not a gift
certicate.
(Y) if item is a Club Membership, (N/blank) if item is not a
Club Membership.
(Y) if item has encountered a
Sales Restriction situation
with the supplied Ship-To
State and ZIP, (N/blank) if no
Shipment Restriction
encountered.
(Y) if item has encountered a
Shipment Restriction situation
with the supplied Ship
Method, (N/blank) if no
Shipment Restriction
encountered.
(Y) if item has an Up-Sell
offer available, (N/blank) if
not.

9.3 File Layouts 11

Internet Connectivity API Transaction Set

Response Type S (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Cross-Sell Available Flag

1/A

Substitute-Sell Available Flag

1/A

Promotion-Sell Available Flag

1/A

Easy Pay Payments

2/N

Misc. Charge Description

10 / A

Misc. Charge Amount

5/N

Additional Information Flag

1/A

Status

1/A

Price 1
Price 1 Quantity Break 1
Price 2
Price 2 Quantity Break 2
Price 3
Price 3 Quantity Break 3
Price 4
Price 4 Quantity Break 4

R
R
R
R
R
R
R
R

7/N
5/N
7/N
5/N
7/N
5/N
7/N
5/N

12

9.3 File Layouts

(Y) if item has an Cross-Sell

offer available, (N?blank) if
not.
(Y) if item has a SubstituteSell offer available, (N/blank)
if not.
(Y) if item has a PromotionSell offer available, (N/blank)
if not.
(00 - 01) if Easy Pay not
available. (02-99) identies
maximum number of allowed
monthly installments.
(Example: A value of 4 would
represent 1 down payment at
time of shipment and 3
monthly installments.)
(blank) if item does not have
an associated miscellaneous
charge, otherwise contents
are a description of the
miscellaneous charge amount
below.
(Assume 2 decimal positions)
(Zeroes) if item does not have
an associated miscellaneous
charge, otherwise the charge
amount corresponding to the
description above.
(Y) if item requires additional
information to be supplied
(Personalization/Engraving),
(N/blank) if no additional
information required.
(A) Active, (I) Inactive,
(P) Presale, (D) Do Not
Backorder, (N) NLA
(Assume 2 decimal positions)
(Assume 2 decimal positions)
(Assume 2 decimal positions)
(Assume 2 decimal positions)

Internet Connectivity API Transaction Set

Response Type S (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Price 5
Price 5 Quantity Break 5
Fractional Units Allowed

R
R
O

7/N
5/N
1/A

Selling Unit of Measure

Special Price Code
Price

O
R

2/A
1/A

Seasonal Order Begin Date

Seasonal Order End Date
Seasonal Ship Begin Date
Seasonal Ship End Date
Do Not Sell Before Date
Do Not Ship Before Date
Personalization Template #
Markup
Price Code
Number of default line
item services
Number of optional line
item services
Dropship Indicator

O
O
O
O
O
O
O
R
R
R

6/N
6/N
6/N
6/N
6/N
6/N
7/N
0.9991/A
7/N

7/N

1/A

Force Narrative
Max Order Quantity
Collect Up Front

R
R
R

1/A
9(4).999
1/A

Product Allow COD Indicator

1/A

1/A

1/A

++ Stored Value Card Indicator

<TAB>

(Assume 2 decimal positions)

(Y) If item can be purchased
in fractional units.
Blank = Customer Normal
Q = Quantity Price
D = Special of the Day Price
C = Club Price
S = Sale Price
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
Default price markup
Default price code

(R)equired
(O)pen
(N)o
(Y) If funds are required in
advance.
(Y)es
(N)o
(W)arn
(N)o
(F)ixed
(V)ariable
(R)eload
^ I

Controller+ Response Format

******Note, the response provided will depend on the Response Type
specied with the original request.
If a Response Type of Detail (D) or default (spaces) is requested, the following response will
be returned. The rst segment of this Detail response will be the same as the Summary response
shown above, with a <TAB> delimiter. The second segment of the response will be the same as
the Product Database Export Extract record format.

++ = New in 9.3

9.3 File Layouts 13

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Expected Date

8/A

Quantity Available

9/N

14

9.3 File Layouts

6A
(Refer to Response Codes at
end of document.)
(MM/DD/YY)
Potential response values:
SpacesIndicates requested
quantity of product is available in stock.
Date (MM/DD/YY)Indicates
product is out of stock.
Requested quantity will be
available from purchase
order expected to be
received in warehouse on
date returned. OK to place
order; order will be put on
Backorder.
Expected date possible
values are:
UNKNOWNIndicates
product is out of stock.
Requested quantity will
not become available
from expected purchase
order receipt. OK to place
order; order will be put on
Backorder.
(NO BO)Indicates product
is out of stock and no back
orders are being accepted.
Item has been agged as
Back Orders Are Not Permitted, (NO BO). Do NOT
order; if attempt to order,
item will be cancelled immediately.
(NLA)Indicates product is
out of stock. Item status
has been agged as No
Longer Available, (NLA).
Do NOT order; if attempt
to order, item will be cancelled immediately.
No Decimal Positions

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Price

7/N

Kit Flag

1/A

Truck Ship Flag

1/A

Drop Ship Flag

1/A

Special Order Flag

Gift Certicate Flag

1/A

Club Flag

1/A

Sales Restriction Flag

1/A

Shipment Restriction Flag

1/A

Up-Sell Available Flag

1/A

Cross-Sell Available Flag

1/A

(Assume 2 decimal positions)

Customer Specic Unit Price
if customer number supplied.
Source Code specic price if
source code provided.
Otherwise, default retail/
quantity break price from
product database.
(Y) if item is a Kit, (F) if item
is a Kit with selections OR if
Kit has Style Master Item, (N/
blank) if not a Kit.
(Y) if item requires shipment
by truck, (N/blank) if truck
shipment is not required.
(Y) if item will be shipped
directly from supplier, (N/
blank) if not drop shipped.
(Y) if item requires special
ordering, (N/blank) if special
ordering not required.
(F) if item is a xed value gift
certicate, (V) if item is a
variable value gift certicate,
(N/blank) if item is not a gift
certicate.
(Y) if item is a Club Membership, (N/blank) if item is not a
Club Membership.
(Y) if item has encountered a
Sales Restriction situation
with the supplied Ship-To
State and ZIP, (N/blank) if no
Shipment Restriction
encountered.
(Y) if item has encountered a
Shipment Restriction situation
with the supplied Ship
Method, (N/blank) if no
Shipment Restriction
encountered.
(Y) if item has an Up-Sell
offer available, (N/blank) if
not.
(Y) if item has an Cross-Sell
offer available, (N?blank) if
not.
9.3 File Layouts 15

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Substitute-Sell Available Flag

1/A

Promotion-Sell Available Flag

1/A

Easy Pay Payments

2/N

Misc. Charge Description

10 / A

Misc. Charge Amount

5/N

Additional Information Flag

1/A

Status

1/A

Price 1
R
Price 1 Quantity Break 1
R
Price 2
R
Price 2 Quantity Break 2
R
Price 3
R
Price 3 Quantity Break 3
R
**If using Style/Color/Size numbering:
Style= X
(8)
Filler= X
(1)
Color= X
(5)
Filler= X
(1)
Size= X
(5)
16

9.3 File Layouts

7/N
5/N
7/N
5/N
7/N
5/N

(Y) if item has a SubstituteSell offer available, (N/blank)

if not.
(Y) if item has a PromotionSell offer available, (N/blank)
if not.
(00 - 01) if Easy Pay not
available. (02-99) identies
maximum number of allowed
monthly installments.
(Example: A value of 4 would
represent 1 down payment at
time of shipment and 3
monthly installments.)
(blank) if item does not have
an associated miscellaneous
charge, otherwise contents
are a description of the
miscellaneous charge amount
below.
(Assume 2 decimal positions)
(Zeroes) if item does not have
an associated miscellaneous
charge, otherwise the charge
amount corresponding to the
description above.
(Y) if item requires additional
information to be supplied
(Personalization/Engraving),
(N/blank) if no additional
information required.
(A) Active, (I) Inactive,
(P) Presale, (D) Do Not
Backorder, (N) NLA
(Assume 2 decimal positions)
(Assume 2 decimal positions)
(Assume 2 decimal positions)

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Price 4

7/N

Price 4 Quantity Break 4

Price 5

R
R

5/N
7/N

Price 5 Quantity Break 5

Fractional Units Allowed

R
O

5/N
1/A

Selling Unit of Measure

Special Price Code

O
R

2/A
1/A

Seasonal Order Begin Date

Seasonal Order End Date
Seasonal Ship Begin Date
Seasonal Ship End Date
Do Not Sell Before Date
Do Not Ship Before Date
Personalization Template #
Markup
Price Code
Number of default line
item services
Number of optional line
item services
Dropship Indicator

O
O
O
O
O
O
O
R
R
R

6/N
6/N
6/N
6/N
6/N
6/N
7/N
0.9991/A
7/N

7/N

1/A

Force Narrative
Max Order Quantity
Collect Up Front

R
R
R

1/A
9(4).999
1/A

Product Allow COD Indicator

1/A

1/A

1/A

++ Stored Value Card Indicator

<TAB>

(Assume 2 decimal
positions)
(Assume 2 decimal
positions)
(Y) If item can be
purchased in
fractional units.
Blank = Customer
Normal Price
Q = Quantity Price
D = Special of the
Day Price
C = Club Price
S = Sale Price
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
(MMDDYY)
Default price markup
Default price code

(R)equired
(O)pen
(N)o
(Y) If funds are required in
advance.
(Y)es
(N)o
(W)arn
(N)o
(F)ixed
(V)ariable
(R)eload
^ |

*Override from Catalogs Item Denition

++ = New in 9.3

9.3 File Layouts 17

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

PRODUCT NUMBER
PRODUCT DESCRIPTION
ITEM REFERENCE

20
30
1

A
A
A

PRODUCT LINE
PAGE NUMBER
CATALOG PAGE
GROUP CODE

4
3

A
N

STATUS

PRICE 1

PRICE 1 QTY BREAK 1

PRICE 2

5
7

N
N

PRICE 2 QTY BREAK 2

PRICE 3

5
7

N
N

PRICE 3 QTY BREAK 3

PRICE 4

5
7

N
N

PRICE 4 QTY BREAK 4

PRICE 5

5
7

N
N2

*Override from Catalogs Item Denition

**If using Style/Color/Size numbering:
Style= X
(8)
Filler= X
(1)
Color= X
(5)
Filler= X
(1)
Size= X
(5)
18

9.3 File Layouts

**
Space = Standard
I = Style Item*
K = Kit
M = Style Master
*
Catalogs Item
Denition Page
Group Code
A = Active
I = Inactive
P = Presale
D = Do Not Backorder
N = NLA
2*
Implied Decimal
(99999v99)
*
2*
Implied Decimal
(99999v99)
*
2*
Implied Decimal
(99999v99)
*
2*
Implied Decimal
(99999v99)
*
*

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description

PRICE 5 QTY BREAK 5

KEY SEARCH WORD
KEY SEARCH WORD
KEY SEARCH WORD
KEY SEARCH WORD
KEY SEARCH WORD
QUANTITY AVAILABLE
EASY PAYMENTS
UNIT SHIP CHARGE
ADDITIONAL INFO
REQUEST MSG
MISC CHARGE
AMOUNT
MISC CHRG
DESCRIPTION
SUBSTITUTE PRODUCT
NUMBER 1
SUBSTITUTE PRODUCT
NUMBER 2
SUBSTITUTE PRODUCT
NUMBER 3
SUBSTITUTE PRODUCT
NUMBER 4
SUBSTITUTE PRODUCT
NUMBER 5
SUBSTITUTE PRODUCT
NUMBER 6

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

5
10
10
10
10
10
13
3
5

N
A
A
A
A
A
N4
N
N2

30

N2

10

20

20

20

20

20

20

Implied Decimal
(99999v99)
*

9(9)v9999
*
Implied Decimal
(999v99)

Implied Decimal
(999v99)

**
**
**
**
**
**

**If using Style/Color/Size numbering:

Style= X
(8)
Filler= X
(1)
Color= X
(5)
Filler= X
(1)
Size= X
(5)
9.3 File Layouts 19

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description
SUBSTITUTE PRODUCT
NUMBER 7
SUBSTITUTE PRODUCT
NUMBER 8
SUBSTITUTE PRODUCT
NUMBER 9
SUBSTITUTE PRODUCT
NUMBER 10
UPSELL PRODUCT
NUMBER 1
UPSELL PRODUCT
NUMBER 2
UPSELL PRODUCT
NUMBER 3
UPSELL PRODUCT
NUMBER 4
UPSELL PRODUCT
NUMBER 5
UPSELL PRODUCT
NUMBER 6
UPSELL PRODUCT
NUMBER 7
UPSELL PRODUCT
NUMBER 8
UPSELL PRODUCT
NUMBER 9
UPSELL PRODUCT
NUMBER 10
CROSS SELL PRODUCT
NUMBER 1
CROSS SELL PRODUCT
NUMBER 2
CROSS SELL PRODUCT
NUMBER 3

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

20

20

20

20

20

20

20

20

20

20

20

20

20

20

20

20

20

**If using Style/Color/Size numbering:

Style= X
(8)
Filler= X
(1)
Color= X
(5)
Filler= X
(1)
Size= X
(5)
20

9.3 File Layouts

**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**

Internet Connectivity API Transaction Set

Response Type D (continued):

Field Description
CROSS SELL PRODUCT
NUMBER 4
CROSS SELL PRODUCT
NUMBER 5
CROSS SELL PRODUCT
NUMBER 6
CROSS SELL PRODUCT
NUMBER 7
CROSS SELL PRODUCT
NUMBER 8
CROSS SELL PRODUCT
NUMBER 9
CROSS SELL PRODUCT
NUMBER 10
SHIP RESTRICTION #1
SHIP RESTRICTION #2
SHIP RESTRICTION #3
PERSONALIZATION
TEMPLATE #
RESERVE 1
RESERVE 2
RESERVE 3
RESERVE 4
RESERVE 5
RESERVE 6
RESERVE 7
RESERVE 11
RESERVE 12
RESERVE 13
RESERVE 14
RESERVE 15
RESERVE 16
RESERVE 17
RESERVE 18
RESERVE 19

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

20

20

20

20

20

20

20
1
1
1
7

A
A
A
A
N

1
1

A
A

1
1
1
1
1
1
1
1
1
1
1
1
1
1

A
A
A
A
A
A
A
A
A
A
A
A
A
A

**
**
**
**
**
**
**

9.3 File Layouts 21

Internet Connectivity API Transaction Set

Controller+ Response Format

******Note, the response provided will depend on the Response Type
specied with the original request.
If a Response Type of Style (C) or Multiple (M) is requested, the following response will be
returned.
Field Format
(R)equired/
Max Size / Format
Field Description
(O)ptional
Alphanumeric / Numeric
Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

6A

******Note, for a response to an M (multiple products) request ONLY, all of the following
elds may be repeated up to a max 49 times delimited by tab. For a response to a C
(style master/items) request ONLY, all of the following elds will be repeated for each
style option.

22

<TAB>
Response Code

R
R

1/A
3/N

Product Number
Expected Date

R
O

20 / A
8/A

Quantity Available
Price
Kit Flag

R
R
O

9/N
7/N
1/A

Gift Certicate Flag

1/A

Upsell Available Flag

1/A

Cross Sell Available Flag

1/A

Substitute Sell Available Flag

1/A

9.3 File Layouts

^ I
If no errors occur, this will
always be returned as 0
(zero). If an error occurs, an
error message will be
returned but no other
information will be returned
beyond this point.
(Refer to comments/
description under Response
Type D.)
(Y) if item is a Kit,
(N/blank) if not a Kit.
(F) if item is a xed value
gift certicate, (V) if item
is a variable value gift
certicate, (N/blank) if item
is not a gift certicate.
(Y) if item has an Upsell
offer available, (N/blank) if
no offer available.
(Y) if item has an Cross
Sell offer available, (N/blank)
if no offer available.
(Y) if item has a Substitute
Sell offer available, (N/
blank) if no offer available.

Internet Connectivity API Transaction Set

Response Type C or Response Type M (continued):

Field Format
Max Size / Format
Alphanumeric / Numeric
1/A
(Y) if item has a Promotion
Sell offer available, (N/
blank) if no offer available.
2/N
(00 - 01) if Easy Pay not
available. (02-99)
identies maximum
number of allowed
monthly installments.
(Example: A value of 4 would
represent 1 down payment at
time of shipment and 3
monthly installments.)
1/A
(Y) if item has an
associated miscellaneous
charge, (blank) if item does
not have additional charge.
1/A
(Y) if item requires additional
information to be supplied
(Personalization/Engraving),
(N/blank) if no additional
information required.
1/A
(A) Active, (I) Inactive,
(P) Presale, (D) Do Not
Backorder, (N) NLA
1/A
(Y) If item has quantity break
pricing. (N) If item does not
have quantity break pricing.
1/A
(Y) If item can be purchased
in fractional units.
2/A
1/A
Blank = Customer Normal

Field Description
Promotion Sell Available Flag

(R)equired/
(O)ptional
O

Easy Pay Payments

Misc. Charge Flag

Additional Information Flag

Status

Quantity Break Flag

Fractional Units Allowed

Selling Unit of Measure

Special Price Code
Price

O
R

Special Order Item

1/A

Club Item

1/A

Markup
Price Code
Number of default line
item services
Number of optional line
item services

R
R
R

.9991/A
7/N

7/N

Q = Quantity Price
D = Special of the Day Price
C = Club Price
S = Sale Price
(Y) If item is a special order
item. (N) If item is not a
special order item.
(Y) If item is a club
membership. (N) If item is not
a club membership.
Default Price Markup
Default Price Code

9.3 File Layouts 23

Internet Connectivity API Transaction Set

Response Type C or Response Type M (continued):

Field Format
Max Size / Format
Alphanumeric / Numeric

Field Description

(R)equired/
(O)ptional

Maximum Order Quantity

Dropship Indicator

R
R

9(4).999
1/A

++ Stored Value Card Indicator

1/A

5/A

End of Transaction
<EOT>

(R)equired
(O)ptional
(N)o
(N)o
(F)ixed
(V)ariable
(R)eload

Customer Order Pre-Edit /Capture / Force Capture API

Functionality will exist in the Internet Commerce Application (ICA), which will allow for the capture of customer
orders. After the order information is captured it must
be submitted to the Sigma APIs for proper editing and
host capture.
The available transactions for editing and capturing
customer orders are:
1. Request for Pre-Edit of a Customer Order
Customer order information will be edited and edit
results / errors will be returned. If the editing of
the order is successful, proper tax and shipping
charges will be calculated and returned.
2. Request for Capture of a Customer Order
Customer Order information will be edited as
described above. If edit of information is
successful, the order will be captured for
processing by the host system. If edit errors are
encountered, the error information will be
returned.
3. Request for Forced Capture of a Customer Order
ICA cannot resolve order edit problems and request
a forced capture of the order be performed.
Each eld in request and response are separated by a
UNIX pipe symbol |.

24

9.3 File Layouts

++ = New in 9.3

Internet Connectivity API Transaction Set

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code

4/A

Transaction ID

20 / A

7R - (Edit Only)
7RX - (Edit Only with
Item Pricing returned)
8R - (Edit and Capture)
9R (Force Capture)

Refer to Format B, Import Third Party Orders chapter for further details on remainder of
elds to supply with transaction.
End of Transaction

5/A

<EOT>

Example:
7R|123|00000000000000000000|O|02|||SIGMA/MICRO CORP.|TIMOTHY|LANIE|
714|N. SENATE AVE|200||INDIANAPOLIS|IN|46202||
tjlanie@sigma-micro.com|I|9710INET|N|Y||AMOUS|LANIE|1115|S.MCDONALD||
ATTICA|IN|47918|. . . . . . . . . . . . . . . >|<EOT>
Controller+ Response
(R)equired/
Field Description

Field Format
Max Size / Format
(O)ptional
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

Error Message
Error Line
Default Shipping Information
Shipping Method
Shipping Charge
Tax Charge
Alternative Shipping Information
Shipping Method
Shipping Method Description
Shipping Charge
Tax Charge
Assigned Customer Number
Assigned Order Number

O
O
R
R
R
R
O
R
R
R
R
O
O

4/A
7A 8A 9A
20 / A
3/N
(Refer to Response Codes at
end of document.)
200 / A
3/N
Applies to Line Item.
1/A
11 / N
11 / N

11 / N
11 / N
9/N
9/N

(Assume 2 decimal positions)

(Assume 2 decimal positions)
(Occurs 15 times)
1/A
15 / A
(Assume 2 decimal positions)
(Assume 2 decimal positions)

9.3 File Layouts 25

Internet Connectivity API Transaction Set

Special of the Day Flag

1/A

Y = Specials of the Day Available,

N/blank = Not Available
Y = Free Items Selection Available,
N/blank = Not Available
(Assume 2 decimal positions)
This is the total extended
price of the items on the
order *before* order discount is applied.
(Assume 2 decimal positions)
(Assume 2 decimal positions)
(Assume 2 decimal positions)

Free Items Flag

1/A

Order Net Amount

11 / N

Order Discount Amount

Applied Coupon Amount
Applied Gift Certicate Amount

O
O
O

11 / N
11 / N
11 / N

(R)equired/
Field Description

Field Format
Max Size / Format
(O)ptional
Alphanumeric / Numeric

Charge Card Authorization

Information

180 / A

This eld is made up of 11 comma delimited sub-elds for passing Charge Card or Bill Me Later++
Authorization/Decline information from the Controller+. Use of these elds will be
for performing *online* charge card authorizations. Each eld is followed with a
comma. e.g. |AUTH, ,091801,22500,1, , , , , | Sub-eld information is dened below:
FIELD CONTENTS

MAX LENGTH

TYPE

COMMENTS

Authorization Code
20
A
Decline Code
20
A
Authorization Date
6
N
MMDDYY
Authorization Amount
11
N
9 (9) V99
Authorization Attempts
3
N
Reserved
11
A
Reserved
1
A
Error Code
2
N
Reserved
1
A
++Address Verication
Error
4
A
++ CVV Response Code
1
A
40
A
++ XID Code
++ Cardholder Authentication
Verication Value (CAVV)
40
A
Future Use
6
A
If the WEBSITE is performing the online authorization function
The data supplied in the request will be duplicated in the
response for acknowledgement purposes.
If the Controller+ is performing the online authorization function
The data supplied will be the results of an authorization attempt. The sub-eld
Authorization Attempts will always be 1 (one). It is the responsibility of the
WEBSITE to keep track of the number of attempts. Please note that online
authorizations will only be performed by the Controller+ for 8R transactions.
Contact a Sigma Micro customer service representative for assistance
before attempting to use the online authorization function.

++ = New in 9.3
26

9.3 File Layouts

Internet Connectivity API Transaction Set

Club Savings
O
11 / N
Club Points Earned
O
9/N
Reserved Field 1
R
1/A
++ Applied Stored Value
Card Amount
O
11/N
The following elds are used ONLY for a 7RX transaction,
and are repeated for each product on the order
<TAB>
R
1/A
Product Number
R
20 / A
Price
R
7/N
Expected Date
O
8/A
++ Line Item Service Charge
O
5/N

Implied 2 decimals

Implied 2 decimals

Implied 2 decimals
Implied 2 decimals

Examples:
7A|123|000|||3|550|1320|. . . . . . . . . . . >|
<EOT>
---------------7A|123|031|First & Last Name are Required||3|550|1320|.......>
<EOT>

Customer Activity Summary Inquiry API

Functionality should exist in the Internet Commerce Application to accommodate presentation of current status on customer orders and returns. This API transaction will be used when
a summary listing of all customer activity is requested.
To retrieve a listing of a customers activity, the request will
need to supply the corresponding customer number OR the
activity type and number of any past activity.
The Activity Number could be an Order Number, Invoice Number, or Return Number. The information supplied
must be correct in order to obtain access to the desired information.
Each eld in request and response are separated by a UNIX
pipe symbol |.

++ = New in 9.3

9.3 File Layouts 27

Internet Connectivity API Transaction Set

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Customer Number*
Customer Password
Activity Number Type*

R
R
R
R
O
R

4/A
20 / A
2/N
9/N
10 / A
1/A

Activity Number*
Return Data Types

R
O

9/N
1/A

Number of Transactions to Return

3/N

End of Transaction

5/A

10R

(Not used)
O - Order
I - Invoice#
R - Return#

R - Returns only
O - Orders only
Blank or B - Both
All open transactions
will be returned
<EOT>

Example:
10R|123|02|123456789||O|987654321|<EOT>
*Either the Customer Number OR the Activity Number Type is required, along with the Activity Number.
Controller+ Response
Field Description
Transaction Code
Transaction ID
Response Code

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

R
4/A
10A
R
20 / A
R
3/N
(Refer to Response Codes at end of document.)
Response Sequence Code
R
2/N
00 - Customer ID
01 - Activity Summary
Customer Identication Response
Customer Number
R
9/N
Customer Password
R
10 / A
Customer Name
R
30 / A
Mailing Address Line 1
R
30 / A
Mailing Address Line 2
R
30 / A
Mailing City
R
25 / A
Mailing State
R
3/A
Mailing Zip
R
9/A
Mailing Country
R
25 / A
Phone Number 1
O
20 / A
28

9.3 File Layouts

Internet Connectivity API Transaction Set

Customer Identication Response (continued)

Phone Number 2
O
20 / A
Email Address
O
50 / A
Fax Number
O
20 / A
Activity Summary Response
Activity Type
R
1/A
O - Order Number
R - Return Number
Activity Number
R
9/N
Activity Entry Date
R
8/A
(MM/DD/YY)
Current Status
R
1/A
If Order:
1 - Un-shipped
2 - In Process
3 - Closed
If Return: 1 - In Process
3 - Closed
Purchase Order Number
O
20 / A
First Item On Activity
Product Number
R
20 / A
Description
R
30 / A
Secondary Current Status
R
1/A
If Primary Status = Unshipped:
(If Order)
1 = Waiting on Approval
2 = All Backordered
If Primary Status = In Process:
1 = Being Processed by Warehouse
2 = Released to Ship
Please Note: Secondary status
3 = B/O Being Processed by WH
codes (for orders that are In Pro4 = B/O Released to Ship
cess) are grouped as such:
5 = All Currently B/O
6 = Being Processed by WH/
1st Shipment: 1,2,6,7
Balance on B/O
7 = Released to Ship/ Balance on B/O
Subsequent Shipments: 3,4,8,9
8 = B/O Being Processed by WH/
No Items on B/O: 1,2,3,4
Balance Still on B/O
Items on B/O: 6,7,8,9
9 = B/O Released to Ship/
Balance Still on B/O
If Primary Status = Closed:
1 = Fully Shipped
2 = Partially Canceled
3 = Fully Canceled
If Return: Blank.

9.3 File Layouts 29

Internet Connectivity API Transaction Set

Example:
10R|123|000|00|123456789|tjlanie|Lanie,Timothy J.|714 N. Senate Ave. #200||
Indianapolis|IN|46202||
10R|123|000|01|R|5678|05/28/97|3||100|Swiss Army Knife|
10R|123|000|01|O|3897654|02/15/97|3|TJ123|100|Swiss Army Knife|
<EOT>
Multiple Controller+ Activity Summary Responses will be issued if there is more
than one activity on the system for the designated customer. The activity will be presented in reverse chronological order.

Here the identied customer has two activity responses.

The rst response identies a merchandise return. The
second response identies an order from which the return
probably originated.

Customer Activity Detail Inquiry API

Again, functionality should exist in the Internet Commerce Application to accommodate presentation of current status on
customer orders and returns. The previous API transaction would
be used to obtain a summary listing of all customer activity. This
request will be used when a detail listing of a specic activity is
requested. Normally this request would follow the above Activity
Summary Request after the customer selected which activity more
detail is desired.
The Activity Number could be an Order Number or Return Number. The information supplied must be correct in order to obtain
access to the desired information.
Each eld in request and response are separated by a UNIX pipe
symbol |.

30

9.3 File Layouts

Internet Connectivity API Transaction Set

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Customer Number
Customer Password
Activity Number Type

R
R
R
R
O
R

4/A
20 / A
2/N
9/N
10 / A
1/A

Activity Number
End of Transaction

R
R

9/N
5/A

11R

(Not used)
O - Order Number
R - Return Number
<EOT>

Example:
11R|123|02|123456789||O|987654321|<EOT>
The response to the request will not be in the form of a
transaction. The response will be in the format of narrative text lines. The intent is for the Controller+ system to
format a document that can accurately depict the processing to-date that has occurred on the requested activity. Intermixed in the response will be shipped package
information along with tracking numbers. These lines
will be specially identied so that the ICA could retrieve
current shipping status information off the Internet from
the various shippers.

9.3 File Layouts 31

Internet Connectivity API Transaction Set

Controller+ Response
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
4/A
11A
R
20 / A
R
3/N
(Refer to Response Codes at end of document.)
Response Line Indicator
R
2/N
00 - 90 Narrative Text Line
50 - Line Item Detail
(included in Narrative text)
91 - Package Detail Line
Narrative Text Line Text
R
80 / A
Package Detail Line
(Special Note: The elds in this line will be xed length and will not be terminated
with eld delimiters.)
Line ID
Spaces
Shipment Reference Number
Spaces
Invoice Number
Spaces
Shipped Date
Spaces
Shipping Method
Spaces
Tracking Number
Spaces
Ship-to Legend Number

R
R
O
R
O
R
O
R
R
R
R
R
R

3/A
2
4/N
3
9/N
1
10 / A
1
20 / A
1
30 / A

91|

MM/DD/YYYY
*

3/N

Note: The end of this response would be terminated with an End of Transaction (<EOT>) notation.
* Shipping Methods: These are the predened shipping methods in the Controller+. Other ship
methods are customer-dened and are not listed here.
1 - Air
2 - Truck
3 - UPS Ground
4 - UPS Next Day
5 - UPS Second Day
6 - UPS 3-Day Select
7 - USPS 1st Priority
8 - USPS Standard B
9 - USPS Express
E - Fed Ex Economy

32

9.3 File Layouts

P - Fed Ex Priority
S - Fed Ex Standard
A - Airborne Express
B - Airborne SDS
C - Airborne NAS
D - CTC/USPS Standard B

Internet Connectivity API Transaction Set

The following is an example of the non-parsed response to the request. On the

next page is a sample of how a parsed response will display in the Controller+.
Our intent is to provide a display, prefaced with the number of each line, so
that if users choose to make changes to the eld display, they may do so. However, it should be noted that these line numbers may change in future versions
of the API, so corresponding changes to the eld displays will not necessarily
translate to the new version.
Request Response
11A|30761|000|01|Customer Number: 45 / SMITH KEVIN
|11A|30761|000|02| Order Status: CLOSED - ORDER FULLY SHIPPED
|11A|30761|000|00| |11A|30761|000|00| Bill To Address
|11A|30761|000|10| TEST CONTACT NAME |11A|30761|000|11|
KEVIN
SMITH |11A|30761|000|12| 1111 MERRY WAY |11A|30761|000|15| WALNUT
CREEK CA 94595 |11A|30761|000|00|
|11A|30761|000|30|Order
Number: 1006357 Order Date: 11/10/1999 Order Time: 13:37:01
|11A|30761|000|00| |11A|30761|000|00| SHIP TO
SHIPPED
|11A|30761|000|00|PRODUCT NUMBER/ (SEE ORDERED TO-DATE UNIT
|11A|30761|000|00| DESCRIPTION BELOW)
QUANTITY QUANTITY
PRICE CURRENT STATUS |11A|30761|000|00| |11A|30761|000|50|0041
1 1 1 95.00 SHIPPED |11A|30761|000|51|
TEST PART TO GO INTO
ASSEMBLY |11A|30761|000|00| |11A|30761|000|00| CHARGES |11A|30761|000|60|
Merchandise Total : 95.00
|11A|30761|000|61| Discount Applied : 5.00- |11A|30761|000|62|
Applicable Tax : 7.76 |11A|30761|000|63| Shipping /
Handling
: 4.00 |11A|30761|000|00| |11A|30761|000|69| Total Order
Charges : 101.76 |11A|30761|000|00| |11A|30761|000|78|
REMAINING BALANCE : 101.76 2% 10 / NET 90 |11A|30761|000|00|
|11A|30761|000|00|*************************** SHIP TO
ADDRESS LEGEND *************************** |11A|30761|000|80|Ship
To Address ( 1): TEST CONTACT NAME |11A|30761|000|81|
KEVIN
SMITH |11A|30761|000|82| 1111 MERRY WAY |11A|30761|000|85| WALNUT
CREEK CA 94595 |11A|30761|000|00|
|11A|30761|000|00|********
******************* SHIPMENTS MADE TO DATE *********************
****** |11A|30761|000|00|
SHIPMENT INVOICE SHIPPED |11A|307
61|000|00|REFERENCE NUMBER DATE SHIPPING METHOD TRACKING NUMBER
|11A|30761|000|00| |11A|30761|000|91| 1 752504 11/11/1999 UPS
NEXT DAY 1Z4423970100010334 ||<EOT>

9.3 File Layouts 33

Internet Connectivity API Transaction Set

Parsed Response

01>Customer Number:
45 / SMITH KEVIN
02>
Order Status: CLOSED - ORDER FULLY SHIPPED
00>
00>
-----Bill To Address----10>
TEST CONTACT NAME
11>
KEVIN SMITH
12>
1234 MERRY WAY
13>
(SECOND ADDRESS LINE OPTIONAL)
14>
(THIRD ADDRESS LINE OPITONAL)
15>
WALNUT CREEK
CA 94595
16>
(Country line -- optional)
00>
30>Order Number: 1006357 Order Date: 11/10/2001 Order Time: 13:37:01
31>Purchase Order Number: 352
00>
SHIP TO
SHIPPED
00>PRODUCT NUMBER/
(SEE
ORDERED
TO-DATE
UNIT
00>
DESCRIPTION
BELOW) QUANTITY QUANTITY
PRICE CURRENT STATUS
00>
50>X-(Product Number)-X 1
1
1
95.00
X-(Current Status of Item)-X
51>
X-(Product Description)-X
00>
50>X-(Product Number)-X 1
1
1
86.50
51>
X-(Product Description)-X
53>X-(miscellaneous Charge Description)-X
6.75
00>
00>
--------------CHARGES-------------60>
Merchandise Total
:
181.50
61>
Discount
:
3.6362>
Applicable Tax
:
2.65
63>
Shippling / Handling:
4.60
64>
Misc Charge
:
6.75
65>
Previous Balance Due:
9.20
00>
---------69>
Total Order Charges :
201.07
00>
00>
-------------PAYMENTS------------70>
EZ Pay Installment :
35.00
71>
Prepaid
:
103.57
72>
Coupon
:
10.00
73>
Gift Serticates
:
25.00
74>
Credits
:
17.50
75>
Credit Card Payment :
10.00
00>
78>
BALANCE
:
00.00 *
00>
* BALANCE MESSAGE OR CREDIT DESCRIPTION/RESOLUTION MESSAGE:
If the customer needs to pay, a balance message such as
BALANCE DUE will appear after the total.
If money is owed to the customer, a credit message such as
CREDIT ISSUED / OVERPAYMENT ON ORDER will appear after the total.
00> 9.3 File Layouts
34

Internet Connectivity API Transaction Set

00>*************************** SHIP TO ADDRESS LEGEND ***************************

80>Ship To Address ( 1): EST CONTACT NAME
81>
KEVIN SMITH
82>
1234 MERRY WAY
83>
(SECOND ADDRESS LINE OPTIONAL)
84>
(THIRD ADDRESS LINE OPTIONAL)
85>
WALNUT CREEK
CA 94595
86>
(Country line -- optional)
87>X-Ship-to Gift message-X
88>X-Ship-to Gift message-X
00>
00>*************************** SHIPMENTS MADE TO DATE ***************************
00> SHIPMENT INVOICE
SHIPPED
00>REFERENCE
NUMBER
DATE SHIPPING METHOD
TRACKING NUMBER
00>
91>
1
752504
11/11/01 UPS NEXT DAY
1Z4423970100010334
00>
00>

Note: When both names are available, the format is:

Line 80 = Contact Name
Line 81 = Customer Name
When only the Customer Name is available, the format is:
Line 80 = Customer Name
NO Line 81

9.3 File Layouts 35

Internet Connectivity API Transaction Set

Web Server Heartbeat Request API

The ICA should accommodate functionality by which a
continual check is performed to determine if the connection to the Host System is established. A Heartbeat
request should be issued every 1 to 5 minutes. The
transaction is a simple request that the Host System
will respond to with a simple reply. If this transaction
should not receive a response, a connection down error
condition could exist requiring operator attention.
Each eld in request and response are separated by a
UNIX pipe symbol |.

Transaction Field Denitions:

ICA Request Transaction
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Request

R
R
R
R

4/A
20/A
2/N
23/A

End of Transaction

5/A

Example:

12R
SEND HEARTBEAT
RESPONSE
<EOT>

12R|123|80|SEND HEARTBEAT RESPONSE|<EOT>

Controller+ Response
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response

R
R
R

4/A
20/A
26/A

Example:

36

9.3 File Layouts

12A
RECEIVED HEARTBEAT
REQUEST

12A|123|RECEIVED HEARTBEAT REQUEST|

<EOT>

Internet Connectivity API Transaction Set

Host System Heartbeat Request API

The Host System will accommodate functionality by
which a continual check is performed to determine if the
connection to the Web Server System is established. A
Heartbeat request will be issued every 1 to 5 minutes.
The transaction is a simple request that the ICA must respond to with a simple reply. If this transaction should
not receive a response, a connection down error condition could exist requiring operator attention.
Each eld in request and response are separated by a
UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Request

R
R
R

4/A
20/A
23/A

End of Transaction

5/A

Example:

13R
SEND HEARTBEAT
RESPONSE
<EOT>

13R|123|SEND HEARTBEAT RESPONSE|<EOT>

ICA Response
Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response

R
R
R

4/A
20/A
26/A

Example:

13A
RECEIVED HEARTBEAT
REQUEST

13A|123|RECEIVED HEARTBEAT REQUEST|

<EOT>

9.3 File Layouts 37

Internet Connectivity API Transaction Set

Product Lister API

Currently the Controller provides crossell, upsell and
substitute product numbers with the product download
or extract. This provides a snapshot of these products
when the product database was actually downloaded.
However, the system does not provide availability numbers or pricing, etc. Only the product numbers are supplied and the information remains static until another
product download is performed.
This specication will provide a product lister API. It
will enable an Internet request for more information
about a product. Specically, the Product Lister API will
handle requests for an individual product for its:

Upsells
Cross Sells
Substitutes
Kit Items
Kit-on-the-Fly groups
Promotional Items
Specials Of The Day
Free Items
Order Line Item Services

The response will include all products for the request.

Up to 2000 products may be returned for a single request. Information included with each product will be:

38

9.3 File Layouts

Product Number
Kit-on-the-Fly Group Indicator
Product Description
Expected Date
Quantity Available
Normal Price
Discounted Price
Discounted Quantity

Internet Connectivity API Transaction Set

General Note for all requests and responses:

If a style master is requested, the style items will not be

returned; rather, the style master will be sent back in the
response. If a style master is in the response, the same
will occur, i.e. only the style master will be returned in
the response. It is the requesters responsibility to accommodate style item listings for style masters.
Listing Substitutes and Upsells will not include any
products that are inactive, NLA w/o stock or out of
stock.
Listing Kits and Kit-on-the-Fly groups

These are handled in the following manner. The product

download and Product Availability API identies a given
product number as a Kit Item. To retrieve the kit items,
a request will be made; the request will contain the kit
headers product number with a Product List request
of 04 = kit. The listing that is returned will contain all
the kit items. If a kit item is a Kit-on-the-Fly group, the
product number in the response will contain the group
code, and a group code indicator will be set to Y es. To
retrieve the products in the Kit-on-the-Fly group, another request will be made this will be a Kit-on-the-Fly
group request. This request will contain a Product List
ID of 05 = KOTF, and the product number will contain
the group code. The response will then contain all the
products for that group.
Listing Specials of the Day

The system date will determine whether or not the Special of the Day is valid. If there is a division code on the
Special of the Day, and there is no customer number or
the customer supplied on the request does not match
the division code, no Special of the Days will be sent
in the response. This same rule applies to if there is a
club on the Special of the Day. If there is not a customer
supplied in the request, or the customers club does not
match, the Special of the Day will not be sent back in
the response.

9.3 File Layouts 39

Internet Connectivity API Transaction Set

Listing Promotional Items

The request must contain a source code. If no source

is provided, no Promotional Items will be sent back in
the request. The system date will be used to determine
products qualied for Promotional Items. The operator
choice ag will not be used to determine which promotional items will be sent in the response, only the source
code and the system date.
Free Items

The Free Items listing request must also be accompanied

with a source code. If no source is sent in the request, no
Free Items will be in the response. The system date will
be used to determine whether or not the free items table
qualies for a response. There will be differences in the
response based on whether or not the Free Items table
being sent back is accumulative or not. If the table is
accumulative, all levels that apply for the purchase
amount supplied in the request will be returned. If the
table is not accumulative, only the highest group level
that qualied will be returned. In any case, the number
of products that can be given free will be placed in the
responses Discount Qty eld. The Free Items Tables
description will not be returned.
Order Line Item Services

If the Order Line Item Services request contains a

product number, the response will list all order line item
services assoicated with that product and any global
services. If the request does not contain a product number, the response will return all order line item services
contained within Controller+.

40

9.3 File Layouts

Internet Connectivity API Transaction Set

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Product List Request

R
R
R
R

4/A
20 / A
2/N
2/N

Product Number

O/R*

20 / A

Order Quantity
Source Code

O
O/R*

5/N
8/A

Ship To State
Ship To Zip
Customer Number
Order Net Amt

O
O
O
O/R*

3/A
9/A
9/N
11 / N

End of Transaction

5/A

14R

09 State Codes
Requests Upsells
10 US Territories
Requests Crosssells
11 Canadian Provinces
Requests Substitutes
12 International Country
Requests Kit Items
Codes
Requests
13 Charge Card Types
Kit-on-the-Fly group
14 Request Line Item
06 Requests Promotional
Services
Items
15 -19 Reserved
07 Requests Specials of
20 Request Gift Box
the Day for source code
Items
and customer code
supplied
08 Requests Free Items
Table for source code and
net amount supplied

01
02
03
04
05

*R - 01, 02, 03, 04, 06

*R - 05 (Kit-on-the-Fly
group code)
*O - 07-20
*R - 06, 07, 08
*O - 01, 02, 03, 04, 05

(Implied 2 decimals)
* R - 08
<EOT>

Example: 14R|123|01|05|10|00001|1999SPRG|IN|46202||24299| |<EOT>

9.3 File Layouts 41

Internet Connectivity API Transaction Set

Controller+ Response Format for Lister Request 01 (Upsell)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
01

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Customers Normal Price
Selling Price
Null
Null
Style Master Indicator
Null
Null
Null

R
R
R
R
O
R
R
R
R
R
R
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
7/N
7/N
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals
Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 02 (Upsell)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
02

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Customers Normal Price
Selling Price
Null
42

9.3 File Layouts

R
R
R
R
O
R
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
7/N
7/N
1/A

^|
Future Use
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals
Future Use

Internet Connectivity API Transaction Set

Response Format (continued:)

Field Description

Req/Opt

Format/Max
Size

Comment

Null
Style Master Indicator
Null
Null
Null

R
R
R
R
R

1/A
1/A
1/A
1/A
1/A

Future Use
Y if product is a style master
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 03 (Substitute)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
03

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Customers Normal Price
Selling Price
Null
Null
Style Master Indicator
Null
Null
Null

R
R
R
R
O
R
R
R
R
R
R
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
7/N
7/N
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals
Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 04 (Kit Items)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
04
9.3 File Layouts 43

Internet Connectivity API Transaction Set

Response Format (continued:)

The following may be repeated up to 2000 times delimited by TAB
Field Description

Req/Opt

Format/Max
Size

Comment

<TAB>
Product # or
On-the-Fly Group #
Component Type
Product Description
Expected Date
Quantity Available
Null
Null
Component Selling Qty
Null
Style Master Indicator
Null
Null
Null
Percent of Kit Price

1/A

^|

R
R
R
O
R
R
R
R
R
O
R
R
R
R

20/A
1/A
30/A
10/A
9/N
1/A
1/A
9/N
1/A
1/A
1/A
1/A
1/A
7/A

Y=Previous Field an On-the-Fly Group #

Product or Group Description
MM/DD/YYYY
Future Use
Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use
999.99-

Controller+ Response Format for Lister Request 05 (Kit On-the-Fly Group)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
05

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Null
Price Adjustment
Null
Null
Style Master Indicator
Null
Null
Null
44

9.3 File Layouts

R
R
R
R
O
R
R
R
R
R
R
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
1/A
7/N
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
Product or Group Description
MM/DD/YYYY
Future Use
Leading Sign implied 2 decimals
Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use

Internet Connectivity API Transaction Set

Controller+ Response Format for Lister Request 06 (Promo Items)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
06

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Customers Normal Price
Selling Price
++Must Buy Qty
++Will Get Qty
Style Master Indicator
Null
Null
Null

R
R
R
R
O
R
R
R
R
R
R
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
7/N
7/N
4/N
4/N
1/A
1/A
1/A
1/A

^|
Future Use
Product or Group Description
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals
Y if product is a style master
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 07 (Specials of the Day)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
07

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Null
Product Description
Expected Date
Quantity Available
Customers Normal Price
Selling Price

++ = New in 9.3

R
R
R
R
O
R
R
R

1/A
20/A
1/A
30/A
10/A
9/N
7/N
7/N

^|
Future Use
Product or Group Description
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals
9.3 File Layouts 45

Internet Connectivity API Transaction Set

Response Format (continued:)

Field Description

Req/Opt

Format/Max
Size

Comment

Null
Null
Style Master Indicator
Null
Null
Null

R
R
R
R
R
R

1/A
1/A
1/A
1/A
1/A
1/A

Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 08 (Free Items)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
08

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product #
Free Items Level
Product Description
Expected Date
Quantity Available
Customers Normal Price
Purchase $ to meet level
# of items to ship
when 1 is ordered
# of items to select in level
Style Master Indicator
Allow selection
from all products
Level Min Select $
@ Normal Price
Level Max Select $
@ Normal Price

46

9.3 File Layouts

R
R
R
R
O
R
R
R

1/A
20/A
2/A
30/A
10/A
9/N
7/N
7/N

^|

R
R
R

9/N
9/N
1/A

1/N

Y=Customer may have any product in

the product database

7/N

Implied 2 decimals

2/A

Implied 2 decimals

Free Items Level

Product or Group Description
MM/DD/YYYY
Implied 2 decimals
Implied 2 decimals

Y if product is a style master

Internet Connectivity API Transaction Set

Controller+ Response Format for Lister Request 09 (US State Codes)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
09

The following may be repeated up to 2000 times delimited by TAB

<TAB>
State Code
Null
State Description
Null
Null
Null
Null
Null
Null
Null
Null
Null
Null

R
R
R
R
R
R
R
R
R
R
R
R
R
R

1/A
3/A
1/A
25/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 10 (US Territory Codes)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
10

The following may be repeated up to 2000 times delimited by TAB

<TAB>
US Territory Code
Null
US Territory Description
Null
Null
Null
Null

R
R
R
R
R
R
R
R

1/A
3/A
1/A
25/A
1/A
1/A
1/A
1/A

^|
Future Use
Future Use
Future Use
Future Use
Future Use
9.3 File Layouts 47

Internet Connectivity API Transaction Set

Response Format (continued:)

Field Description

Req/Opt

Format/Max
Size

Comment

Null
Null
Null
Null
Null
Null

R
R
R
R
R
R

1/A
1/A
1/A
1/A
1/A
1/A

Future Use
Future Use
Future Use
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 11 (Canadian Province Codes)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
11

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Province Code
Null
Province Description
Null
Null
Null
Null
Null
Null
Null
Null
Null
Null

48

9.3 File Layouts

R
R
R
R
R
R
R
R
R
R
R
R
R
R

1/A
3/A
1/A
25/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use

Internet Connectivity API Transaction Set

Controller+ Response Format for Lister Request 12 (International Country Codes)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
12

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Country Code
Null
Country Description
Null
Null
Null
Null
Null
Null
Null
Null
Null
Null

R
R
R
R
R
R
R
R
R
R
R
R
R
R

1/A
3/A
1/A
25/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A

^|
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 13 (Charge Card Types)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
13

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Charge Card Type Code
Null
Charge Card Name
Check Digit Type
Null
Null

R
R
R
R
R
R
R

1/A
1/A
1/A
15/A
1/A
1/A
1/A

^|
Future Use
Future Use
Future Use
9.3 File Layouts 49

Internet Connectivity API Transaction Set

Response Format (continued:)

Field Description

Req/Opt

Format/Max
Size

Comment

Null
Null
Null
Null
Null
Null
Null

R
R
R
R
R
R
R

1/A
1/A
1/A
1/A
1/A
1/A
1/A

Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use

Controller+ Response Format for Lister Request 14 (Line Items Services)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
14

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Service Code
Service Description
Unit Price
Taxable Indicator
Default Service Indicator
Null
Null
Null
Null
Null
Null
Global Use Indicator

R
R
R
R
R
R
R
R
R
R
R
R
R

1/A
9/N
30/A
9/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A
1/A

Personalization Template #

5/N

^|
99999.99Y/N
Y/N
Future Use
Future Use
Future Use
Future Use
Future Use
Future Use
0=Dened to item 1=Any Item
2=No Drop Ship 3=No Truck Ship
4=Gift Card

++ Note: If no Product# was supplied on the input transaction, all line item services will be listed.
Controller+ Response Format for Lister Request 15-19 are reserved for future use

50

9.3 File Layouts

++ = New in 9.3

Internet Connectivity API Transaction Set

Controller+ Response Format for Lister Request 20 (Gift Box Items)

Field Description

Req/Opt

Format/Max
Size

Comment

Transaction Code
Transaction ID
Response Code
Product List Request

R
R
R
R

4/A
20/A
3/N
2/N

14A
20

The following may be repeated up to 2000 times delimited by TAB

<TAB>
Product # or Gift Box Group #
using Kit On-the-y requests
Component Type
Product Description
Expected Date
Quantity Available
Null
Null
Component Selling Qty
Null
Style Master Indicator
Null
Null
Null
Null

R
R

1/A
20/A

^|
Gift Box Groups can be retrieved

R
R
O
O
R
R
R
R
O
R
R
R
R

1/A
30/A
10/A
9/N
1/A
1/A
9/N
1/A
1/A
1/A
1/A
1/A
1/A

Y=Previous Field a Group #

Product or Group Description
MM/DD/YYYY
Future Use
Future Use
Future Use
Y if product is a style master
Future Use
Future Use
Future Use
Future Use

9.3 File Layouts 51

Internet Connectivity API Transaction Set

Customer Authentication API

The function of the Customer Authentication API is to facilitate the
customer login process from the Internet. The E-Commerce Application (referred to as ECA from this point on) is responsible for
maintaining a customer database of users in the system. In this database the customers name, address, e-mail address, and Controller+ customer number will be maintained. This APIs purpose is to
maintain synchronization of customer information between the ECA
and The Controller+.
When a user begins the order process over the Internet, they will
be requested to login and identify themselves. Here the ECA will
request e-mail address and a password. This should identify a
customer on the ECA. After the customer is identied, an API request should be submitted to the Controller+ for customer number
authentication. If the ECA does not have a corresponding Controller+
number, a request will still be made in an attempt to allow the Controller+ to nd a match due to previous activity through the catalog.
The purpose here is to provide a reasonable amount of synchronization between the two databases.
In the situation where the ECA does not have a corresponding Controller+ customer number, this API will take the submitted address
and perform matching logic to nd a match in the C+ customer database. If a single match is found, then the matching customer number will be returned. If no match, or multiple matches are found, no
customer number will be returned.
There are two levels of match logic available, one which searches for
a Loose Match, and one which searches for a Tight Match (see
below). The level of match logic to be used is determined by how the
system is congured. Contact a Sigma Micro Representative for assistance with these options.

52

9.3 File Layouts

Internet Connectivity API Transaction Set

Customer Authentication API (continued:)

The following criteria will be applied when searching for a match:
A Loose Match will be determined when the following items match:
5 digit zip code
All of the last name
First 3 positions of the rst name
All numeric characters in the rst address line (assumed to be
the street address number)
A Tight Match will be determined when the following items match:
5 digit zip code
All of the last name
First 3 positions of the rst name
All numeric characters in the rst address line (assumed to be
the street address number)
First 3 non-numeric characters in the rst address line (assumed to be the street address name)
First string of characters found after APT, UNIT, # in rst
or second address lines. (assumed to be the apartment number
or other unit designator)
Note: when strings of characters are processed, all special characters (:,. etc) will be ignored.
In the situation where the ECA has a customer number they should
submit the customer number to the API for authentication. Here the
address and customer number will be submitted to the API. The API
will retrieve the corresponding Controller+ customer information using the supplied customer number. Next, the address matching logic
will be performed on the supplied ECA address and the Controller+
address. If the addresses match or the e-mail addresses match, then
the API will return a conrmation status of a match.

9.3 File Layouts 53

Internet Connectivity API Transaction Set

Customer Authentication API (continued:)

In the situations where the supplied customer number does not exist
in the Controller+ database or the address does not match, an error
status will be returned. In addition to the error status, the API will
perform the matching logic to nd a customer that does match the
supplied address. The same logic will be performed as when the ECA
submitted a request without a customer number.
The API will perform one more function. When the user logs into the
ECA system, they should have the ability to conrm their address
and then identify an address change. In this situation when the
request to the API is made, the address for matching should be the
original address. The new address should be submitted along with
the transaction. If a successful address match is made, then the API
will update the Controller+ customer database with the supplied new
address. If the match is not made, no update will take place. In addition, if the Controller+ nds a match during the assigning process,
the address will still not be updated.
Each eld in request and response are separated by a UNIX pipe
symbol |.
Controller+ Request Transaction

Field Description
Transaction Code
Transaction ID
Company Number
Original Mailing Address

54

9.3 File Layouts

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

R
R
R

4/A
20 / A
2/N

15R

(Address from ECA prior to

customer change)

Internet Connectivity API Transaction Set

Request Transaction (continued):

(R)equired/
(O)ptional

Max Size / Format

Alphanumeric / Numeric

Company Name
First Name
Last Name

O
R
R

Street Number
Street Name
APT/Unit Number

O
R
O

30 / A
14 / A
Name Field Formats:
15 / A30/A For optimum functionality the Name Fields
(First Name & Last Name) should be
formatted for use as separate elds. If you
are unable to format these elds
separately, they may be combined, and the
following will apply:
1--Combination is based on switch
settings in the Controller+.
2--Total number of characters must not
exceed 28.
3--The sequence of information should
be LAST NAME,FIRST NAME
Ex: Smith,Thomas.
4--Combined information must be
entered in the FIRST NAME eld.
5--The LAST NAME eld must be left
empty.
5/N
Street Address Field Formats
20 / A30/A For optimum functionality the Street
5/A
Address Fields (Street Number, Street
Name, & APT/Unit Number) should be
formatted for use as separate elds. If you
are unable to format these elds
separately, they may be combined, but the
result may not exceed a total of 30 and
must be entered in the Street Name eld.
Combination is based on switch settings in
the Controller+.Ex: Possible formats for the
street address 6720 Parkdale Place #200
...|6720|Parkdale Place|#200|...
...|6720 Parkdale Place #200|||...

Field Description

9.3 File Layouts 55

Internet Connectivity API Transaction Set

Request Transaction (continued):

Field Description

(R)equired/
(O)ptional

Additional Address Line

City
State/Country Code
Zip Code
Original E-Mail Address

O
R
O
O
R

Max Size / Format

(Alphanumeric /
Numeric)
30 / A
15 / A
3/A
9/A
50 / A

Customer Number

9/N

O
R
R

30 / A
14 / A
Name Field Formats:
15 / A30/A For optimum functionality the Name Fields
(First Name & Last Name) should be
formatted for use as separate elds.If you
are unable to format these elds
separately, they may be combined, and the
following will apply:
1--Combination is based on switch
settings in the Controller+.
2--Total number of characters must not
exceed 28.
3--The sequence of information should
be LAST NAME,FIRST NAME
Ex: Smith,Thomas.
4--Combined information must be
entered in the FIRST NAME eld.
5--The LAST NAME eld must be left
empty.

New Mailing Address

Company Name
First Name
Last Name

56

9.3 File Layouts

Notes/Comments

(Email Address from ECA

prior to customer change)
(If Site Server database has
one available)
(New Address for customer to
be used if successful
Controller+ match on Original
Mailing Address supplied above)
(If address is supplied then all
required elds must be supplied.)

Internet Connectivity API Transaction Set

Request Transaction (continued):

Field Description
Street Number
Street Name
APT/Unit Number

Additional Address Line

City
State/Country Code
Zip Code
New E-Mail address
End of Transaction

(R)equired/
(O)ptional
O
R
O

O
R
O
O
O
R

Max Size / Format

(Alphanumeric /
Notes/Comments
Numeric)
5/N
Street Address Field Formats
20 / A30/A For optimum functionality the Street
5/A
Address Fields (Street Number, Street
Name, & APT/Unit Number) should be
formatted for use as separate elds.If you
are unable to format these elds
separately, they may be combined, but the
result may not exceed a total of 30 and
must be entered in the Street Number eld.
Combination is based on switch settings in
the Controller+.Ex: Possible formats for the
street address 6720 Parkdale Place #200
...|6720|Parkdale Place|#200|...
...|6720 Parkdale Place #200|||...
30 / A
15 / A
3/A
9/A
50 / A
5/A
<EOT>

9.3 File Layouts 57

Internet Connectivity API Transaction Set

Field Description

(R)equired/
(O)ptional

Response Format:
Transaction Code
Transaction ID
Response Code

Max Size / Format

(Alphanumeric /
Numeric)

R
R
R

4/A
20 / A
3/N

15A

1/N

Customer Authentication Status

Matched Customer Number

9/N

Match Level

1/N

Club Status

1/A

Club ID
Returned Multiple Matches
<EOT>

O
R

5/A
1/A

58

9.3 File Layouts

Example:

Notes/Comments

(Use same response codes

used in other APIs)
(This status will be used to
communicate the
authentication of the supplied
customer number)
0 - Customer number found in
C+ database and Address
and/or Email match.
1 Customer number not
found in C+ database.
2 Customer Number found
but no match on Address
and Email.
9 Customer number not
supplied
(zero or returned customer
number)
(This status will be used to
communicate the success of
the C+ assign customer
number process.)
0 Returned Matching
Customer Number result
of address and
e-mail matches.
1 Returned Matching
Customer Number result
of address match only.
2 Did not return Matching
Customer Number
because either no
match was found or
multiple matches
were found.
(Club and ID of authenticated
/matched customer numbers.)
Yes or No

15A|12345|000|0|27549|0|A|GOLD|NO|<EOT>

Internet Connectivity API Transaction Set

Factory Order Conrmation API

This API will provide a function by which factory orders can be cancelled or conrmed. This is the rst API that does not relate directly
to processing an order. Currently, factory orders are distributed
(mailed, faxed, or transmitted) to suppliers. The suppliers process
the factory orders and ship them directly to the customer. The supplier then sends back shipment conrmations to the company, and
the information is manually keyed back into the Controller+ application. The possible use of this API would be to allow a Web page to be
developed through which the supplier would be able to directly feed
factory order conrmations or cancellations back to the company
and directly into the system, eliminating the need for re-keying.
Each eld in the request and response are separated by the UNIX
pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Factory Order Number

R
R
R
O

4/A
20 / A
2/N
9/N

Batch Number

9/N

Supplier ID
Acknowledged Date

O
O

6/A
8/N

Scheduled to Ship Date

8/N

Conrmed Shipment Date

8/N

Cancellation Date

8/N

16R

If not provided, a Batch Number must

be provided.
If not provided, a Factory Order Number
must be provided.
MMDDYYYY - Date supplier
acknowledges receipt of Factory Order.
MMDDYYYY - Date supplier anticipates
shipment.
MMDDYYYY - Conrmed date of
shipment. If not provided a Cancellation
Date must be provided.
MMDDYYYY - Cancellation date.
Supplier has cancelled the factory
order and no shipment to customer is
being made. If not provided a Conrmed
Shipment Date must be provided.

9.3 File Layouts 59

Internet Connectivity API Transaction Set

Field Description

(R)equired/
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Unit Cost

99999.9999

Additional Cost

99999.99

Unit cost of product shipped to

customer.
Additional costs the supplier has
charged your company for the dropship
(special handling, etc.). If the system is
congured to Bill Upon Conrmation,
this cost gure will be worked into the
cost of goods sold on the order.

Supplier Comments 1
O
30 / A
Supplier Comments 2
O
30 / A
Conrm Qty
O
9999.999
******Note, the following 2 elds may be repeated up to a max 100 times delimited by tab.
<TAB>
R
1/A
^ |
Tracking Number
O
30 / A
No spaces
Ship Method
O
1/A
Valid Controller+ method
End of Transaction
R
5/A
<EOT>
Examples:
16R|12345|01|3489344| | | | |07152000||12.35|4.50| | |<EOT>

Controller+ Response Format:

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID

R
R

4/A
20 / A

Response Code

3/N

Error Response Message

60 / A

Examples:
16A|12345|000| |<EOT>
--------------------------16A|12345|220|Invalid Order Conrmation Date Supplied|<EOT>

60

9.3 File Layouts

16A
Return contents of Transaction ID from
original requests.
Refer to Response Codes at end of
document.

Internet Connectivity API Transaction Set

Maintain Customer Information API

This API provides a function by which various customer-related information can be retrieved from and update to Controller+ Controller+
controls all information about a customer. This information needs to
be accessible by Web systems in order to properly process a customers
order. In addition, there is various information that we need to allow the
Web to update. For example, the Web will need to know if a customer
is a member of a club so the Web system can allow club points to be
redeemed as payment -- not to mention how many club points the customer has available. At the same time, the Web system should allow the
customer to control their Do Not Mail Do Not Rent Do Not Phone
and Do Not Email ags.
Each eld in the request and response are separated by a UNIX pipe
symbol |.
Controller+ Request Transaction
Field Description

(R)equired/
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Customer Number

R
R
R
R

4/A
20 / A
2/N
9/N

Do Not Email

1/A

Do Not Mail

1/A

17R

Controller+ number of customer to

retrieve/update information.
Set this eld to Y if customer does not
want to receive Email communications
other than order notices. Set this eld
to N if customer does want to receive
Email communications and solicitations.
If supplied, customer information will be
updated.
Set this eld to Y if customer does not
want to receive mail communications
other than order notices. Set this eld
to N if customer does want to receive
mail communications and solicitations.
If supplied, customer information will be
updated.

9.3 File Layouts 61

Internet Connectivity API Transaction Set

Request Transaction (continued):

Field Description

(R)equired/
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Do Not Phone

1/A

Do Not Rent

1/A

Phone Number 1

20 / A

Phone Number 2

20 / A

Fax Number
Email Promo (Opt In)
Add Customer Indicator

O
O
O

20 / A
1/A
1/A

Company Name

30 / A

First Name
Last Name

62

9.3 File Layouts

R
R

Set this eld to Y if customer does not

want to receive phone communications
other than order notices. Set this eld
to N if customer does want to receive
phone communications and
solicitations.
If supplied, customer information will be
updated.
Set this eld to Y if customer does not
want their name and address sold/
rented to other list houses and
companies. Set this eld to N if
customer does want their name and
address sold/rented to other list houses
and companies.
If supplied, will update Controller+
customer phone number 1.
Punctuation optional:
Examples:
317-631-0907 EX:6812
31763109076812
If supplied, will update Controller+
customer phone number 2.
Punctuation optional:
Examples:
317-631-0907 EX:6812
31763109076812
31763109076812

Y = Add customer to database

as new

Entry of either Company Name or Last

Name is required.
14 / A
Name Field Formats:
15 / A30/A For optimum functionality the Name Fields
(First Name & Last Name) should be
formatted for use as separate elds.If you
are unable to format these elds
separately, they may be combined, and the
following will apply:

Internet Connectivity API Transaction Set

Request Transaction (continued):

Field Description

(R)equired/
(O)ptional

Street Number
Street Name
APT/Unit Number

O
R
O

Additional Address Line

City
State
Zip

O
R
O
O

Max Size / Format

Notes/Comments
Alphanumeric / Numeric
Name Field Formats (Contd)
1--Combination is based on switch
settings in the Controller+.
2--Total number of characters must not
exceed 28.
3--The sequence of information should
be LAST NAME,FIRST NAME
Ex: Smith,Thomas.
4--Combined information must be
entered in the FIRST NAME eld.
5--The LAST NAME eld must be left
empty.
5/N
Street Address Field Formats
20 / A30/A For optimum functionality the Street
5/A
Address Fields (Street Number, Street
Name, & APT/Unit Number) should be
formatted for use as separate elds.If you
are unable to format these elds
separately, they may be combined, but the
result may not exceed a total of 30 and
must be entered in the Street Number eld.
Combination is based on switch settings in
the Controller+. Ex: Possible formats for
the street address 6720 Parkdale Place
#200
...|6720|Parkdale Place|#200|...
...|6720 Parkdale Place #200|||...
30 / A
25 / A
3/A
9/A

9.3 File Layouts 63

Internet Connectivity API Transaction Set

Request Transaction (continued):

Field Description

(R)equired/
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Email Address

50 / A

Customer Division
Source Code

O
R/O

1/A
8/A

Customer Title

O
O
R

1/A
1/A
5/A

++ Delivery Indicator

End of Transaction

Syntax:
-Must be at least 5 characters in length
-Must have one (and only one) @
-Must have at least one period
-No more than 3 characters after the
last period
-Must not have _ (underscore) after
the @
If transaction is to ADD a record,
source code is required. If
transaction is to UPDATE a record,
source code must not be present.
If used, contact client for valid codes.
(C)ommerical, (R)esidential
<EOT>

Example:

17R|12345|01|123456789|N|N|N|N|800-227-4462|3176310907|317-631-6585|Y
|Y||Tim|Lanie|6720|E.SouthportRd|||Indianapolis|IN|46259|tjlanie@sigma-micro.
com||12345||<EOT>

++ = New in 9.3

64

9.3 File Layouts

Internet Connectivity API Transaction Set

Response Format:

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID

R
R

4/A
20 / A

Response Code

3/N

Do Not Email

1/A

Do Not Mail

1/A

If set to Y customer does not

want to receive mail communications
other than order notices. If set
to N customer does want to receive
mail communications and solicitations.

Do Not Phone

1/A

Do Not Rent

1/A

On Account

1/A

If set to Y customer does not want to

receive phone communications other
than order notices. If set to N
customer does want to receive phone
communications and solicitations.
If set to Y customer does not want
their name and address sold/rented to
other list houses and companies. If set
to N customer does want their name
and address sold/rented to other list
houses and companies.
Customers On Account status.
Y - Customer has payment terms
(2% 10, Net 30, etc.)
O - Customer has conditional payment
terms. Usually means that only a
customer service operator can extend
terms on an order-by-order basis.
N - Customer has NO payment terms.

17A
Return contents of Transaction ID from
original request.
Refer to Response Codes at end of
document.
If set to Y customer does not
want to receive Email communications
other than order notices. If set
to N customer does want to receive
Email communications and solicitations.

9.3 File Layouts 65

Internet Connectivity API Transaction Set

Response Format (continued):

Division Code

1/A

Club ID
Club Status

O
O

5/A
1/A

Club Points Available

order.
Club Points Value

9/N

11 / N

Club Member Start Date

Club Expiration Date
Club Points Earned Per $

O
O
O

10 / A
10 / A
3/N

Club Savings to Date

11 / N

Phone Number 1

20 / A

Phone Number 2

20 / A

COD Flag

1/A

Fax Number
Email Promo (Opt In)

O
R

20 / A
1/A

66

9.3 File Layouts

Division to which customer has been

assigned.
Club where the customer is a member.
If customer is a member of a club, then
this identies their current status.
Active Statuses:
Space - Current
N - New
R - Renewal
U - Upgrade
Inactive Statuses:
E - Expired
H - Return Hold
T - Returned
I - Idle
Club Points available to redeem on
Redemption value of available club
points. (Assume 2 decimal positions.)
MM/DD/YYYY
MM/DD/YYYY
Club points earned for each dollar of
the purchase.
Total savings-to-date on purchases as
a club member. (Assume 2 decimal
positions.)
Customers Phone Number 1

Customers Phone Number 2 format

example: 317-631-0907(6812)
Collect on Delivery Type
1 - COD Certied Funds
2 - COD Check Option 1
3 - COD Check Option 2
Space - No specic COD restriction
(Y) if customer has opted in to
receive email promotions. (N) if the
customer has opted not to receive email
promotions.

Internet Connectivity API Transaction Set

Response Format (continued):

Assigned Customer Number

9/N

Customer Name
Customer Address Line 1

R
R

30 / A
30 / A

Customer Address Line 2

Customer Address City
Customer Address State
Customer Address Zip Code
Customer Address Contact

O
R
R
R
O

30 / A
25 / A
3/A
9/A
30 / A

Customer Email Address

COD Status

O
R

50 / A
1/A

Customer Title
Club Description
Club Points Redeemed to Date

O
O
O

1/A
30 / A
9/N

Club Points Good Until Date

8/N

Club Renewal Points

Club Renewal Days

O
O

9/N
9/N

Club Renewal Notice Count

1/N

1/A

++ Delivery Indicator

This is the number assigned to the

customer when they were added to the
system. This number is supplied only
when the original request included a
Y in the Add Customer Indicator
eld.
This address is the customers mailing
address.

This is the name of the customers

mailing address contact if any.
Potential values are:
(blank)Allow COD
YCOD history is OK
NDo not allow COD
RHas refused COD
Description of customers club
Total club points redeemed for life of
club membership
Date through which club points
may be redeemed
Club points earned if club is renewed
Number of Days added to the club
membership when it is renewed
Number of renewal notices sent
to customer
(C)ommerical, (R)esidential

++ = New in 9.3
9.3 File Layouts 67

Internet Connectivity API Transaction Set

Response Format (continued):

Examples:
17A|12345|291|Invalid Customer ID|<EOT>
---------------------------

17A|12345|000|N|N|N|N|Y|W|GOLD||500|1000|10/15/1998|10/15/2000|1|8450
|800-227-4462|317-631-0907 (6812)||317-631-6585|Y|123456|Lanie,Tim|6720
E.SouthportRd||Indianapolis|IN|46259||tjlanie@sigma-micro.com|||<EOT>
Note:
This API is one of a few that actually update the Controller+ information. Depending on the conguration of the system, updates are not
permitted while the Controller+ system is being backed up. If you
submit a request to update customer information, and you receive a
response code 371, this indicates that the update information was
not performed due to system being backed up. You must retry the
update at a later time.

68

9.3 File Layouts

Internet Connectivity API Transaction Set

Controller+ Version/ Options API

This API provides a function by which a request will return the
current Controller+ version and company-related system options.
Functionality extended through the API is often limited to the version
of the Controller+ that they are associated with, and the conguration of the system. For example, the API can sell in fractional units.
Similarly, the APIs can accept orders with 100 line items. If the Controller+ is only congured to process orders with 80 line items, then
there would be a signicant problem -- the last 20 line items would
be dropped. By using the Version/Options API, the Web site can be
dynamically programmed to control Web functionality based on the
version of the Controller+ and system conguration options.
Each eld in the request and response are separated by a UNIX
pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
End of Transaction

R
R
R
R

4/A
20 / A
2/N
5/A

18R

<EOT>

Examples:
18R|12345|01|<EOT>
Controller+ Response Format:

9.3 File Layouts 69

Internet Connectivity API Transaction Set

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID

R
R

4/A
20 / A

Response Code

3/N

Controller+ Version
Maximum Line Items Per Order

R
R

7/A
3/N

Require Customer
Demographics

1/A

Uses Clubs

1/A

Uses Postalsoft

1/A

Uses Division Accounting

1/A

Request Transaction (continued):

70

9.3 File Layouts

18A
Return contents of Transaction ID from
original request.
Refer to Response Codes at end of
document.
Example: 8.40B
A number from 1 to 400. Please note
that the Controller+ can accept 400 line
items on an order, but the Internet
Orders are still limited to a maximum of
100 line items to an order.
Company requires capture of customer
demographics.
(Y)es
(N)o
Blank - No
Company congured to process club
memberships.
(Y)es
(N)o
Blank - No
Company congured to standardize
customer addresses using the
Postalsoft option.
(Y)es
(N)o
Blank - No
Company congured to enforce division
accounting.
(Y)es
(N)o
Blank - No

Internet Connectivity API Transaction Set

Sell in Fractional Units

1/A

Company congured to sell and fulll

products in fraction units.
(Y)es
(N)o
Blank - No

Style/Color/Size Product
Numbers

1/A

Order Discounting Routine

1/A

Process Electronic Checks

1/A

Company congured to maintain

product numbers in the Style/Color/Size
format.
(Y)es
(N)o
Blank - No
Company congured to discount
customer orders at the following level:
(O)rder
(L)ine item
(N)o Discounting
Blank - No discounting
Company congured to accept
electronic check as a form of payment
on order.
(Y)es
(N)o
Blank - No

Examples:
18A|12345|294|Invalid company number supplied|<EOT>
----------------18A|12345|000|8.40B|80|N|Y|N|Y|N|Y|O|Y|<EOT>

9.3 File Layouts 71

Internet Connectivity API Transaction Set

Controller+ Product DB Sync API

The web allows for lengthier product descriptions than those which
can be maintained in Controllers regular database. A data le has
been established with expanded product information.
This API provides a function by which a request will return the
expanded product information which can then be used to update a
website. Each eld in the request and response are separated by a
UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Mode
Product Internal Number
End of Transaction

R
R
R
R
O/R
R

4/A
20 / A
2/N
1/A
7/N
5/A

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Product Number
Product Internal Number

R
R

20 / A
7/N

Product Name

100 / A

Controller+ Response Format

72

9.3 File Layouts

19R

C = COMPLETE; U = UPDATE ONLY

zeros or product just processed
<EOT>

19A
Refer to Response Codes at end of
document
Requested product number
Requested internal product number
from Controller+

Internet Connectivity API Transaction Set

Response Transaction (continued):

(R)equired/
Field Description
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Short Description
Long Description

O
O

100 / A
6400 / A

Image
Attribute Label 1
Attribute Label 2
Additional Info Prompt
Additional Info Status

O
O
O
O
O

100 / A
20 / A
20 / A
100 / A
1/A

Priority
Disabled
Allow Fractional Units
List Price
Thumbnail Left HTML
Thumbnail Left Image
Thumbnail Left Height
Thumbnail Left Width
Thumbnail Right HTML
Thumbnail Right Image
Thumbnail Right Height
Thumbnail Right Width
Assigned Family 1
Assigned Family 2
Assigned Family 3
Assigned Family 4
Assigned Family 5
Assigned Department 1
Assigned Department 2
Assigned Department 3
Assigned Department 4
Assigned Department 5

O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O
O

1/A
1/A
1/A
7/N
1/A
150 / A
3/N
3/N
1/A
150 / A
3/N
3/N
9/N
9/N
9/N
9/N
9/N
9/N
9/N
9/N
9/N
9/N

If provided by Controller+ product

narrative maximum of 6400 characters < Revised
02/21/05

Blank; C = web customized prompt;

S = collection of additional info on web
has been suppressed; U = Controller+
additional information prompt
Yes or No
Yes or No
Yes or No
9(5)V99
Yes or No

Yes or No

9.3 File Layouts 73

Internet Connectivity API Transaction Set

Response Transaction (continued):

(R)equired/
Field Description
(O)ptional

Max Size / Format

Notes/Comments
Alphanumeric / Numeric

Product Keyword Block

Personalization Template #
Transaction Type

1200 / A
7/N
1/A

O
O
R

A = Add
M = Modied
R = Renumber
P = Purge

Renumber-To Product #
O
20 / A
Product Terminator
O
1/A
^I (TAB)
******Note, these 5 attribute item elds may be repeated up to a max 90 times delimited by tab.
Attribute Indicator 1
R
1/A
Display Index
R
2/N
1 - 90
Controller Attribute 1
R
5/A
Web Equivalent Attribute 1
R
15 / A
Attribute Item 1 Terminator
R
1/A
^I (TAB)
End of Attribute Items Flag
R
5/A
<EOT>
End of Transaction Terminator
R
5/A
<EOT>

74

9.3 File Layouts

Internet Connectivity API Transaction Set

Gift Certicate/Coupon API

This API performs validation on either gift certicates or coupons
without requiring the submission of an order edit transaction.
Dpending on what request is sent, error messages are returned
which contain either all coupons which are in error or all gift certicates which are in error. Each eld in the request and response are
separated by a UNIX pipe symbol |.

Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
R
4/A
20R
Transaction ID
R
20 / A
Company Number
R
2/N
Mode
R
2/A
C = Coupons; G = Gift Certicates
******Note, the following code elds may be repeated up to a max 13 times for Coupons OR
15 times for Gift Certicates.
Coupon Code 1 or
Gift Certicate Code 1
R
9/N
First code is always required
Gift Certicate Auth Code 1

9/N

Auth code for gift certicates only; this

eld will be ignored for coupons

End of Transaction

5/A

<EOT>

9.3 File Layouts 75

Internet Connectivity API Transaction Set

Controller+ Response Format

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

20A

Error Code 1

3/A

Error Message 1 OR
Gift Certicate Amount

60 / A OR
9(9)V99

Erred GC/Coupon

9/N

Coupon Type

1/A

Error Item 1 Terminator

End of Transaction Terminator

R
R

1/A
5/A

Refer to Response Codes at end of

document
If the coupon is invalid, or an error is
found for this gift certicate, this will be
an error message specic to the
coupon or gift certicate. For a gift
certicate with no error found, this eld
will contain the gift certicate amount.
Gift Certicate or Coupon code for item
for which the error was found
C = Computed; M = Manual;
F = Free shipping
^I (TAB)
<EOT>

Refer to Response Codes at end of

document
Error Message
R
60 / A
Blank or error message specic to
GCs, Coupons or program-related error
Terminator
O
1/A
^I (TAB)
******Note, the following error item elds may be repeated up to a max 15 times delimited by tab.

76

9.3 File Layouts

Internet Connectivity API Transaction Set

Demographics Denitions API

The eController allows for the capture of customer demographic
information. This API provides functionality by which the website
can inquire on and receive the demographic information denitions
which have been established in the Controller database. The information returned will include each demographic variable and its valid
responses. Each eld in the request and response are separated by a
UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Demographic Request

R
R
R
R

4/A
20 / A
2/N
2/N

Demographic Field Number

End of Transaction

O
R

2/A
5/A

21R

01 = Requests ALL demographic eld

denitions
02 = Requests look-up validaton of a
specic demographic eld
1-15 (if request 02 is used)
<EOT>

Controller+ Response Format (01)

******Note, the response provided will depend on the Demographic Request
specied with the original request.
If a Demographic Request of 01 is requested, the following response will be returned.
Field Format
(R)equired/
Max Size / Format
Field Description
(O)ptional
Alphanumeric / Numeric
Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Demographic Request

2/N

<TAB>

21A
Refer to Response Codes at end of
document.
01 = Requests ALL demographic eld
denitions

9.3 File Layouts 77

Internet Connectivity API Transaction Set

Response for Demographic Request type 01 (continued):

(R)equired/
Max Size / Format
Notes/Comments
Field Description
(O)ptional
Alphanumeric / Numeric
******Note, for a response to an 01 (ALL demographic elds) request ONLY, all of the following elds
may be repeated up to a max 15 times delimited by tab.
Demographic Field Number
Entry Prompt
Required Flag
Field Size
Format

R
R
R
R

R
13 / A
1/A
2/N
1/A

Edit Indicator

1/A

Edit Range Start

Edit Range End
<TAB>
End of Transaction

R
R

6/A
6/A

5/A

2/N

1-15

Yes or No
N = Numberic; C = Character;
P = Phone
D = Date; R = Range; T = Table;
N = No edit

<EOT>

Controller+ Response Format (02)

******Note, the response provided will depend on the Demographic Request
specied with the original request.
If a Demographic Request of 02 is requested, the following response will be returned.
Field Format
(R)equired/
Max Size / Format
Field Description
(O)ptional
Alphanumeric / Numeric
Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Demographic Request

2/N

Demographic Field Number

<TAB>

2/N

21A
Refer to Response Codes at end of
document.
02 = Requests look-up validaton of a
specic demographic eld
1-15

******Note, for a response to an 02 (Specied demographic eld) request ONLY, all of the following
elds may be repeated up to a max 100 times delimited by tab.
Valid Response
Valid Rsponse Description
<END>
End of Transaction

78

9.3 File Layouts

R
R

8/N
25 / A

1-15

5/A

<EOT>

Internet Connectivity API Transaction Set

Demographics Inquiry API

The eController allows for the capture of customer demographic
information. This API provides functionality by which the website can
request current denmographic information by customer number. The
request will return any demographic information stored for the specied customer. Each eld in the request and response are separated
by a UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Company Number
Customer Number
End of Transaction

R
R
R
R
R

4/A
20 / A
2/N
9/N
5/A

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Controller+ Response Format

22R

<EOT>

22A
Refer to Response Codes at end of
document

<TAB>
******Note, the following 2 elds may be repeated up to a max 15 times delimited by tab.
Demographic Field Number
Demographic Entry
<TAB>
End of Transaction

R
25 / A

5/A

2/N

1-15

<EOT>

9.3 File Layouts 79

Internet Connectivity API Transaction Set

Demographics Update API

The eController allows for the capture of customer demographic
information. This API provides a function by which the website can
submit demographic information collected from customers to be
edited and then used to update the Controllers record if desired. If
errors are found, the appropriate error message is returned to the
website. Each eld in the request and response are separated by a
UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code

4/A

Transaction ID
Company Number
Customer Number
<TAB>

R
R
R

20 / A
2/N
9/N

23R (Edit Only)

24R (Edit and Capture)

******Note, the following 2 elds may be repeated up to a max 15 times delimited by tab.
Demographic Field Number
Demographic Entry
<TAB>
End of Transaction

R
25 / A

5/A

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code

R
R
R

4/A
20 / A
3/N

Error Number
Error Message
Demographic Field Number
in Error
End of Transaction

R
R

3/N
60 / A

R
R

2/N
5/A

Controller+ Response Format

80

9.3 File Layouts

2/N

1-15

<EOT>

23A 24A
Refer to Response Codes at end of
document.

1-15
<EOT>

Internet Connectivity API Transaction Set

Advanced Personalization Denitions

The current eController system provides functionality to capture
additional information on the Web site during the shopping experience. The current Controller+ application supports Advanced
Personalization. This API will allow for a Web site to inquire on
and retrieve the advanced personalization denitions dened in
the Controller+. There will be three Request Types. Request
one will return the next sequential template number, and all its
denitions, based on the input template number. Request two
will return the requested template number and all its denitions.
Request three will look-up validations for a specic template and
eld. Each eld in the request and response are separated by a
UNIX pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
(Alphanumeric / Numeric)

Transaction Code
Transaction ID
Company Number
Request Type

R
R
R
R

4/A
20 / A
2/N
1/A

Advanced Personalization
Template Number

7/N

25R

1 = Return rst / next dened

Template
2 = Return specic Template
3 = Look-up Validations for
Specic Template Field
If Request Type = 1 and eld =
zero, return rst Advanced
Personalization Template on le.
If Request Type = 1 and eld >
zero, return next Advanced
Personalization Template on le
after the number supplied. The
number supplied would be the
number of the last template to
be processed.
If Request Type = 2 eld must
be supplied. Return the
template for the template
number supplied.

9.3 File Layouts 81

Internet Connectivity API Transaction Set

Response for Advanced Personalization (continued):

Field Description

(R)equired/
(O)ptional

Field Number

End Of Transaction

Controller+ Response Format

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
(Alphanumeric / Numeric)
If Request Type = 3 eld must
be supplied. Specify the
template for which the specic
eld validations are to be
returned.
2/N
If Request Type = 3 eld must be
supplied. Specify the number of
the template eld for which
validations are to be returned.
5/A
<EOT>

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
Transaction ID
Response Code
Request Type

R
R
R
R

4/A
20 / A
3/N
1/N

Advanced Personalization
Number

7/N

Template Name
Gift Card Indicator
Field Number

R
R
O

30 / A
1/A
2/N

<TAB>

1/A

82

9.3 File Layouts

25A
1, 2, or 3 based on original
requesting transaction.
Number of template for which Template
response is associated. If Request
Type = 1, a EOTEMP will indicate
there are no more templates to
return.
Name of Template
Yes / No
Number of eld with which this
response is assoicated. This eld will
be empty when the le is being returned
in response to Request Types 1 and 2.
There will only be data in this eld when
it is being returned for Request Type 3.
Response Delimiter

Internet Connectivity API Transaction Set

Response for Advanced Personalization (continued):

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
(Alphanumeric / Numeric)

IF REQUEST TYPE = 1 OR 2 (FIELD DEFINITIONS)

******Note, the following elds may be repeated up to a max 15 times, delimited by <TAB>. The series of
elds will be returned for each Advanced Personalization template eld.
Template Field Number (1-15)
Entry Prompt
Required Flag
Field Size
Format
Edit Indicator
Edit Range Start

R
R
R
R
R
R
O

Edit Range End

O
Entry Scripting
O
<TAB>
R
IF REQUEST TYPE = 3 (FIELD EDITS)

2/N
15 / A
1/A
2/N
1/A
1/A
8/A
8/A
220 / A
1/A

01 15
Yes / No
01 - 25
Numeric or Character
(D)ate/(R)ange/(T)able/(N)o Edit
Limited to 6 if Edit Indicator is
(R)ange, 8 if (D)ate.
See Above
Field Denition Delimiter

******Note, the following elds may be repeated up to a max 100 times, delimited by <TAB>.
Valid Response
Valid Response Description
<TAB>
End of Transaction

R
R
R
R

25 / A
30 / A
1/A
5/A

Field Edit Response Delimiter

<EOT>

9.3 File Layouts 83

Internet Connectivity API Transaction Set

Clubs API
The current Controller+ Base application supports Club Processing. During normal order entry, the system presents the operator with a screen of available Club offerings and benets that the
customer would derive from joining the Club. This API will allow for
a website to inquire on and retrieve information about the available
Club offering with regards to the customers current order. This will
provide the internet customer with a similar shopping presentation
about Club offering as that given from the Controller+. Each eld
in the request and response are separated by a UNIX pipe symbol
|.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Transaction Code
Transaction ID
Request Type

R
R
R

Field Format
Max Size / Format
Alphanumeric / Numeric
4/A
20 / A
1/A

26R
1 = Return Available Club
Offers

Refer to Format B, Import Third Party Orders layout for further details
on the remainder of elds to supply with transaction.
End Of Transaction

84

9.3 File Layouts

5/A

<EOT>

Internet Connectivity API Transaction Set

Controller+ Response Format

Field Description
Transaction Code
Transaction ID
Response Code
Request Type
<TAB>

(R)equired/
(O)ptional
R
R
R
R
R

4/A
20 / A
3/N
1/N
1/A

Field Format
Max Size / Format
Alphanumeric / Numeric
26A
1
Response Delimiter

IF REQUEST TYPE = 1 (FIELD DEFINITIONS)

******Note, the following elds may be repeated up to a max 50 times, delimited by tab. The series of
elds will be returned for each Available Club Offer.
Club ID
Club Description
Club Savings
Club Points Earned
Club Points Value
Club Price
Product Number
<TAB>

R
R
R
R
R
R
R
R

5/A
20/A
9/N
7/N
9/N
9/N
20/A
1/A

End Of Transaction

5/A

Assume 2 Decimal Positions

Assume 2 Decimal Positions
Assume 2 Decimal Positions
Field Denition Delimiter
<EOT>

9.3 File Layouts 85

Internet Connectivity API Transaction Set

++ Stored Value Card Balance Inquiry API

The Controller+ allows the acceptance of a stored value card as a
payment method. This API allows a website to inquire and retrieve a
cards remaining balance amount from an issued stored value card.
Each eld in the request and response are separated by a UNIX
pipe symbol |.
Controller+ Request Transaction

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Transaction Code
R
Transaction ID
R
Company Number
R
<TAB>
R
SVC Information repeats 15 times
SVC Number
O
SVC PIN
O
<TAB>
O

4/A
20 / A
2/N
<TAB>
20 / A
8/N
<TAB>

Tab Delimiter

End Of Transaction

5/A

<EOT>

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

Controller+ Response Format

Field Description

Transaction Code
R
Transaction ID
R
Response Code
R
Global Error Message
O
<TAB>
R
SVC Information repeats 15 times
SVC Response Code
O

27R

Tab Delimiter

4/A
20 / A
3/N
200 / A
<TAB>

27A

3/N

See Document

See Document
Tab Delimiter

++ = New in 9.3

86

9.3 File Layouts

Internet Connectivity API Transaction Set

Controller+ Response Format (cont.)

Field Description

(R)equired/
(O)ptional

Field Format
Max Size / Format
Alphanumeric / Numeric

SVC Error Message

SVC Amount
<TAB>
End of Transaction

O
O
O
R

200 / A
12 / N
<TAB>
<EOT>

Implied 2 decimals
Tab Delimiter

9.3 File Layouts 87

Internet Connectivity API Transaction Set

88

1Zip Code Look-up API

Error #

Error Description

101
102
103
104
105
106
107
297
861
900
901

Company number not supplied

Invalid company number supplied
Invalid transaction type supplied
Invalid transaction ID supplied
Zip code not supplied
Invalid zip code supplied
No zip codes found
Incomplete transmission received
Error writing to transaction log
File error encountered (1)
File error encountered (2)

2, 3, 4Catalog Request API

Error #

Error Description

114
118
158
163
170
171
195
196
201
207
208
209
210
211
212
214
216
217
222
223
224
225
226
227
228
229
230
235
237

Invalid catalog transaction code

Invalid email address format
Invalid company number supplied
Invalid transaction type supplied
Invalid transaction ID supplied
Incomplete transmission received
Customer number not added
3rd address line not allowed
Invalid zip code for state/country
Invalid state/country code
Required new address information not found
Invalid division code
Invalid order acquisition source
Invalid zip code for state
Invalid state code
3rd address line not allowed
There are no products ordered
Over license limits
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Invalid order release date
Missing held order reason
Pick date required with hold order reason
Invalid order ship by date
Missing ship charge amount
Customer A/R master read error on bill to ID
Customer number must be manually added
Weight ship charge invalid for ship to zip code

9.3 File Layouts

Internet Connectivity API Transaction Set

Catalog Request API (continued)

Error #
Error Description
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
265
266
267
268
269
270
271
272
273
274
350
357
358
360
361
362

Zip code not dened for UPS shipping method

Weight ship charge invalid for ship zip code
Orders shipped UPS international must use ship code 4
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Charge Card Transaction Limit Exceeded
Charge Card Transaction Limit Exceeded
Customer has not been found
There is address information not supplied
Customer name must be entered
Billing address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Customer name must be entered
Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid order method (P/M/F/I)
Invalid rush order YES OR NO
Invalid email conrm ag YES OR NO
No charge card supplied - reqd for credit predeposit
Bank number must be numeric
Invalid bank number
Bank number missing; reqd for elec. check processing
Acct number missing; reqd for elec. check processing
Deposit amount must be positive
Invalid order acquisition source
Catalog source has expired
Invalid shipping code
There is address information not supplied
Inventory record created
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Vertex geocode error
Vertex geocode error
Vertex geocode error

9.3 File Layouts 89

Internet Connectivity API Transaction Set

Catalog Request API (continued)

Error #
Error Description

90

363
364
401
402
864
882
883
884
885
898
907
927
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
967
968
982
983
994
990

Invalid county tax jurisdiction

Invalid county tax jurisdiction
Product price error
Gift Box product - not available on web
Error writing to transaction log
Error opening bad charge cards le (mibadcc)
Error opening customer titles le (micusttl)
Error opening zip zones le (miwgtzp)
Error opening order class le (miordcls)
Error opening pend order info le (mipndex)
File error encountered (7)
MICONV07 - ERROR OPENING MICOOMCD
Error writing to transaction log
MICONV07 - ERROR OPENING MICATHD
MICONV07 - ERROR OPENING MICHAIN
MICONV07 - ERROR OPENING MIINVMF
MICONV07 - ERROR OPENING MICUSTMF
MICONV07 - ERROR OPENING MICUSTYT
MICONV07 - ERROR OPENING MISMMF
MICONV07 - ERROR OPENING MIDSTOT
MICONV07 - ERROR OPENING MICATREQ
MICONV07 - ERROR OPENING MICOSSC
MICONV07 - ERROR OPENING MICATLN
MICONV07 - ERROR OPENING MISPCITM
MICONV07 - ERROR OPENING MICUSTES
MICONV07 - ERROR OPENING MICUSOD
MICONV07 - ERROR OPENING MIACT
MICONV07 - ERROR OPENING MIPCMF
MICONV07 - ERROR OPENING MIOPCNT
File open error (1)
File open error (2)
MICONV07 - ERROR OPENING MIPAYMF
MICONV07 - ERROR OPENING MIATR
Default salesman not dened
MICONV07 - ERROR OPENING MIGCMF

5Product Narrative API

Error #

Error Description

121
122
140
159
164
172

Invalid product number supplied

Invalid page number supplied
Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Incomplete transmission received

9.3 File Layouts

Internet Connectivity API Transaction Set

Product Narrative API (continued)

Error #
Error Description
190
600
851
853
902
942

Invalid transaction type

Product narrative not available
Error opening internet error log
Error opening le (2)
File error encountered (3)
Error writing to transaction log

6Product Availability API

Error #

Error Description

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
153
160
165
173
192
203
232
236
306
852
862
919
920
925
926
973
974

Invalid quantity ordered supplied

Invalid source code supplied
Source code entered is expired
Invalid ship to state supplied
Invalid ship to zip supplied
Invalid customer identication
Invalid shipping method for order
Can not ship USPS outside the US
Must use UPS next day service only
Must use UPS next day or 2nd day services ONLY
Must use UPS next day or ground service ONLY
Cannot ship Airborne to Canada
Airborne service available only in the 50 U.S. States
UPS 3-Day Select service valid only in the 50 US States
Cannot ship CTC outside the US
Invalid response type
Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Incomplete transmission received
Invalid product number supplied
Invalid product number supplied
This message is currently not in use
Invalid product number supplied
Fractional order quantity not allowed for this item
Error opening le (3)
Error writing to transaction log
File error encountered (1)
File error encountered (2)
File error encountered (3)
File error encountered (4)
File open error (5)
File open error (6)
9.3 File Layouts 91

Internet Connectivity API Transaction Set

7, 8, 9Ordering API
Error #
118
144
154
161
166
174
195
196
201
202
207
208
209
210
211
212
214
216
217
222
223
224
225
226
227
228
229
230
233
234
235
237
238
239
240
241
242
243
244
245
246
247
92

9.3 File Layouts

Error Description
Invalid email address format
Invalid order transaction code
Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Incomplete transmission received
Customer number not added
3rd address line not allowed
Invalid zip code for state/country
Real time defaults not setup
Invalid state/country code
Required new address information not found
Invalid division code
Invalid order acquisition source
Invalid zip code for state
Invalid state code
3rd address line not allowed
There are no products ordered
Over license limits
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Invalid order release date
Missing held order reason
Pick date required with hold order reason
Invalid order ship by date
Missing ship charge amount
Customer A/R master read error on bill to ID
Miscellaneous charge amount required when
description present
Miscellaneous charge description required when
amount present
Customer number must be manually added
Weight ship charge invalid for ship to zip code
Zip code not dened for UPS shipping method
Weight ship charge invalid for ship zip code
Orders shipped UPS international must use ship code 4
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Charge Card Transaction Limit Exceeded
Charge Card Transaction Limit Exceeded
Customer has not been found
There is address information not supplied

Internet Connectivity API Transaction Set

Ordering API (continued)

Error #

Error Description

248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
265
266
267
268
269
270
271
272
273
274
282
290
298
299
300
301
302
303
304
305
308
309
310
311
312
313
314
315
316

Customer name must be entered

Billing address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Customer name must be entered
Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid order method (P/M/F/I)
Invalid rush order YES OR NO
Invalid email conrm ag YES OR NO
No charge card supplied - reqd for credit predeposit
Bank number must be numeric
Invalid bank number
Bank number missing; reqd for elec. check processing
Acct number missing; reqd for elec. check processing
Deposit amount must be positive
Invalid order acquisition source
Catalog source has expired
Invalid shipping code
There is address information not supplied
<EOI> Terminator not supplied
Insufcient funds for collect up-front billing item(s)
Non-numeric pre-deposit amount
Non-numeric xed shipping amount
Non-numeric date ordered
Non-numeric charge expiration
Non-numeric pick date
Non-numeric ship-by date
Non-numeric ECP bank number
Non-numeric ECP deposit
Invalid ship method for international shipment
Invalid ship method for Puerto Rican shipment
Invalid ship method for Canadian shipment
Invalid ship method for APO/FPO shipment
Invalid ship method for US Territories shipment
Invalid ship method for Alaskan or Hawaiian shipment
Electronic check processing not allowed
Easy payments not allowed without credit or ECP information
Easy payments not allowed without credit card
9.3 File Layouts 93

Internet Connectivity API Transaction Set

Ordering API (continued)

Error #
318
319
320
321
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
357
358
360
361
362
363
364
365
366
372
373
375
385
386
387
388
389
94

9.3 File Layouts

Error Description
3POL credit card link card number error
3POL credit card link expiration date error
3POL credit card link cvv code error
3POL credit card link card type error
Invalid salesperson ID
Charge card authorization results Declined
Charge card authorization results Over Credit Limit
Charge card authorization results Call Center
Charge card authorization results Fraudulent Card
Charge card authorization results Expired Card
Charge card authorization results Invalid Data
Charge card authorization results CVV Decline
Charge card authorization results Resend
Items exist on order that are not allowed to ship COD
This order cannot be shipped COD
This order is over the allowed COD limit
Electronic Check Authorization results: Invalid MICR
Electronic Check Authorization results: Invalid Data
Electronic Check Authorization results: Declined
Electronic Check Authorization results: Scoring Declined
Electronic Check Authorization results: Resend
Total exceeds maximum allowed for an Electronic Check
Email Address is required for an Electronic Check
Phone Number is required for an Electronic Check
Check Number is required for an Electronic Check
Drivers License Number is required for an Electronic Check
Drivers License State is required for an Electronic Check
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Vertex geocode error
Vertex geocode error
Vertex geocode error
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Quantum geocode error
Quantum geocode error
Taxware zip verify error
Taxware zip verify error
Quantity ordered exceeds maximum order quantity
Telecheck Transactions Cannot
Be Processed Outside The U.S.
Bill-To Name Cannot Have More Than One (1) Comma (,)
Ship-To Name Cannot Have More Than One (1) Comma (,)
Bill-To Title Code is Invalid
Ship-To Title Code is Invalid

Internet Connectivity API Transaction Set

Ordering API (continued)

Error #

Error Description

390
391
392
393
394
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

COD Not Allowed For This Ship Method

Order Class Code Is Invalid
Invalid ship method for US
Ship methods ship charge table code invalid
Prepaid not allowed with electronic check
Free Shipping coupon not valid with Actual ship method
Invalid Discount amount
Multiple Tax Rate Selection
Product record not found
Product price error
Gift Box product - not available on web
Product supplied with no quantity
Product requires additional info
Gift certicate value less than $1.00
Exceeds allowable number of easy payments
Kit error found for part number
Kit component without kit header
Easy payments not allowed without credit or ECP info
Easy payments not allowed without credit card information
Club already on order
Current club unavailable for change
Clubs cannot be easy paid
Product cannot ship by this method
Product cannot be sold in this state
Ship to line address record not found
Line ship to name must be entered
Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid product number
Style masters are not allowed
Item not available for sale
This product is no longer available
Invalid sale code attached to this product
Invalid product number
Item ship to address not found
Price extension truncation error
Invalid ship method for international shipment
Invalid ship method for Puerto Rico shipment
At least one item with quantity must be supplied
Product supplied with no quantity
Invalid media code
Source code has expired
9.3 File Layouts 95

Internet Connectivity API Transaction Set

Ordering API (continued)

Error #
437
438
439
443
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
463
469
470
471
488
489
490
491
492
493
494
495
496
497
498
499
500
501
503
504
505
506
96

9.3 File Layouts

Error Description
Invalid media code
At least one item with quantity must be supplied
Product does not have current order date range
Fractional order quantity not allowed for this item
Origination code invalid; must be *C, D, F, P, S, U, blank*
Invalid ship method for Canadian shipment
Invalid ship method for APO/FPO shipment
Invalid ship method for US Territory shipment
Invalid ship method for Alaska or Hawaii shipment
Invalid ship method for US shipment
Limit of 98 Unique Ship-To Addresses Reached
Invalid Gift Certicate Number
Gift Certicate Unusable at this Time
Gift Certicate Already Redeemed
Authentication Code Required
Invalid Authentication Code
Gift Certicate Already Applied toThis Order
Club point redemption error
Manual coupon error
Computed coupon error
Unknown coupon error
Only a quantity of 1 allowed on clubs
Must order minimum quantity or a multiple
Multiple Tax Rate Selection
Do not sell before date error
Quantity Cannot be Greater Than 99 For Shipalone Products.
Customer Code Invalid
StandOrd Using a Tmplate May Not Accept Line Items from
Input
Invalid gift card and/or missing pin number
Reload gift card missing card number or pin number
Maximum quantity of 200 for a gift card
Reload gift card must have price
Reload gift card must have order quantity
Online gift card processor results: Invalid Gift Card Number
Online gift card processor results: Invalid PIN
Online gift card processor results: No Funds Available
Online gift card processor results: Communication Error
Online gift card processor results: Processing Error
Gift Card Errors Have Been Ecountered
Gift Card must have price > $1
Invalid service code
Service code taxable must be (Y)es or (N)o
Service code not allowed for drop ship items

Internet Connectivity API Transaction Set

Ordering API (continued)

Error #

Error Description

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
601
602
603
601
700
701
702
703
704
705
706
707
708
709
710
711
712
715
716
717
718
720
721
722
723
724

Service code not allowed for truck ship items

Service not allowed - must be dened on product
Invalid personalization template number
Required personalization eld missing
Invalid personalization gift card number
Personalization response not allowed by dirty word lter
Personalization response not allowed by restricted word
Personalization response is required
Invalid personalization table entry
Value does not t personalization range
This product may not be drop shipped
This product is not NLA
This product is not a Kit component R not allowed
Only status D, C, T, N, H, G, and R are valid
Total service amount exceeds 999.99
Invalid date for personalization
Line item services not allowed for this product
Weight ship charge invalid for ship to zip code
Invalid shipping code
MST: Vertex geocode error
MST: Invalid county tax jurisdiction
MST: Quantum geocode error
MST: Taxware zip verify error
StandOrd Using a Template Must Contain A Ship to Address
StandOrd Using a Template Must Contain a Bill to Address
Invalid Pay Method For Standing Order Using a Template
Invalid Standing Order Template Number
Enter Only an ExpDt or # Cycles to Expire
Invalid Initial Ship Method
Invalid Initial Ship Charge Type
Invalid Expiration Date
Invalid Number of Expiration Cycles
Invalid Hold Until Date
Invalid Days Between Orders
Standing Order Using a Template May Not Contain Line Items
Invalid Days Between Orders
Charge card authorization results: CVV Error
Invalid CVV presence indicator Must be a 2 or 9
CVV value required
Ship Complete must be Y, N, or B
Invalid Payment Method
Payment Method Additional Information required
BML authorization results: Declined
BML authorization results: Format error
BML authorization results: Commications error
9.3 File Layouts 97

Internet Connectivity API Transaction Set

98

Ordering API (continued)

Error #

Error Description

876
882
883
884
885
889
898
915
921
927
931
934
941
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
970
975
982
983
986
990
998

File Open Error - MIINETCFG

Error opening bad charge cards le (mibadcc)
Error opening customer titles le (micusttl)
Error opening zip zones le (miwgtzp)
Error opening order class le (miordcls)
Error opening services le
Error opening pend order info le (mipndex)
Error writing to transaction log
File error encountered (1)
MICONV07 - ERROR OPENING MICOOMCD
File error encountered (3)
File error encountered (4)
misys02 return code error: 1000
Error writing to transaction log
MICONV07 - ERROR OPENING MICATHD
MICONV07 - ERROR OPENING MICHAIN
MICONV07 - ERROR OPENING MIINVMF
MICONV07 - ERROR OPENING MICUSTMF
MICONV07 - ERROR OPENING MICUSTYT
MICONV07 - ERROR OPENING MISMMF
MICONV07 - ERROR OPENING MIDSTOT
MICONV07 - ERROR OPENING MICATREQ
MICONV07 - ERROR OPENING MICOSSC
MICONV07 - ERROR OPENING MICATLN
MICONV07 - ERROR OPENING MISPCITM
MICONV07 - ERROR OPENING MICUSTES
MICONV07 - ERROR OPENING MICUSOD
MICONV07 - ERROR OPENING MIACT
MICONV07 - ERROR OPENING MIPCMF
MICONV07 - ERROR OPENING MIOPCNT
File open error MIWGTZN
File open error (7)
MICONV07 - ERROR OPENING MIPAYMF
MICONV07 - ERROR OPENING MIATR
Error Opening MISCPOOL
MICONV07 - ERROR OPENING MIGCMF
Unknown error internal

9.3 File Layouts

Internet Connectivity API Transaction Set

10Customer Activity Summary API

Error #
Error Description
152
155
162
167
175
194
200
204
879
880
881
903
908
909
910
911
912
913
916
922
928
932
935
937
939
940

Requested activity not found

Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Incomplete transmission received
Invalid customer information found
Unable to locate customers daily activity record
Invalid customer identication
Error opening order line le (miorln)
Error opening invoice header le (miihd)
Error opening invoice lines le (miiln)
misys02 return code error: 1000
File error encountered (8)
File error encountered (9)
File error encountered (10)
File error encountered (11)
File error encountered (12)
File error encountered (13)
Error writing to transaction log
File error encountered (1)
File error encountered (2)
File error encountered (3)
File error encountered (4)
File error encountered (5)
File error encountered (6)
File error encountered (7)

11Customer Activity Detail API

Error #
Error Description
123
156
157
168
169
176
193
205
206
213
279
280
866
899

Requested activity not found

Company number not supplied
Customer return not found
Invalid transaction type supplied
Invalid transaction type supplied
Incomplete transmission received
Invalid customer identication
Invalid customer identication
Invalid customer identication
Requested activity not found
Invalid order number for customer
Invalid return number for customer
misys02 return code error
File Write Error (19)
9.3 File Layouts 99

Internet Connectivity API Transaction Set

11Customer Activity Detail API (continued)

Error #
Error Description

100

917
918
923
924
929
930
933
936
938
991
992

Error writing to transaction log

File error encountered (15)
File error encountered (1)
File error encountered (16)
File error encountered (2)
File error encountered (17)
File error encountered (3)
File error encountered (4)
File error encountered (5)
File error encountered (18)
File error encountered (19)

12Inbound Heartbeat API

Error #

Error Description

151
275
960
961
962

Invalid transaction ID
Incomplete transmission
ERROR WRITING TO TRANSACTION LOG
milock return code error: 1000
File open error (1)

13Outbound Heartbeat API

Error #

Error Description

276
963
964

Incomplete transmission
ERROR WRITING TO TRANSACTION LOG
milock return code error: 1000

14Product Lister API

Error #
112
119
141
142
143
145
146
147
148
149
150
177

Error Description
Invalid source code
Invalid free items table code
Invalid free items table code
Invalid source code
Invalid KOTF category
Kit denition missing
Product is not a kit
Invalid customer ID
Invalid customer ID
Invalid product number supplied
Product number not supplied
Invalid company number

9.3 File Layouts

Internet Connectivity API Transaction Set

Product Lister API (continued)

Error #

Error Description

178
179
191
277
351
352
353
354
355
356
359
367
368
369
713
714
370
867
966
967
968
971
973
974
975
976
977
978
979
980
981
984
985

Company number not supplied

Invalid transaction type
Invalid transaction ID
Incomplete transmission
No cross sell products
No upsell products
No free products available
No promotional products
No special of the day products
No substitute products
No state codes are available
No territory codes are available
No Canadian province codes are available
No international country codes are available
Product is not a gift box
Gift box denition is missing
No payment method codes are available
misys02 return code error
ERROR WRITING TO TRANSACTION LOG
File open error (1)
File open error (2)
File open error (3)
File open error (5)
File open error (6)
File open error (7)
File open error (8)
File open error (9)
File open error (10)
File open error (11)
File open error (12)
File open error (13)
Error Opening MICPRC
Error Opening MICPRCLN

15Customer Authentication API

Error #
118
180
181
182
183
184

Error Description
Invalid email address format
New city name not supplied
New street name not supplied
New name not supplied
Email address not supplied
City name not supplied

9.3 File Layouts 101

Internet Connectivity API Transaction Set

Customer Authentication API (continued)

102

Error #

Error Description

185
186
187
188
189
195
196
201
207
208
209
210
211
212
214
216
217
222
223
224
225
226
227
228
229
230
235
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

Street name not supplied

Name not supplied
Invalid transaction ID
Invalid company number
Company number not supplied
Customer number not added
3rd address line not allowed
Invalid zip code for state/country
Invalid state/country code
Required new address information not found
Invalid division code
Invalid order acquisition source
Invalid zip code for state
Invalid state code
3rd address line not allowed
There are no products ordered
Over license limits
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Invalid order release date
Missing held order reason
Pick date required with hold order reason
Invalid order ship by date
Missing ship charge amount
Customer A/R master read error on bill to ID
Customer number must be manually added
Weight ship charge invalid for ship to zip code
Zip code not dened for UPS shipping method
Weight ship charge invalid for ship zip code
Orders shipped UPS international must use ship code 4
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Charge Card Transaction Limit Exceeded
Charge Card Transaction Limit Exceeded
Customer has not been found
There is address information not supplied
Customer name must be entered
Billing address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state

9.3 File Layouts

Internet Connectivity API Transaction Set

Customer Authentication API (continued)

Error #

Error Description

254
255
256
257
258
259
260
261
262
265
266
267
268
269
270
271
272
273
274
281
282
350
357
358
360
361
362
363
364
401
402
865
882
883
884
885
898
914
927
943
944
945
946
947

Customer name must be entered

Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid order method (P/M/F/I)
Invalid rush order YES OR NO
Invalid email conrm ag YES OR NO
No charge card supplied - reqd for credit predeposit
Bank number must be numeric
Invalid bank number
Bank number missing; reqd for elec. check processing
Acct number missing; reqd for elec. check processing
Deposit amount must be positive
Invalid order acquisition source
Catalog source has expired
Invalid shipping code
There is address information not supplied
Incomplete transmission
<EOI> Terminator not supplied
Inventory record created
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Vertex geocode error
Vertex geocode error
Vertex geocode error
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Product price error
Gift Box product - not available on web
misys02 return code error
Error opening bad charge cards le (mibadcc)
Error opening customer titles le (micusttl)
Error opening zip zones le (miwgtzp)
Error opening order class le (miordcls)
Error opening pend order info le (mipndex)
Error writing to transaction log
MICONV07 - ERROR OPENING MICOOMCD
Error writing to transaction log
MICONV07 - ERROR OPENING MICATHD
MICONV07 - ERROR OPENING MICHAIN
MICONV07 - ERROR OPENING MIINVMF
MICONV07 - ERROR OPENING MICUSTMF
9.3 File Layouts 103

Internet Connectivity API Transaction Set

Customer Authentication API (continued)

Error #

Error Description

948
949
950
951
952
953
954
955
956
957
958
959
967
968
969
971
973
974
982
983

MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
MICONV07 - ERROR
File open error (1)
File open error (2)
File open error (4)
File open error (3)
File open error (5)
File open error (6)
MICONV07 - ERROR
MICONV07 - ERROR

OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING
OPENING

MICUSTYT
MISMMF
MIDSTOT
MICATREQ
MICOSSC
MICATLN
MISPCITM
MICUSTES
MICUSOD
MIACT
MIPCMF
MIOPCNT

OPENING MIPAYMF
OPENING MIATR

16Factory Order Update API

104

Error #

Error Description

108
109
110
111
113
115
116
117
120
197
198
199
215
218
219
220
221
264

Invalid transaction type supplied

Incomplete transmission received
Company number not supplied
No factory orders in the batch were updated
Must supply either batch or order, Not Both
Factory order number must be numeric
Factory batch number must be numeric
Date conrmed or date canceled must be supplied, not both
Must enter factory order or batch
Supplier ID not found in database
Factory order not found in database
Factory order batch not found in database
Factory order is not for the specied supplier
Invalid cancellation date supplied
Invalid shipment conrmation date supplied
Invalid order acknowledge date supplied
Invalid date scheduled to ship supplied
Unit cost supplied is out of range

9.3 File Layouts

Internet Connectivity API Transaction Set

16Factory Order Update API (continued)

Error #

Error Description

283
284
289
307
466
467
468
904
905
906
969
993

Additional cost supplied is out of range

Factory order has already been posted
Cannot process Batch Factory Orders Tracking numbers
Factory orders must be batched prior to assigning dates
Quantity to be Conrmed exceeds Quantity Ordered
Can Not Cancel a Fully Conrmed Dropship
Invalid ship method on Factory Order
File Open Error (1)
File Open Error (2)
File Open Error (3)
File Open Error (4)
File Rewrite Error (18)

17Customer Update API

Error #

Error Description

285
286
287
288
291
346
347
348
349
371
380
381
382
383
384
395
396
719
854
855
856
857
858
859
860
863
868

Incomplete transmission received

Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Invalid customer ID
Do Not Mail Flag must be Y or N
Do Not Email Flag must be Y or N
Do Not Rent Flag must be Y or N
Do Not Phone Flag must be Y or N
System currently unavailable to update information
Email Promo Flag must be Y or N
Phone Number 1 Is Required
Phone Number 2 Is Required
Both Phone 1 and Phone 2 are Required
Either Phone 1 or Phone 2 is Required
Invalid title code
Title code required
Invalid Commerical/Residential Indicator
Error storing customer update
File copyopen error (1)
File copyopen error (2)
misys02 return code error
File copyopen error (3)
File copyopen error (4)
File copyopen error (5)
Error writing to transaction log
File open error encountered (1)
9.3 File Layouts 105

Internet Connectivity API Transaction Set

17Customer Update API (continued)

Error #

Error Description

869
870
871
872
873
874
882
884
911

File open error encountered (2)

File open error encountered (3)
File open error encountered (4)
File open error encountered (5)
File open error encountered (34)
File open error encountered (6)
Error opening bad charge cards le (mibadcc)
Error opening zip zones le (miwgtzp)
File error encountered (11)

18Company Settings Inquiry API

Error #

Error Description

292
293
294
295
296
875
877
878

Incomplete transmission received

Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Invalid transaction ID supplied
Error writing to internet transaction log (miinetlog)
Error opening internet directory (/data/miinetdir)
Error opening internet transaction log le (miinetlog)

19Product Database Sync API

Error #

Error Description

374

Invalid web data sync mode

20Gift Certicate and Coupon Validation API

106

Error #

Error Description

147
163
292
293
294
295
452
453
454
455

Invalid customer ID
Invalid transaction type supplied
Incomplete transmission received
Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Invalid gift certicate number
Gift certicate unusable at this time
Gift certicate already redeemed
Authentication code required

9.3 File Layouts

Internet Connectivity API Transaction Set

20Gift Certicate and Coupon Validation API (continued)

Error #

Error Description

456
457
460
461
472
473
474
875
878
958
990

Invalid authentication code

Gift certicate already applied to this order
Computed coupon error
Unknown coupon error
Coupon errors have been encountered
Gift certicate errors have been encountered
Invalid gift certicate/coupon API transaction mode
Error writing to internet transaction log (miinetlog)
Error opening internet transaction log le (miinetlog)
MICONV07 - ERROR OPENING MIPCMF
MICONV07 - ERROR OPENING MIGCMF

21Demographics Denitions API

No error messages have currently been established for this api.
22Demographics Inquiry API
Error #

Error Description

919
920
925

File error encountered (1)

File error encountered (2)
File error encountered (3)

23, 24Demographics Update API

Error #

Error Description

475
476
477
478
479
480

Invalid demographic eld number

Demographic eld is required
Date must be in MMDDCCYY format
The demographic value supplied does not t the range
Demographic table edit dened but no value exists
Demographic value does not match table denition

9.3 File Layouts 107

Internet Connectivity API Transaction Set

25Advanced Personalization API

Error #

Error Description

483

Advanced personalization
numeric
Advanced personalization
must be numeric
Advanced personalization
Advanced personalization
supplied
Advanced personalization

484
485
486
487

template number must be

template eld number
template number not supplied
template eld number not
template not found

26Clubs API

108

Error #

Error Description

118
144
154
161
166
174
195
196
201
202
207
208
209
210
211
212
214
216
217
222
223
224
225
226
227
228
229
230

Invalid email address format

Invalid order transaction code
Company number not supplied
Invalid company number supplied
Invalid transaction type supplied
Incomplete transmission received
Customer number not added
3rd address line not allowed
Invalid zip code for state/country
Real time defaults not setup
Invalid state/country code
Required new address information not found
Invalid division code
Invalid order acquisition source
Invalid zip code for state
Invalid state code
3rd address line not allowed
There are no products ordered
Over license limits
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Invalid order release date
Missing held order reason
Pick date required with hold order reason
Invalid order ship by date
Missing ship charge amount
Customer A/R master read error on bill to ID

9.3 File Layouts

Internet Connectivity API Transaction Set

26Clubs API (continued)

Error #

Error Description

233

Miscellaneous charge amount required when

description present
Miscellaneous charge description required when
amount present
Customer number must be manually added
Weight ship charge invalid for ship to zip code
Zip code not dened for UPS shipping method
Weight ship charge invalid for ship zip code
Orders shipped UPS international must use ship code 4
A net computation error has occurred
A tax computation error has occurred
A shipping computation error has occurred
Charge Card Transaction Limit Exceeded
Charge Card Transaction Limit Exceeded
Customer has not been found
There is address information not supplied
Customer name must be entered
Billing address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Customer name must be entered
Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid order method (P/M/F/I)
Invalid rush order YES OR NO
Invalid email conrm ag YES OR NO
No charge card supplied - reqd for credit predeposit
Bank number must be numeric
Invalid bank number
Bank number missing; reqd for elec. check processing
Acct number missing; reqd for elec. check processing
Deposit amount must be positive
Invalid order acquisition source
Catalog source has expired
Invalid shipping code
There is address information not supplied
<EOI> Terminator not supplied
Insufcient funds for collect up-front billing item(s)

234
235
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
265
266
267
268
269
270
271
272
273
274
282
290

9.3 File Layouts 109

Internet Connectivity API Transaction Set

26Clubs API (continued)

Error #

Error Description

298
299
300
301
302
303
304
305
308
309
310
311
312
313
314
315

Non-numeric pre-deposit amount

Non-numeric xed shipping amount
Non-numeric date ordered
Non-numeric charge expiration
Non-numeric pick date
Non-numeric ship-by date
Non-numeric ECP bank number
Non-numeric ECP deposit
Invalid ship method for international shipment
Invalid ship method for Puerto Rican shipment
Invalid ship method for Canadian shipment
Invalid ship method for APO/FPO shipment
Invalid ship method for US Territories shipment
Invalid ship method for Alaskan or Hawaiian shipment
Electronic check processing not allowed
Easy payments not allowed without credit or ECP
information
Easy payments not allowed without credit card
3POL credit card link card number error
3POL credit card link expiration date error
3POL credit card link cvv code error
3POL credit card link card type error
Invalid salesperson ID
Charge card authorization results Declined
Charge card authorization results Over Credit Limit
Charge card authorization results Call Center
Charge card authorization results Fraudulent Card
Charge card authorization results Expired Card
Charge card authorization results Invalid Data
Charge card authorization results CVV Decline
Charge card authorization results Resend
Items exist on order that are not allowed to ship COD
This order cannot be shipped COD
This order is over the allowed COD limit
Electronic Check Authorization results: Invalid MICR
Electronic Check Authorization results: Invalid Data
Electronic Check Authorization results: Declined
Electronic Check Authorization results: Scoring Declined
Electronic Check Authorization results: Resend
Total exceeds maximum allowed for an Electronic Check
Email Address is required for an Electronic Check
Phone Number is required for an Electronic Check
Check Number is required for an Electronic Check

316
318
319
320
321
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343

110

9.3 File Layouts

Internet Connectivity API Transaction Set

26Clubs API (continued)

Error #

Error Description

344

Drivers License Number is required for an Electronic

Check
Drivers License State is required for an Electronic Check
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Vertex geocode error
Vertex geocode error
Vertex geocode error
Invalid county tax jurisdiction
Invalid county tax jurisdiction
Quantum geocode error
Quantum geocode error
Taxware zip verify error
Taxware zip verify error
Quantity ordered exceeds maximum order quantity
Telecheck Transactions Cannot
Be Processed Outside The U.S.
Bill-To Name Cannot Have More Than One (1) Comma (,)
Ship-To Name Cannot Have More Than One (1) Comma (,)
Bill-To Title Code is Invalid
Ship-To Title Code is Invalid
COD Not Allowed For This Ship Method
Order Class Code Is Invalid
Invalid ship method for US
Ship methods ship charge table code invalid
Prepaid not allowed with electronic check
Free Shipping coupon not valid with Actual ship method
Invalid Discount amount
Multiple Tax Rate Selection
Product record not found
Product price error
Gift Box product - not available on web
Product supplied with no quantity
Product requires additional info
Gift certicate value less than $1.00
Exceeds allowable number of easy payments
Kit error found for part number
Kit component without kit header
Easy payments not allowed without credit or ECP info
Easy payments not allowed without credit card information
Club already on order
Current club unavailable for change
Clubs cannot be easy paid
Product cannot ship by this method

345
357
358
360
361
362
363
364
365
366
372
373
375
385
386
387
388
389
390
391
392
393
394
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414

9.3 File Layouts 111

Internet Connectivity API Transaction Set

26Clubs API (continued)

112

Error #

Error Description

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
443
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460

Product cannot be sold in this state

Ship to line address record not found
Line ship to name must be entered
Shipping address must be entered
There is address information not supplied
3rd address line not allowed
Invalid state code
Invalid zip code for state
Invalid product number
Style masters are not allowed
Item not available for sale
This product is no longer available
Invalid sale code attached to this product
Invalid product number
Item ship to address not found
Price extension truncation error
Invalid ship method for international shipment
Invalid ship method for Puerto Rico shipment
At least one item with quantity must be supplied
Product supplied with no quantity
Invalid media code
Source code has expired
Invalid media code
At least one item with quantity must be supplied
Product does not have current order date range
Fractional order quantity not allowed for this item
Origination code invalid; must be *C, D, F, P, S, U, blank*
Invalid ship method for Canadian shipment
Invalid ship method for APO/FPO shipment
Invalid ship method for US Territory shipment
Invalid ship method for Alaska or Hawaii shipment
Invalid ship method for US shipment
Limit of 98 Unique Ship-To Addresses Reached
Invalid Gift Certicate Number
Gift Certicate Unusable at this Time
Gift Certicate Already Redeemed
Authentication Code Required
Invalid Authentication Code
Gift Certicate Already Applied to This Order
Club point redemption error
Manual coupon error
Computed coupon error

9.3 File Layouts

Internet Connectivity API Transaction Set

26Clubs API (continued)

Error #

Error Description

461
463
469
470
471
488
489
601
602
603
601
715
716
717
718
722
723
724
876
882
883
884
885
889
915
921
927
931
934
941
943
944
945
946
947
948
949
950
951
952
953

Unknown coupon error

Only a quantity of 1 allowed on clubs
Must order minimum quantity or a multiple
Multiple Tax Rate Selection
Do not sell before date
Quantity Cannot be Greater Than 99 For Shipalone Products.
Customer Code Invalid
MST: Vertex geocode error
MST: Invalid county tax jurisdiction
MST: Quantum geocode error
MST: Taxware zip verify error
Charge card authorization results: CVV Error
Invalid CVV presence indicator Must be a 2 or 9
CVV value required
Ship Complete must be Y, N, or B
BML authorization results: Declined
BML authorization results: Format error
BML authorization results: Commications error
File Open Error - MIINETCFG
Error opening bad charge cards le (mibadcc)
Error opening customer titles le (micusttl)
Error opening zip zones le (miwgtzp)
Error opening order class le (miordcls)
Error opening services le
Error writing to transaction log
File error encountered (1)
MICONV07 - ERROR OPENING MICOOMCD
File error encountered (3)
File error encountered (4)
misys02 return code error: 1000
Error writing to transaction log
MICONV07 - ERROR OPENING MICATHD
MICONV07 - ERROR OPENING MICHAIN
MICONV07 - ERROR OPENING MIINVMF
MICONV07 - ERROR OPENING MICUSTMF
MICONV07 - ERROR OPENING MICUSTYT
MICONV07 - ERROR OPENING MISMMF
MICONV07 - ERROR OPENING MIDSTOT
MICONV07 - ERROR OPENING MICATREQ
MICONV07 - ERROR OPENING MICOSSC
MICONV07 - ERROR OPENING MICATLN

9.3 File Layouts 113

Internet Connectivity API Transaction Set

26Clubs API (continued)

Error #

Error Description

954
955
956
957
958
959
970
982
983
990
998

MICONV07 - ERROR OPENING

MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
File open error MIWGTZN
MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
MICONV07 - ERROR OPENING
Unknown error internal

MISPCITM
MICUSTES
MICUSOD
MIACT
MIPCMF
MIOPCNT
MIPAYF
MIATR
MIGCMF

++ 27Stored Value Card Balance Inquiry

Error #

Error Description

491
492
493
494
495
496
497
498
499
500
501
503

Invalid gift card and/or missing pin number

Reload gift card missing card number or pin number
Maximum quantity of 200 for a gift card
Reload gift card must have price
Reload gift card must have order quantity
Online gift card processor results: Invalid Gift Card Number
Online gift card processor results: Invalid PIN
Online gift card processor results: No Funds Available
Online gift card processor results: Communication Error
Online gift card processor results: Processing Error
Gift Card Errors Have Been Ecountered
Gift Card must have price > $1

++ = New in 9.3
114

9.3 File Layouts

Internet Connectivity API Transaction Set

Response Codes
All API responses will include a response code. Refer to the following to determine the descriptive reason associated with each response code.
Applicable To All Transactions
000 001 030 -

Request Successful
Invalid Transaction Code
Company Number Not Supplied

Applicable To Selected Transactions

The previous pages contain an expanded table of error message codes specic
to individual transactions. Please refer to this table for information regarding
errors in API responses.

9.3 File Layouts 115