developer:soap-1.6:objects:lineitem

Soap API v1.6

LineItem

Contains elements needed for line item data.

Description

Merchants can pass information about the individual line items that make up an order. This data is visible on the transaction details page. Up to 100 lines may be stored per transaction.

All fields must be passed, but may be left blank if not applicable.

Properties

Type Name Description
string ProductRefNum Unique ID of the product assigned by the gateway (Optional)
string SKU A stock-keeping unit is a unique identifier for each distinct product and service that can be purchased
string ProductName Name of the product
string Description Description of product or purchase
string UnitPrice Individual price of the unit
string Qty Total number of items
boolean Taxable Taxable good flag
string CommodityCode Numeric code used to classify the good or service. See the UNSPSC for codes. (Level 3)
string UnitOfMeasure Unit that quantity is measuring. Defaults to “EA”. See list of valid Unit of Measure Codes (Level 3)
string DiscountAmount Amount line item was discounted (Level 3)
string DiscountRate The rate used to calculate discount (Level 3)
string TaxAmount Tax charged for this line item (Level 3)
string TaxRate The tax rate used for this line item (Level 3)

The properties noted as “Level 3” are only necessary if merchant is processing level 3 data for business or corporate purchasing cards.

Places Used

Examples

.NET VB

               Dim line as usaepay.LineItem = new usaepay.Lineitem
               line.SKU = "123456"
               line.ProductRefNum = "90476"	
               line.ProductName = "QuickBook" 	
               line.Description = "test" 	
               line.UnitPrice = "100"
               line.Qty = "5"

.NET C#

               usaepay.LineItem line = new usaepay.Lineitem();
               line.SKU = "123456";
               line.ProductRefNum = "90476";	
               line.ProductName = "QuickBook"; 	
               line.Description = "test"; 	
               line.UnitPrice = "100"; 
               line.Qty = "5"; 	 

Change History

Version Change
1.3 Method added prior to soap-1.3
1.6 added parameters CommodityCode, DiscountAmount, DiscountRate, UnitOfMeasure, UnitPrice, TaxAmount, TaxRate
developer/soap-1.6/objects/lineitem.txt · Last modified: 2012/11/19 10:11 by tem

Page Tools