OrderItem

This page describes the OrderItem type.

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

Property	Expected Type	Description
@type	Text	Must always be present and set to "@type": "OrderItem"
@id	URL	A unique URI-based identifier for the record. @id 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 RFC3986. 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). Example "@id": "https://api.example.com/orders/1a80eca5-99f1-4e9a-81da-937e5621b246#/orderedItem/12345"
acceptedOffer	Offer - or - @id reference	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.
accessChannel	VirtualLocation	Channel through which the user can participate in the Opportunity. Not applicable for an OrderQuote.
accessCode	Array of PropertyValue	PropertyValue that contains a text value usable for entrance. Not applicable for an OrderQuote.
accessPass	Array of ImageObject	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.
attendee	Person	The person attending the Opportunity related to the OrderItem.
attendeeDetailsRequired	Array of Property	The properties of schema:Person that are required to describe an attendee for this OrderItem.
cancellationMessage	Text	A message set by the Seller in the event of Opportunity cancellation, only applicable for an Order and where the OrderItem has orderItemStatus set to https://openactive.io/SellerCancelled
customerNotice	Text	A message set by the Seller to trigger a notification to the Customer, only applicable for an Order and where the OrderItem has orderItemStatus set to https://openactive.io/OrderItemConfirmed or https://openactive.io/CustomerAttended
error	Array of OpenBookingError	Array of errors related to the OrderItem being included in the Order, only applicable for an OrderQuote.
orderItemIntakeForm	Array of PropertyValueSpecification	PropertyValueSpecifications that describe fields in the orderItemIntakeForm.
orderItemIntakeFormResponse	Array of PropertyValue	PropertyValues that contains a text value responses to the orderItemIntakeForm.
orderItemStatus	OrderItemStatus	</td> </tr> <tr> <td style="text-align:left"><b>orderedItem</b></td> <td style="text-align:left"> <a href="https://developer.openactive.io/data-model/types/event"><code>Event</code></a><br/> - or - <br/><code>@id</code> reference </td> <td style="text-align:left"> <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.</p> </td> </tr> <tr> <td style="text-align:left"><b>position</b></td> <td style="text-align:left"> <a href="https://schema.org/Integer"><code>Integer</code></a> </td> <td style="text-align:left"> <p>An integer representing the order of OrderItems within the array.</p> </td> </tr> <tr> <td style="text-align:left"><b>unitTaxSpecification</b></td> <td style="text-align:left"> Array of <a href="https://developer.openactive.io/data-model/types/taxchargespecification"><code>TaxChargeSpecification</code></a> </td> <td style="text-align:left"> <p>Breakdown of tax payable for the OrderItem.</p> </td> </tr>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".