Alokai

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

NameRequiredTypeDescription
applied_discountsOptionalOrderProductAppliedDiscounts[]Array of objects containing discounts applied to the product.
base_cost_priceOptionalstringThe product's cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only
base_priceOptionalstringThe product's base price. (Float, Float-As-String, Integer)
base_totalOptionalstringTotal base price. (Float, Float-As-String, Integer)
base_wrapping_costOptionalnumber | stringThe value of the base wrapping cost. (Float, Float-As-String, Integer)
bin_picking_numberOptionalstringBin picking number for the physical product.
cost_price_ex_taxOptionalstringThe 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_taxOptionalstringThe 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_taxOptionalstringTax 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_idOptionalstringItem ID for this product on eBay.
ebay_transaction_idOptionalstringTransaction ID for this product on eBay.
event_dateOptionalany | nullDate of the promotional event/scheduled delivery.
event_nameOptionalany | nullName of promotional event/delivery date.
external_idOptionalany | nullID 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_costOptionalstringFixed shipping cost for this product. (Float, Float-As-String, Integer)
idOptionalnumberNumeric ID of this product within this order.
is_bundled_productOptionalbooleanWhether this product is bundled with other products.
is_refundedOptionalbooleanWhether the product has been refunded.
name_customerOptionalstringThe product name that is shown to customer in storefront.
name_merchantOptionalstringThe product name that is shown to merchant in Control Panel.
nameOptionalstringAlias for name_customer - The product name that is shown to customer in storefront.
option_set_idOptionalany | nullNumeric ID of the option set applied to the product.
order_address_idOptionalnumberNumeric ID of the associated order address.
order_idOptionalnumberNumeric ID of the associated order.
parent_order_product_idOptionalany | nullID of a parent product.
price_ex_taxOptionalstringThe product’s price excluding tax. (Float, Float-As-String, Integer)
price_inc_taxOptionalstringThe product’s price including tax. (Float, Float-As-String, Integer)
price_taxOptionalstringAmount 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_idOptionalnumberNumeric ID of the product.
product_optionsOptionalOrderProductOptions[]Array of product options.
quantity_shippedOptionalnumberQuantity of this item shipped.
quantityOptionalnumberQuantity of the product ordered.
refunded_amountOptionalstringThe amount refunded from this transaction. (Float, Float-As-String, Integer)
return_idOptionalnumberNumeric ID for the refund.
skuOptionalstringUser-defined product code/stock keeping unit (SKU).
total_ex_taxOptionalstringTotal base price excluding tax. (Float, Float-As-String, Integer)
total_inc_taxOptionalstringTotal base price including tax. (Float, Float-As-String, Integer)
total_taxOptionalstringTotal 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)
typeOptional"digital" | "physical"Type of product
upcOptionalstringUniversal Product Code. Can be written to for custom products and catalog products.
variant_idOptionalnumberProducts variant_id. PUT or POST. This field is not available for custom products.
weightOptionalany | nullWeight of the product. (Float, Float-As-String, Integer)
wrapping_cost_ex_taxOptionalstringThe value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
wrapping_cost_inc_taxOptionalstringThe value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
wrapping_cost_taxOptionalstringTax applied to gift-wrapping option. (Float, Float-As-String, Integer)
wrapping_messageOptionalstringMessage to accompany gift-wrapping option.
wrapping_nameOptionalstringName of gift-wrapping option

On this page