Order
An order is a confirmation of a transaction (a receipt), which can contain multiple line items, each represented by an Offer that has been accepted by the customer.
Usage: Between 10 and 100 domains
Property | Expected Type | Description |
---|---|---|
Properties from Order | ||
acceptedOffer
|
Offer | The offer(s) -- e.g., product, quantity and price combinations -- included in the order. |
billingAddress
|
PostalAddress | The billing address for the order. |
broker
|
Person or Organization | An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. Supersedes bookingAgent. |
confirmationNumber
|
Text | A number that confirms the given order or payment has been received. |
customer
|
Person or Organization | Party placing the order or paying the invoice. |
discount
|
Number or Text | Any discount applied (to an Order). |
discountCode
|
Text | Code used to redeem a discount. |
discountCurrency
|
Text | The currency (in 3-letter ISO 4217 format) of the discount. |
isGift
|
Boolean | Was the offer accepted as a gift for someone other than the buyer. |
orderDate
|
DateTime | Date order was placed. |
orderDelivery
|
ParcelDelivery | The delivery of the parcel related to this order or order item. |
orderNumber
|
Text | The identifier of the transaction. |
orderStatus
|
OrderStatus | The current status of the order. |
orderedItem
|
Product or OrderItem | The item ordered. |
partOfInvoice
|
Invoice | The order is being paid as part of the referenced Invoice. |
paymentDueDate
|
DateTime | The date that payment is due. Supersedes paymentDue. |
paymentMethod
|
PaymentMethod | The name of the credit card or other method of payment for the order. |
paymentMethodId
|
Text | An identifier for the method of payment used (e.g. the last 4 digits of the credit card). |
paymentUrl
|
URL | The URL for sending a payment. |
seller
|
Person or Organization | An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes merchant, vendor. |
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. |
image
|
URL or ImageObject | 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, Freebase page, or official website. |
url
|
URL | URL of the item. |
Instances of Order may appear as values for the following properties
Property | On Types | Description |
---|---|---|
partOfOrder
|
ParcelDelivery | The overall order the items in this delivery were included in. |
referencesOrder
|
Invoice | The Order(s) related to this Invoice. One or more Orders may be combined into a single Invoice. |
Available supertypes defined in extensions
Available properties in extensions
- From Order: Order.date, Order.detail, Order.identifier, Order.reasonCodeableConcept, Order.reasonReference, Order.source, Order.subject, Order.target, Order.when, Order.when.code, Order.when.schedule
Examples
An example of a invoice for a purchase and installation. ACME Home Heating Bill for: New furnace and installation Customer: Jane Doe payment due: 2015-01-30 minimum payment: $0.00 total due: $0.00 payment status: paid order: furnace model ABC123 order: installation labor
<div itemscope itemtype="http://schema.org/Invoice"> <h1 itemprop="description">New furnace and installation</h1> <div itemprop="broker" itemscope itemtype="http://schema.org/LocalBusiness"> <b itemprop="name">ACME Home Heating</b> </div> <div itemprop="customer" itemscope itemtype="http://schema.org/Person"> <b itemprop="name">Jane Doe</b> </div> <time itemprop="paymentDueDate">2015-01-30</time> <div itemprop="minimumPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification"> <span itemprop="price">0.00</span> <span itemprop="priceCurrency">USD</span> </div> <div itemprop="totalPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification"> <span itemprop="price">0.00</span> <span itemprop="priceCurrency">USD</span> </div> <link itemprop="paymentStatus" href="http://schema.org/PaymentComplete" /> <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order"> <span itemprop="description">furnace</span> <time itemprop="orderDate">2014-12-01</time> <span itemprop="orderNumber">123ABC</span> <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product"> <span itemprop="name">ACME Furnace 3000</span> <meta itemprop="productId" content="ABC123" /> </div> </div> <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order"> <span itemprop="description">furnace installation</span> <time itemprop="orderDate">2014-12-02</time> <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Service"> <span itemprop="description">furnace installation</span> </div> </div> </div>
<div vocab="http://schema.org/" typeof="Invoice"> <h1 property="description">New furnace and installation</h1> <div property="broker" typeof="/LocalBusiness"> <b property="name">ACME Home Heating</b> </div> <div property="customer" typeof="Person"> <b property="name">Jane Doe</b> </div> <time property="paymentDueDate">2015-01-30</time> <div property="minimumPaymentDue" typeof="PriceSpecification"> <span property="price">0.00</span> <span property="priceCurrency">USD</span> </div> <div property="totalPaymentDue" typeof="PriceSpecification"> <span property="price">0.00</span> <span property="priceCurrency">USD</span> </div> <meta itemprop="paymentStatus" content="PaymentComplete" /> <div property="referencesOrder" typeof="Order"> <span property="description">furnace</span> <time property="orderDate">2014-12-01</time> <span property="orderNumber">123ABC</span> <div property="orderedItem" typeof="Product"> <span property="name">ACME Furnace 3000</span> <meta property="productId" content="ABC123" /> </div> </div> <div property="referencesOrder" typeof="Order"> <span property="description">furnace installation</span> <time property="orderDate">2014-12-02</time> <div property="orderedItem" typeof="Service"> <span property="description">furnace installation</span> </div> </div> </div>
<script type="application/ld+json"> { "@context": "http://schema.org/", "@type": "Invoice", "broker": { "@type": "LocalBusiness", "name": "ACME Home Heating", }, "accountId": "xxxx-xxxx-xxxx-1234", "customer": { "@type": "Person", "name": "Jane Doe" }, "paymentDueDate": "2015-01-30", "minimumPaymentDue": { "@type": "PriceSpecification", "price": 0.00, "priceCurrency": "USD" }, "totalPaymentDue": { "@type": "PriceSpecification", "price": 0.00, "priceCurrency": "USD" }, "paymentStatus": "http://schema.org/PaymentComplete", "referencesOrder": [ { "@type": "Order", "description": "furnace", "orderDate": "2014-12-01", "orderNumber": "123ABC", "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice", "orderedItem": { "@type": "Product", "name": "ACME Furnace 3000", "productId": "ABC123" } }, { "@type": "Order", "description": "furnace installation", "orderDate": "2014-12-02", "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice", "orderedItem": { "@type": "Service", "description": "furnace installation" } }, ] } </script>
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 2.2