Based on their respective business requirements, merchants can choose to submit itemized order information with a transaction. Itemized order information is not submitted to the processor and is not currently returned with the transaction response. This information is displayed on the Transaction Detail page and in QuickBooks download file reports in the Merchant Interface.
Note: The value for the x_line_item field is capable of including delimited item information. In this case, line item values must be included in the order listed below.
Fields are name/value pairs with the syntax:
x_name_of_field = value of the field&.
|
FIELD NAME |
REQUIRED? |
VALUE |
FORMAT |
NOTES |
|
x_line_item |
Optional |
Any string |
Line item values must be delimited by a bracketed pipe <|> |
Itemized order information. |
|
Item ID<|> |
Up to 31 characters |
The ID assigned to an item. |
||
|
<|>item name<|> |
Up to 31 characters |
A short description of an item. |
||
|
<|>item description<|> |
Up to 255 characters |
A detailed description of an item. |
||
|
<|>itemX quantity<|> |
Up to two decimal places
Must be a positive number |
The quantity of an item. |
||
|
<|>item price (unit cost)<|> |
Up to two decimal places
Must be a positive number |
Cost of an item per unit, excluding tax, freight, and duty.
The dollar sign ($) is not allowed when submitting delimited information. |
||
|
<|>itemX taxable |
TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0 |
Indicates whether the item is subject to tax. |
The merchant can submit up to 30 distinct line items containing itemized order information per transaction. For example:
Sample code for submitting itemized order information
x_line_item=item1<|>golf balls<|><|>2<|>18.95<|>Y&x_line_item=
item2<|>golf bag<|>Wilson golf carry bag, red<|>1<|>39.99<|>Y&
x_line_item=item3<|>book<|>Golf for Dummies<|>1<|>21.99<|>Y&
Note: For Prior Authorization and Capture transactions, if line item information was submitted with the original transaction, adjusted information can be submitted if the transaction changed. If no adjusted line item information is submitted, the information submitted with the original transaction will apply.