`order_item` object¶

An order_item object contains the properties that define an order item in DropStream.

Order item objects are children of an order object.

`order_item` schema¶

{
  "attribute_comments": "string (65536)",
  "attribute_descriptions": "string (65536)",
  "buyer_part_number": "string",
  "canceled": boolean,
  "color_description": "string",
  "created_at": "dateString",
  "customer_notes": "string",
  "discount_amount": "decimal (8,2)",
  "drop_ship": "string",
  "external_order_item_id": "string",
  "external_product_id": "string",
  "external_variant_id": "string",
  "external_warehouse_order_id": "string",
  "fulfillment_facility": "string",
  "fulfillment_warehouse_id": integer,
  "gift_wrap": boolean,
  "lot_numbers": "string",
  "name": "string",
  "product_options": "string (65536)",
  "product_type": "string",
  "serial_numbers": "string",
  "shipment_id": integer,
  "size_description": "string",
  "sku": "string",
  "tax_amount": "decimal(8,2)",
  "unit_cost": "decimal(8,2)",
  "unit_price": "decimal (8,2)",
  "uom": "string",
  "upc": "string",
  "vendor_id": "string",
  "vendor_part_number": "string",
  "warehouse_id": integer,
  "weight": "decimal (10,2)",
  "weight_uom": "string",
  "options": [
    {
      "gift_message": "string"
    }
  ],
  "custom": {
    "gift_message": "string"
  }
}

`order_item` properties¶

`attribute_comments`¶

Property	`attribute_comments`
Data type	string (65536)
Description	Item attribute comments

`attribute_descriptions`¶

Property	`attribute_descriptions`
Data type	string (65536)
Description	Item attribute descriptions

`buyer_part_number`¶

Property	`buyer_part_number`
Data type	string
Description	Buyer part number

`canceled`¶

Property	`canceled`
Data type	boolean
Description	`true` if item was canceled from the order
Example	`false`

`color_description`¶

Property	`color_description`
Data type	string
Description	Item color description

`created_at`¶

Property	`created_at`
Data type	dateString
Description	DateTime when the order item was imported to DropStream
Example	`2022-12-08T13:03:23Z`

`custom`¶

Property	`custom`
Data type	object
Description	Custom fields, if any
Example	`{ "gift_message": "string" }`

`customer_notes`¶

Property	`customer_notes`
Data type	string
Description	Customer notes associated with this item

`discount_amount`¶

Property	`discount_amount`
Data type	decimal (8,2)
Description	Monetary discount amount associated with this item
Example	`1.23`

`drop_ship`¶

Property	`drop_ship`
Data type	string
Description	Drop ship

`external_order_item_id`¶

Property	`external_order_item_id`
Data type	string
Description	The external platform's ID for this item

`external_product_id`¶

Property	`external_product_id`
Data type	string
Description	The external platform's ID for this product

`external_variant_id`¶

Property	`external_variant_id`
Data type	string
Description	The external platform's ID for this product variant

`external_warehouse_order_id`¶

Property	`external_warehouse_order_id`
Data type	string
Description	The warehouse's ID for the associated order

`fulfillment_facility`¶

Property	`fulfillment_facility`
Data type	string
Description	Fulfillment facility

`fulfillment_warehouse_id`¶

Property	`fulfillment_warehouse_id`
Data type	integer
Description	Fulfillment warehouse ID

`gift_wrap`¶

Property	`gift_wrap`
Data type	boolean
Description	`true` if item is gift wrapped
Example	`false`

`lot_numbers`¶

Property	`lot_numbers`
Data type	string
Description	Lot number(s) of this item

`name`¶

Property	`name`
Data type	string
Description	Item name

`options`¶

Property	`options`
Data type	Array containing one or more objects
Description	Order item option fields, if any
Example	`[ { "gift_message": "string" } ]`

`product_options`¶

Property	`product_options`
Data type	string (65536)
Description	Product options for this item

`product_type`¶

Property	`product_type`
Data type	string
Description	Product type for this item

`serial_numbers`¶

Property	`serial_numbers`
Data type	string
Description	Serial number(s) of this item

`shipment_id`¶

Property	`shipment_id`
Data type	integer
Description	DropStream internal ID of the shipment associated with this item

`size_description`¶

Property	`size_description`
Data type	string
Description	Size description for this item

`sku`¶

Property	`sku`
Data type	string
Description	Item SKU

`tax_amount`¶

Property	`tax_amount`
Data type	decimal(8,2)
Description	Tax amount

`unit_cost`¶

Property	`unit_cost`
Data type	decimal(8,2)
Description	Unit cost for this item

`unit_price`¶

Property	`unit_price`
Data type	decimal (8,2)
Description	Item unit price

`uom`¶

Property	`uom`
Data type	string
Description	Unit of measure

`upc`¶

Property	`upc`
Data type	string
Description	Item UPC

`vendor_id`¶

Property	`vendor_id`
Data type	string
Description	Vendor ID

`vendor_part_number`¶

Property	`vendor_part_number`
Data type	string
Description	Vendor part number

`warehouse_id`¶

Property	`warehouse_id`
Data type	integer
Description	DropStream warehouse ID

`weight`¶

Property	`weight`
Data type	decimal (10,2)
Description	Item weight

`weight_uom`¶

Property	`weight_uom`
Data type	string
Description	Weight unit of measure

order_item object¶

order_item schema¶

order_item properties¶

attribute_comments¶

attribute_descriptions¶

buyer_part_number¶

canceled¶

color_description¶

created_at¶

custom¶

customer_notes¶

discount_amount¶

drop_ship¶

external_order_item_id¶

external_product_id¶

external_variant_id¶

external_warehouse_order_id¶

fulfillment_facility¶

fulfillment_warehouse_id¶

gift_wrap¶

lot_numbers¶

name¶

options¶

product_options¶

product_type¶

serial_numbers¶

shipment_id¶

size_description¶

sku¶

tax_amount¶

unit_cost¶

unit_price¶

uom¶

upc¶

vendor_id¶

vendor_part_number¶

warehouse_id¶

weight¶

weight_uom¶

`order_item` object¶

`order_item` schema¶

`order_item` properties¶

`attribute_comments`¶

`attribute_descriptions`¶

`buyer_part_number`¶

`canceled`¶

`color_description`¶

`created_at`¶

`custom`¶

`customer_notes`¶

`discount_amount`¶

`drop_ship`¶

`external_order_item_id`¶

`external_product_id`¶

`external_variant_id`¶

`external_warehouse_order_id`¶

`fulfillment_facility`¶

`fulfillment_warehouse_id`¶

`gift_wrap`¶

`lot_numbers`¶

`name`¶

`options`¶

`product_options`¶

`product_type`¶

`serial_numbers`¶

`shipment_id`¶

`size_description`¶

`sku`¶

`tax_amount`¶

`unit_cost`¶

`unit_price`¶

`uom`¶

`upc`¶

`vendor_id`¶

`vendor_part_number`¶

`warehouse_id`¶

`weight`¶

`weight_uom`¶