OrderItem

Canonical URL: http://schema.org/OrderItem

Thing > Intangible > OrderItem

An order item is a line of an order. It includes the quantity and shipping details of a bought offer.

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from OrderItem
orderDelivery ParcelDelivery The delivery of the parcel related to this order or order item.
orderItemNumber Text The identifier of the order item.
orderItemStatus OrderStatus The current status of the order item.
orderQuantity Number The number of the item ordered. If the property is not set, assume the quantity is one.
orderedItem OrderItem  or
Product 		The item ordered.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier PropertyValue  or
Text  or
URL 		The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
image ImageObject  or
URL 		An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 		Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
url URL URL of the item.


Instances of OrderItem may appear as values for the following properties

PropertyOn TypesDescription
orderedItem Order  or
OrderItem 		The item ordered.


Examples

Example 1
Without Markup Microdata RDFa JSON-LD 
An example of an order for multiple items, shipped separately.
ACME Supplies
Customer: Jane Doe
Order:
  Item abc123: 1 Widget: delivered 2015-03-10
  Item def456: 3 Widget accessories: shipped 2015-03-12

<div itemscope itemtype="http://schema.org/Order">
  <div itemprop="seller" itemscope itemtype="http://schema.org/Organization">
    <b itemprop="name">ACME Supplies</b>
  </div>
  <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
    <b itemprop="name">Jane Doe</b>
  </div>
  <div itemprop="orderedItem" itemscope itemtype="http://schema.org/OrderItem">
    Item number: <span itemprop="orderItemNumber">abc123</span>
    <span itemprop="orderQuantity">1</span>
    <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
      <span itemprop="name">Widget</span>
    </div>
    <link itemprop="orderItemStatus" href="http://schema.org/OrderDelivered" />Delivered
    <div itemprop="orderDelivery" itemscope itemtype="http://schema.org/ParcelDelivery">
      <time="expectedArrivalFrom">2015-03-10</time>
    </div>
  </div>
  <div itemprop="orderedItem" itemscope itemtype="http://schema.org/OrderItem">
    Item number: <span itemprop="orderItemNumber">def456</span>
    <span itemprop="orderQuantity">4</span>
    <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
      <span itemprop="name">Widget accessories</span>
    </div>
    <link itemprop="orderItemStatus" href="http://schema.org/OrderInTransit" />Shipped
    <div itemprop="orderDelivery" itemscope itemtype="http://schema.org/ParcelDelivery">
      <time itemprop="expectedArrivalFrom">2015-03-15</time>
      <time itemprop="expectedArrivalUntil">2015-03-18</time>
    </div>
  </div>
</div>

<div vocab="http://schema.org/" typeof="Order">
  <div property="seller" typeof="Organization">
    <b property="name">ACME Supplies</b>
  </div>
  <div property="customer" typeof="Person">
    <b property="name">Jane Doe</b>
  </div>
  <div property="orderedItem" typeof="OrderItem">
    Item number: <span property="orderItemNumber">abc123</span>
    <span property="orderQuantity">1</span>
    <div property="orderedItem" typeof="Product">
      <span property="name">Widget</span>
    </div>
    <link property="orderItemStatus" href="http://schema.org/OrderDelivered" />Delivered
    <div property="orderDelivery" typeof="ParcelDelivery">
      <time property="expectedArrivalFrom">2015-03-10</time>
    </div>
  </div>
  <div property="orderedItem" typeof="OrderItem">
    Item number: <span property="orderItemNumber">def456</span>
    <span property="orderQuantity">4</span>
    <div property="orderedItem" typeof="Product">
      <span property="name">Widget accessories</span>
    </div>
    <link property="orderItemStatus" href="http://schema.org/OrderInTransit" />Shipped
    <div property="orderDelivery" typeof="ParcelDelivery">
      <time property="expectedArrivalFrom">2015-03-15</time>
      <time property="expectedArrivalUntil">2015-03-18</time>
    </div>
  </div>
</div>

<script type="application/ld+json">
{
  "@context": "http://schema.org/"
  "@type": "Order",
  "seller": {
    "@type": "Organization",
    "name": "ACME Supplies"
  },
  "customer": {
    "@type": "Person",
    "name": "Jane Doe"
  },
  "orderedItem": [
    {
      "@type": "OrderItem"
      "orderItemNumber": "abc123",
      "orderQuantity": 1,
      "orderedItem": {
        "@type": "Product",
        "name": "Widget"
      },
      "orderItemStatus": "http://schema.org/OrderDelivered",
      "orderDelivery": {
        "@type": "ParcelDelivery",
        "expectedArrivalFrom": "2015-03-10"
      }
    },
    {
      "@type": "OrderItem"
      "orderItemNumber": "def456",
      "orderQuantity": 3,
      "orderedItem": {
        "@type": "Product",
        "name": "Widget accessories"
      },
      "orderItemStatus": "http://schema.org/OrderInTransit",
      "orderDelivery": {
        "@type": "ParcelDelivery",
        "expectedArrivalFrom": "2015-03-15",
        "expectedArrivalUntil": "2015-03-18"
      }
    }
  ]
}
</script>
Example 2
Without Markup Microdata RDFa JSON-LD 
An example of an order for multiple items, shipped separately.
ACME Supplies
Customer: Jane Doe
Order:
  Item abc123: 1 Widget: delivered 2015-03-10
  Item def456: 3 Widget accessories: shipped 2015-03-12

