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.
Property | Expected Type | Description |
@type | | Must always be present and set to |
acceptedOffer | | 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. |
accessCode | Array of | PropertyValue that contains a text value usable for entrance. Not applicable for an OrderQuote. |
accessPass | Array of | 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. |
allowCustomerCancellationFullRefund | | Whether the event can be cancelled. |
attendee | | ​ |
attendeeDetailsRequired | Array of | ​ |
cancellationMessage | | 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 | | 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 | Array of errors related to the OrderItem being included in the Order, only applicable for an OrderQuote. |
orderItemIntakeForm | Array of | PropertyValueSpecifications that describe fields in the orderItemIntakeForm. |
orderItemIntakeFormResponse | Array of | PropertyValues that contains a text value responses to the orderItemIntakeForm. |
orderItemStatus | ​ | |
orderedItem | | 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. |
position | | An integer representing the order of OrderItems within the array. |
unitTaxSpecification | Array of | Breakdown of tax payable for the OrderItem. |
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".
