orderitem

This topic applies to

Applies to

SuiteCommerce Web Stores

The orderitem object is a subtype of item.

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

amount

string

Currency amount for items

yes

no

amount_formatted

string

Amount formatted with currency symbol

yes

no

internalid

string

Internal ID for item

Unique identifier that should be used when adding an item to the cart

yes

yes (reqd)

name

string

Display name

yes

no

options

JSON object

List of name/value pairs

yes

yes

orderitemid

string

Unique ID for an item in an order

yes

yes

promotionamount

string

Amount after any line-level discounts

yes

no

promotionamount_
formatted

string

Amount after any line-level discounts formatted with currency symbol

yes

no

promotiondiscount

string

Amount of discount related to promotions

yes

no

promotiondiscount_formatted

string

Amount of discount related to promotions formatted with currency symbol

yes

no

quantity

string

Number of items in order

yes

yes

rateschedule

string

Price schedule for quantity pricing

yes

no

shipaddress

string

ID of shipping address for item

yes

yes

shipcarrier

string

Shipping carrier

Note

Valid values that can be set for shipcarrier are ups or noups.


yes

no

shipmethod

JSON object of type shipmethod

ID of shipping method for item

Used when the Multiple Shipping Routes feature is enabled

yes

yes

taxtype1

string

Type of the item tax. For example, GST/VAT/WET

yes

no

taxrate1

string

Rate of the tax in percentage

yes

no

taxtype2

string

For Canada only. Currently returns PST.

yes

no

taxrate2

string

For Canada only. The rate of PST tax in percentage when applicable

yes

no

tax1amt

string

The total tax amount for the line item.

yes

no

fulfillmentPreferences

JSON object of type fulfillmentPreferences

Fulfillment preference for item

yes

no

discounts_impact

JSON object of type discounts_impact

Per line discount impact for the line item.

yes

no

Working with Taxes

In the United States, per item taxes are not applied to an order. Instead tax is applied to the entire order. The following tax fields are only used when countries require per line tax:

  • taxtype1

  • taxrate1

  • taxtype2

  • taxrate2

Since every line can have a different tax type or tax rate you should define the taxes per order line. When a line is not taxed, omit those fields.

Note

You should also check the value of pricesincludevat in the sitesettings object to verify whether taxes are included in the price. These fields are only required when tax is not included in the price.