<div itemscope itemtype="http://schema.org/Order">
  <div itemprop="seller" itemscope itemtype="http://schema.org/Organization">
    <b itemprop="name">ACME Supplies</b>
  </div>
  <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
    <b itemprop="name">Jane Doe</b>
  </div>
  <div itemprop="orderedItem" itemscope itemtype="http://schema.org/OrderItem">
    Item number: <span itemprop="orderItemNumber">abc123</span>
    <span itemprop="orderQuantity">1</span>
    <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
      <span itemprop="name">Widget</span>
    </div>
    <link itemprop="orderItemStatus" href="http://schema.org/OrderDelivered" />Delivered
    <div itemprop="orderDelivery" itemscope itemtype="http://schema.org/ParcelDelivery">
      <time="expectedArrivalFrom">2015-03-10</time>
    </div>
  </div>
  <div itemprop="orderedItem" itemscope itemtype="http://schema.org/OrderItem">
    Item number: <span itemprop="orderItemNumber">def456</span>
    <span itemprop="orderQuantity">4</span>
    <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
      <span itemprop="name">Widget accessories</span>
    </div>
    <link itemprop="orderItemStatus" href="http://schema.org/OrderInTransit" />Shipped
    <div itemprop="orderDelivery" itemscope itemtype="http://schema.org/ParcelDelivery">
      <time itemprop="expectedArrivalFrom">2015-03-15</time>
      <time itemprop="expectedArrivalUntil">2015-03-18</time>
    </div>
  </div>
</div>

<div vocab="http://schema.org/" typeof="Order">
  <div property="seller" typeof="Organization">
    <b property="name">ACME Supplies</b>
  </div>
  <div property="customer" typeof="Person">
    <b property="name">Jane Doe</b>
  </div>
  <div property="orderedItem" typeof="OrderItem">
    Item number: <span property="orderItemNumber">abc123</span>
    <span property="orderQuantity">1</span>
    <div property="orderedItem" typeof="Product">
      <span property="name">Widget</span>
    </div>
    <link property="orderItemStatus" href="http://schema.org/OrderDelivered" />Delivered
    <div property="orderDelivery" typeof="ParcelDelivery">
      <time property="expectedArrivalFrom">2015-03-10</time>
    </div>
  </div>
  <div property="orderedItem" typeof="OrderItem">
    Item number: <span property="orderItemNumber">def456</span>
    <span property="orderQuantity">4</span>
    <div property="orderedItem" typeof="Product">
      <span property="name">Widget accessories</span>
    </div>
    <link property="orderItemStatus" href="http://schema.org/OrderInTransit" />Shipped
    <div property="orderDelivery" typeof="ParcelDelivery">
      <time property="expectedArrivalFrom">2015-03-15</time>
      <time property="expectedArrivalUntil">2015-03-18</time>
    </div>
  </div>
</div>

<script type="application/ld+json">
{
  "@context": "http://schema.org/"
  "@type": "Order",
  "seller": {
    "@type": "Organization",
    "name": "ACME Supplies"
  },
  "customer": {
    "@type": "Person",
    "name": "Jane Doe"
  },
  "orderedItem": [
    {
      "@type": "OrderItem"
      "orderItemNumber": "abc123",
      "orderQuantity": 1,
      "orderedItem": {
        "@type": "Product",
        "name": "Widget"
      },
      "orderItemStatus": "http://schema.org/OrderDelivered",
      "orderDelivery": {
        "@type": "ParcelDelivery",
        "expectedArrivalFrom": "2015-03-10"
      }
    },
    {
      "@type": "OrderItem"
      "orderItemNumber": "def456",
      "orderQuantity": 3,
      "orderedItem": {
        "@type": "Product",
        "name": "Widget accessories"
      },
      "orderItemStatus": "http://schema.org/OrderInTransit",
      "orderDelivery": {
        "@type": "ParcelDelivery",
        "expectedArrivalFrom": "2015-03-15",
        "expectedArrivalUntil": "2015-03-18"
      }
    }
  ]
}
</script>

Schema Version 3.2