OrderItem
Order item model.
interface OrderItem {
applied_discounts?: OrderProductAppliedDiscounts[];
base_cost_price?: string;
base_price?: string;
base_total?: string;
base_wrapping_cost?: number | string;
bin_picking_number?: string;
cost_price_ex_tax?: string;
cost_price_inc_tax?: string;
cost_price_tax?: string;
ebay_item_id?: string;
ebay_transaction_id?: string;
event_date?: any | null;
event_name?: any | null;
external_id?: any | null;
fixed_shipping_cost?: string;
id?: number;
is_bundled_product?: boolean;
is_refunded?: boolean;
name_customer?: string;
name_merchant?: string;
name?: string;
option_set_id?: any | null;
order_address_id?: number;
order_id?: number;
parent_order_product_id?: any | null;
price_ex_tax?: string;
price_inc_tax?: string;
price_tax?: string;
product_id?: number;
product_options?: OrderProductOptions[];
quantity_shipped?: number;
quantity?: number;
refunded_amount?: string;
return_id?: number;
sku?: string;
total_ex_tax?: string;
total_inc_tax?: string;
total_tax?: string;
type?: "digital" | "physical";
upc?: string;
variant_id?: number;
weight?: any | null;
wrapping_cost_ex_tax?: string;
wrapping_cost_inc_tax?: string;
wrapping_cost_tax?: string;
wrapping_message?: string;
wrapping_name?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
applied_discounts | Optional | OrderProductAppliedDiscounts[] | Array of objects containing discounts applied to the product. |
base_cost_price | Optional | string | The product's cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only |
base_price | Optional | string | The product's base price. (Float, Float-As-String, Integer) |
base_total | Optional | string | Total base price. (Float, Float-As-String, Integer) |
base_wrapping_cost | Optional | number | string | The value of the base wrapping cost. (Float, Float-As-String, Integer) |
bin_picking_number | Optional | string | Bin picking number for the physical product. |
cost_price_ex_tax | Optional | string | The products cost price excluding tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only |
cost_price_inc_tax | Optional | string | The product's cost price including tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only |
cost_price_tax | Optional | string | Tax applied to the product’s cost price. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only |
ebay_item_id | Optional | string | Item ID for this product on eBay. |
ebay_transaction_id | Optional | string | Transaction ID for this product on eBay. |
event_date | Optional | any | null | Date of the promotional event/scheduled delivery. |
event_name | Optional | any | null | Name of promotional event/delivery date. |
external_id | Optional | any | null | ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field 'external_id' cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set. |
fixed_shipping_cost | Optional | string | Fixed shipping cost for this product. (Float, Float-As-String, Integer) |
id | Optional | number | Numeric ID of this product within this order. |
is_bundled_product | Optional | boolean | Whether this product is bundled with other products. |
is_refunded | Optional | boolean | Whether the product has been refunded. |
name_customer | Optional | string | The product name that is shown to customer in storefront. |
name_merchant | Optional | string | The product name that is shown to merchant in Control Panel. |
name | Optional | string | Alias for name_customer - The product name that is shown to customer in storefront. |
option_set_id | Optional | any | null | Numeric ID of the option set applied to the product. |
order_address_id | Optional | number | Numeric ID of the associated order address. |
order_id | Optional | number | Numeric ID of the associated order. |
parent_order_product_id | Optional | any | null | ID of a parent product. |
price_ex_tax | Optional | string | The product’s price excluding tax. (Float, Float-As-String, Integer) |
price_inc_tax | Optional | string | The product’s price including tax. (Float, Float-As-String, Integer) |
price_tax | Optional | string | Amount of tax applied to a single product. Price tax is calculated as: price_tax = price_inc_tax - price_ex_tax (Float, Float-As-String, Integer) |
product_id | Optional | number | Numeric ID of the product. |
product_options | Optional | OrderProductOptions[] | Array of product options. |
quantity_shipped | Optional | number | Quantity of this item shipped. |
quantity | Optional | number | Quantity of the product ordered. |
refunded_amount | Optional | string | The amount refunded from this transaction. (Float, Float-As-String, Integer) |
return_id | Optional | number | Numeric ID for the refund. |
sku | Optional | string | User-defined product code/stock keeping unit (SKU). |
total_ex_tax | Optional | string | Total base price excluding tax. (Float, Float-As-String, Integer) |
total_inc_tax | Optional | string | Total base price including tax. (Float, Float-As-String, Integer) |
total_tax | Optional | string | Total tax applied to products. For example, if quantity if 2, base price is 5 and tax rate is 10%. price_tax will be $.50 and total_tax will be $1.00. If there is a manual discount applied total_tax is calcuted as the following: (price_ex_tax - discount)*tax_rate=total_tax. (Float, Float-As-String, Integer) |
type | Optional | "digital" | "physical" | Type of product |
upc | Optional | string | Universal Product Code. Can be written to for custom products and catalog products. |
variant_id | Optional | number | Products variant_id. PUT or POST. This field is not available for custom products. |
weight | Optional | any | null | Weight of the product. (Float, Float-As-String, Integer) |
wrapping_cost_ex_tax | Optional | string | The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer) |
wrapping_cost_inc_tax | Optional | string | The value of the wrapping cost, including tax. (Float, Float-As-String, Integer) |
wrapping_cost_tax | Optional | string | Tax applied to gift-wrapping option. (Float, Float-As-String, Integer) |
wrapping_message | Optional | string | Message to accompany gift-wrapping option. |
wrapping_name | Optional | string | Name of gift-wrapping option |