Skip to content

Latest commit

 

History

History
74 lines (70 loc) · 5.81 KB

OrderItem.md

File metadata and controls

74 lines (70 loc) · 5.81 KB

OrderItem

Properties

Name Type Description Notes
accounting_code str QuickBooks code [optional]
activation_codes list[str] Activation codes assigned to this item [optional]
arbitrary_unit_cost Currency [optional]
auto_order_last_rebill_dts str Date/time of the last rebill, used only during order insert to help project future rebills [optional]
auto_order_schedule str Auto order schedule, used only during inserts supplying the recurring schedule [optional]
barcode str Barcode [optional]
barcode_gtin12 str Barcode - GTIN 12 [optional]
barcode_gtin14 str Barcode - GTIN 14 [optional]
barcode_upc11 str Barcode - UPC 11 [optional]
barcode_upc12 str Barcode - UPC 12 [optional]
channel_partner_item_id str Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id [optional]
cogs float Cost of goods sold [optional]
component_unit_value float Value of the kit component item [optional]
cost Currency [optional]
country_code_of_origin str Country of origin (ISO-3166 two letter code) [optional]
customs_description str Customs description [optional]
description str Description [optional]
discount Currency [optional]
discount_quantity float Discount quantity [optional]
discount_shipping_weight Weight [optional]
distribution_center_code str Distribution center code responsible for shipping this item [optional]
edi OrderItemEdi [optional]
exclude_coupon bool True if this item is excluded from coupons [optional]
free_shipping bool True if the item receives free shipping [optional]
hazmat bool Hazardous materials indicator [optional]
height Distance [optional]
item_index int Index of the item on the order (one based index) [optional]
item_reference_oid int Item reference object identifier used to linked to auto order item record [optional]
kit bool True if this item is a kit [optional]
kit_component bool True if this item is a kit component [optional]
length Distance [optional]
manufacturer_sku str Manufacturer SKU [optional]
max_days_time_in_transit int Maximum days that the item can be in transit before spoilage (perishable products) [optional]
merchant_item_id str Item ID [optional]
mix_and_match_group_name str Mix and match group name [optional]
mix_and_match_group_oid int Mix and match group object identifier [optional]
no_shipping_discount bool True if this item is excluded from shipping discounts [optional]
options list[OrderItemOption] Options [optional]
packed_by_user str Packed by user [optional]
parent_item_index int If this item is a kit component, this is the item index of the parent item (kit) [optional]
parent_merchant_item_id str If this item is a kit component, this is the item id of the parent item (kit) [optional]
perishable_class str Perishable class of the item [optional]
pricing_tier_name str Pricing tier that granted the particular price for this item if the customer profile had pricing tiers assigned [optional]
properties list[OrderItemProperty] Properties [optional]
quantity float Quantity [optional]
quantity_refunded float Quantity refunded on this item (read only except refund operation) [optional]
quickbooks_class str QuickBooks class [optional]
refund_reason str Refund reason code. This can only be written during a refund operation otherwise this field is read only. [optional]
return_reason str Return reason code. This can only be written during a refund operation otherwise this field is read only. [optional]
ship_separately bool True if this item ships in a separate box [optional]
shipped_by_user str Shipped by user [optional]
shipped_dts str Date/time that this item was marked shipped [optional]
shipping_status str Shipping status for this item. This is the replacement for the old order level shipping status. [optional]
special_product_type str Special product type (USPS Media Mail) [optional]
tags list[OrderItemTag] Tags [optional]
tax_free bool True if the item is tax free [optional]
tax_product_type str Type of product for tax purposes (self or UltraCart Managed taxes) [optional]
taxable_cost Currency [optional]
total_cost_with_discount Currency [optional]
total_refunded Currency [optional]
transmitted_to_distribution_center_dts str Date/time that this item was transmitted to the distribution center [optional]
unit_cost_with_discount Currency [optional]
upsell bool True if this item was added to the order as part of an upsell [optional]
weight Weight [optional]
width Distance [optional]

[Back to Model list] [Back to API list] [Back to README]