orderitem
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 |
|
string |
Amount after any line-level discounts formatted with currency symbol |
yes |
no |
promotiondiscount |
string |
Amount of discount related to promotions |
yes |
no |
p |
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 |
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 |
taxamount |
string |
The total tax amount for the line item. Applicable only for tax calculations using SuiteTax. Tax calculation using SuiteTax is available only for US and Canada. |
yes |
no |
taxdetailsreference |
string |
The ID that links the tax details returned by Applicable only for tax calculations using SuiteTax. Tax calculation using SuiteTax is available only for US and Canada. |
yes |
no |
taxtype1 |
string |
Type of the item tax. For example, GST/VAT/WET. Not applicable if SuiteTax is enabled. |
yes |
no |
taxrate1 |
string |
Rate of the tax in percentage. Not applicable if SuiteTax is enabled. |
yes |
no |
taxtype2 |
string |
For Canada only. Currently returns Not applicable if SuiteTax is enabled. |
yes |
no |
taxrate2 |
string |
For Canada only. The rate of PST tax in percentage when applicable. Not applicable if SuiteTax is enabled. |
yes |
no |
tax1amt |
string |
The total tax amount for the line item. Not applicable if SuiteTax is enabled. |
yes |
no |
fulfillment |
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 |