# OrderItem

This type is derived from <https://schema.org/OrderItem>, which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.

## **Properties**

### **Optional properties**

<table><thead><tr><th>Property</th><th>Expected Type</th><th>Description</th></tr></thead><tbody><tr><td>@type</td><td><a href="https://schema.org/Text"><code>Text</code></a></td><td>Must always be present and set to <code>"@type": "OrderItem"</code></td></tr><tr><td>@id</td><td><a href="https://schema.org/URL"><code>URL</code></a></td><td><p>A unique URI-based identifier for the record.</p><p><code>@id</code> properties are used as identifiers for compatibility with JSON-LD. The value of such a property must always be an absolute URI that provides a stable globally unique identifier for the resource, as described in <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a>.</p><p>The primary purpose of the URI format in this context is to provide natural namespacing for the identifier. Hence, the URI itself may not resolve to a valid endpoint, but must use a domain name controlled by the resource owner (the organisation responsible for the OpenActive open data feed).</p><p><br>Example</p><p><code>"@id": "https://api.example.com/orders/1a80eca5-99f1-4e9a-81da-937e5621b246#/orderedItem/12345"</code></p></td></tr><tr><td>acceptedOffer</td><td><a href="https://developer.openactive.io/data-model/types/offer"><code>Offer</code></a><br>- or -<br><code>@id</code> reference</td><td>The offer from the associated orderedItem that has been selected by the Customer. The price of this includes or excludes tax depending on the taxMode of the Order.</td></tr><tr><td>accessChannel</td><td><a href="https://developer.openactive.io/data-model/types/virtuallocation"><code>VirtualLocation</code></a></td><td>Channel through which the user can participate in the Opportunity. Not applicable for an OrderQuote.</td></tr><tr><td>accessCode</td><td>Array of <a href="https://developer.openactive.io/data-model/types/propertyvalue"><code>PropertyValue</code></a></td><td>PropertyValue that contains a text value usable for entrance. Not applicable for an OrderQuote.</td></tr><tr><td>accessPass</td><td>Array of <a href="https://developer.openactive.io/data-model/types/imageobject"><code>ImageObject</code></a></td><td>ImageObject or Barcode that contains reference to an asset (e.g. Barcode, QR code image or PDF) usable for entrance. Not applicable for an OrderQuote.</td></tr><tr><td>attendee</td><td><a href="https://developer.openactive.io/data-model/types/person"><code>Person</code></a></td><td>The person attending the Opportunity related to the OrderItem.</td></tr><tr><td>attendeeDetailsRequired</td><td>Array of <a href="https://schema.org/Property"><code>Property</code></a></td><td>The properties of <code>schema:Person</code> that are required to describe an <code>attendee</code> for this <code>OrderItem</code>.</td></tr><tr><td>cancellationMessage</td><td><a href="https://schema.org/Text"><code>Text</code></a></td><td>A message set by the Seller in the event of Opportunity cancellation, only applicable for an <code>Order</code> and where the <code>OrderItem</code> has <code>orderItemStatus</code> set to <code>https://openactive.io/SellerCancelled</code></td></tr><tr><td>customerNotice</td><td><a href="https://schema.org/Text"><code>Text</code></a></td><td>A message set by the Seller to trigger a notification to the Customer, only applicable for an <code>Order</code> and where the <code>OrderItem</code> has <code>orderItemStatus</code> set to <code>https://openactive.io/OrderItemConfirmed</code> or <code>https://openactive.io/CustomerAttended</code></td></tr><tr><td>error</td><td>Array of <a href="https://developer.openactive.io/data-model/types/openbookingerror"><code>OpenBookingError</code></a></td><td>Array of errors related to the OrderItem being included in the Order, only applicable for an OrderQuote.</td></tr><tr><td>orderItemIntakeForm</td><td>Array of <a href="https://developer.openactive.io/data-model/types/propertyvaluespecification"><code>PropertyValueSpecification</code></a></td><td>PropertyValueSpecifications that describe fields in the orderItemIntakeForm.</td></tr><tr><td>orderItemIntakeFormResponse</td><td>Array of <a href="https://developer.openactive.io/data-model/types/propertyvalue"><code>PropertyValue</code></a></td><td>PropertyValues that contains a text value responses to the orderItemIntakeForm.</td></tr><tr><td>orderItemStatus</td><td><a href="https://openactive.io/OrderItemStatus"><code>OrderItemStatus</code></a></td><td><pre><code>  &#x3C;/td>
&#x3C;/tr>
&#x3C;tr>
  &#x3C;td style="text-align:left">&#x3C;b>orderedItem&#x3C;/b>&#x3C;/td>
  &#x3C;td style="text-align:left">
    &#x3C;a href="https://developer.openactive.io/data-model/types/event">&#x3C;code>Event&#x3C;/code>&#x3C;/a>&#x3C;br/> - or - &#x3C;br/>&#x3C;code>@id&#x3C;/code> reference
  &#x3C;/td>
  &#x3C;td style="text-align:left">
    &#x3C;p>The specific bookable Thing that has been selected by the Customer. See the [Modelling-Opportunity-Data] for more information on these types. Note that the Broker Request and Orders feed only require id within these objects to be included; in these contexts, all other properties are ignored.&#x3C;/p>
  &#x3C;/td>
&#x3C;/tr>
&#x3C;tr>
  &#x3C;td style="text-align:left">&#x3C;b>position&#x3C;/b>&#x3C;/td>
  &#x3C;td style="text-align:left">
    &#x3C;a href="https://schema.org/Integer">&#x3C;code>Integer&#x3C;/code>&#x3C;/a>
  &#x3C;/td>
  &#x3C;td style="text-align:left">
    &#x3C;p>An integer representing the order of OrderItems within the array.&#x3C;/p>
  &#x3C;/td>
&#x3C;/tr>
&#x3C;tr>
  &#x3C;td style="text-align:left">&#x3C;b>unitTaxSpecification&#x3C;/b>&#x3C;/td>
  &#x3C;td style="text-align:left">
    Array of &#x3C;a href="https://developer.openactive.io/data-model/types/taxchargespecification">&#x3C;code>TaxChargeSpecification&#x3C;/code>&#x3C;/a>
  &#x3C;/td>
  &#x3C;td style="text-align:left">
    &#x3C;p>Breakdown of tax payable for the OrderItem.&#x3C;/p>
  &#x3C;/td>
&#x3C;/tr>
</code></pre></td></tr></tbody></table>

Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution License (CC-BY V4.0)](https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the [MIT License](https://opensource.org/licenses/MIT), for anyone to access, use and share; using attribution "[OpenActive](https://www.openactive.io/)".