Order
schema:Thing > schema:Intangible > schema: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.
| Property | Expected Type | Description |
|---|---|---|
| Properties from schema:Order | ||
schema:acceptedOffer
|
schema:Offer | The offer(s) -- e.g., product, quantity and price combinations -- included in the order. |
schema:billingAddress
|
schema:PostalAddress | The billing address for the order. |
schema:broker
|
schema:Person or schema: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 schema:bookingAgent. |
schema:confirmationNumber
|
schema:Text | A number that confirms the given order or payment has been received. |
schema:customer
|
schema:Organization or schema:Person | Party placing the order or paying the invoice. |
schema:discount
|
schema:Number or schema:Text | Any discount applied (to an Order). |
schema:discountCode
|
schema:Text | Code used to redeem a discount. |
schema:discountCurrency
|
schema:Text | The currency (in 3-letter ISO 4217 format) of the discount. |
schema:isGift
|
schema:Boolean | Was the offer accepted as a gift for someone other than the buyer. |
schema:orderDate
|
schema:DateTime | Date order was placed. |
schema:orderNumber
|
schema:Text | The identifier of the transaction. |
schema:orderStatus
|
schema:OrderStatus | The current status of the order. |
schema:orderedItem
|
schema:Product | The item ordered. |
schema:partOfInvoice
|
schema:Invoice | The order is being paid as part of the referenced Invoice. |
schema:paymentDue
|
schema:DateTime | The date that payment is due. |
schema:paymentMethod
|
schema:PaymentMethod | The name of the credit card or other method of payment for the order. |
schema:paymentMethodId
|
schema:Text | An identifier for the method of payment used (e.g. the last 4 digits of the credit card). |
schema:paymentUrl
|
schema:URL | The URL for sending a payment. |
schema:seller
|
schema:Organization or schema:Person | An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes schema:merchant, schema:vendor. |
| Properties from schema:Thing | ||
schema:additionalType
|
schema: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. |
schema:alternateName
|
schema:Text | An alias for the item. |
schema:description
|
schema:Text | A short description of the item. |
schema:image
|
schema:ImageObject or schema:URL | An image of the item. This can be a URL or a fully described ImageObject. |
schema:name
|
schema:Text | The name of the item. |
schema:potentialAction
|
schema:Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
schema:sameAs
|
schema: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. |
schema:url
|
schema:URL | URL of the item. |
Instances of schema:Order may appear as values for the following properties
| Property | On Types | Description |
|---|---|---|
schema:partOfOrder
|
schema:ParcelDelivery | The overall order the items in this delivery were included in. |
schema:referencesOrder
|
schema:Invoice | The Order(s) related to this Invoice. One or more Orders may be combined into a single Invoice. |
Prefixes used:
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>
<span itemprop="paymentDue">2015-01-30</span>
<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>
<span itemprop="paymentStatus">paid</span>
<div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order">
<span itemprop="description">furnace</span>
<span itemprop="orderDate">2014-12-01</span>
<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>
<span itemprop="orderDate">2014-12-02</span>
<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" itemscope typeof="http://schema.org/LocalBusiness">
<b property="name">ACME Home Heating</b>
</div>
<div property="customer" typeof="http://schema.org/Person">
<b property="name">Jane Doe</b>
</div>
<span property="paymentDue">2015-01-30</span>
<div property="minimumPaymentDue" typeof="http://schema.org/PriceSpecification">
<span property="price">0.00</span>
<span property="priceCurrency">USD</span>
</div>
<div property="totalPaymentDue" typeof="http://schema.org/PriceSpecification">
<span property="price">0.00</span>
<span property="priceCurrency">USD</span>
</div>
<meta property="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
<span property="paymentStatus">paid</span>
<div property="referencesOrder" typeof="Order">
<span property="description">furnace</span>
<span property="orderDate">2014-12-01</span>
<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>
<span property="orderDate">2014-12-02</span>
<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"
},
"paymentDue": "2015-01-30",
"minimumPaymentDue": {
"@type": "PriceSpecification",
"price": 0.00,
"priceCurrency": "USD"
},
"totalPaymentDue": {
"@type": "PriceSpecification",
"price": 0.00,
"priceCurrency": "USD"
},
"paymentStatus": "paid",
"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>
BiblioGraph.net Version 1.1
Schema.org Version 1.93
Code Version 1.1