Home >	Contents >	Index >

AssetMaker   |    Cart Tags   |    Errors   |    Miscellany   |    Index

Order Item Parameters: Introduction

This section describes the order item parameters in your shopping cart. An order item holds information about one item to be purchased. Order item parameters describe the characteristics of a single order item.

All order item parameters fall into one of these categories:

• Required, which you must set.

• Optional, which you may or may not set, but might provide additional useful information to Transact.

Names are case-sensitive. Values, including numeric quantities, are strings for both input and output.

Note The Transact Order Entry API (OEAPI) documentation uses the term attribute when referring to a shopping cart argument. This document uses the term parameter instead to avoid confusion with an attribute, which is an asset that describes other assets in the catalog.

To set a parameter, call CART.SETITEMPARAMETERS.

To get the value of a single parameter, call CART.GETITEMPARAMETER. To get the values of a list of parameters, call CART.GETITEMPARAMETERS.

For more information about shopping cart parameters, see Chapter 16, "CS-Direct Advantage Cart Parameters."

We organized the parameters by function:

• General Parameters

• Product Description Parameters

• Delivery Parameters

• Cost and Payment Parameters

• Subscription Parameters

• Tax Parameters

• Custom Field Parameters

Each table contains the following four columns:

Name - Name of the parameter.

Description - A brief description of the parameter. More detailed explanations of the parameters follow each table.

Value Range - Range of values for the parameter.

Constraints - One of the following:

• Required: You must specify a value for this parameter.

• Required if: You must specify a value if the stated condition is true.

• OK if: You may specify a value only if the stated condition is true.

• Prohibited if: You cannot specify a value if the other specified parameter has the specified value.

• Mutually Exclusive: You cannot specify a value if the other specified parameter has any value.

• Default: The default value if you do not specify a value.

General Parameters

The following table summarizes general order item parameters:

Name	Description	Value Range	Constraints
AccountRequired	Transact account required?	0 = no; 1 = yes	Default: 0
		1 = yes	Required if Subscription = 1
CodeSet	The character set used in the following fields: ClassID Detail Name UniqueID	String. The preferred MIME name specified in the IANA character sets registry.	Default: Latin1
OfferURL	URL of the Web page or CGI script containing the digital offer; used as a link from the order form. This is the value in the Continue Shopping or Return to Store button.	Absolute or partial URL	Required

Product Description Parameters

The following table summarizes the parameters that describe products for sale:

Name	Description	Value Range	Constraints
Detail	Descriptive information; reported on seller's Smart Statement	Alphanumeric	Mutually exclusive: Subscription = 1
Name	Product name or description, reported on the Transact order form page and the Transact smart receipt	Alphanumeric	Required
Type	Type of product being offered or function being performed	online, service, or tangible	Required
UniqueID	Unique product/coupon identification code (for example, model number, SKU, etc.)	Alphanumeric; up to 40 characters	Required

 

Delivery Parameters

The following table summarizes the parameters that determine how physical goods, digital goods and digital subscriptions are delivered to buyers:

Name	Description	Value Range	Constraints
DeliveryMechanism	The method used for delivery of a digital good or subscription. Controls the presentation on the receipt page.	online or download	OK if Type = online Prohibited if Type != online
FulfillmentURL	Location (URL) of the digital good or subscription content.	Absolute or partial URL	Required if Type = online, credit, or micro Prohibited if Type = tangible, coupon, or none
ReceiptDuration	Time in seconds that the customer has to access a subscription or digital good from the time the digital receipt is created.	Integer; 1 or greater	Default: 30*24*60*60 seconds (30 days) Prohibited if Type = tangible, coupon, or none

 

Cost and Payment Parameters

The following table summarizes the parameters that determine the cost of goods and methods of payment:

Name	Description	Value Range	Constraints
AllowPaymentBrands	List of payment brands that can be used with this offer or coupon	Transact and store dependent; set to Demo to test stores	Prohibited if Type = micro or none
ExcludePaymentBrands	List of payment brands that cannot be used with this offer or coupon.	Transact and store dependent	Prohibited if Type = micro or none
ShippingCharge	Fixed shipping charge for the product	Money amount: numerals with optional decimal point, no currency symbol, no commas; example: 6.95	OK if Type = tangible
ShippingWeight	Product weight for computing a shipping charge	Integer, 0 or higher; units specified during store registration	OK if Type = tangible

 

Subscription Parameters

The following table summarizes the parameters for digital subscriptions:

Name	Description	Value Range	Constraints
AutoRenew	Subscription is automatically renewed when it expires	0 = no 1 = yes	OK if Subscription = 1 Default: 0
GracePeriod	Days before billing is performed for each billing cycle	Integer; 1 or greater	OK if Subscription = 1 Default: 0
InstallmentCount	Number of payments	Integer; 1 or greater	OK if Subscription = 1; Mutually Exclusive: AutoRenew = 1 Default: 1
InstallmentPeriod	Number of months between payments	Integer; 1 or greater	OK if InstallmentCount >= 2
RefundPolicy	Subscription refund policy	none prorate full	OK if Subscription = 1 Default: none
Subscription	Digital good is a subscription	0 = no 1 = yes	OK if Type = online Prohibited if Type != online Default: 0
SubscriptionDuration	Length of a subscription in months	Integer: 1 or greater	Required if: Subscription = 1 Prohibited if: Subscription = 0
TrialPeriod	Period before billing begins	Positive integer followed by d|w|m (days, weeks, months); example: 2w (two weeks)	OK if Subscription=1 Default: 0d (zero days)

 

Tax Parameters

The following table summarizes the parameters that control taxation of goods:

Name	Description	Value Range	Constraints
TaxClass	Product classification code used for sales tax/use tax calculation	TAXWARE product code (five-digit integer)	Prohibited if Type = coupon or none
VatFlag	Does price include VAT (value added tax)?	0 is yes 1 is no 2 is VAT exempt	Required if seller specifies a tax mode of VAT during store registration Prohibited if Type = coupon or none
VatRate	VAT rate charged for the item	A decimal number >= 0.0	Required if VatFlag = 0 or VatFlag = 1 Prohibited if Type = coupon or none

 

Custom Field Parameters

The following table summarizes the custom parameters:

Name	Description	Value Range	Constraints
CF__fieldname	Optional custom field	string starting with CF_ _ (note double underscore)	Prohibited if Type = none or micro
CF_R_fieldname	Required custom field	string starting with CF_R_	Prohibited if Type = none or micro

 

		Home >	Contents >	Index >
	FatWire Miscellaneous Reference Copyright 2005 by FatWire Software All rights reserved.