Skip to content

Latest commit

 

History

History
89 lines (75 loc) · 6.01 KB

File metadata and controls

89 lines (75 loc) · 6.01 KB

UltraCartRestApiV2.OrderItem

Properties

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

Enum: TaxProductTypeEnum

  • empty (value: "")

  • digital (value: "digital")

  • physical (value: "physical")

  • service (value: "service")