# OrderQuote

This type is derived from <https://schema.org/Order>, 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": "OrderQuote"</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/order-quotes/1a80eca5-99f1-4e9a-81da-937e5621b246"</code></p></td></tr><tr><td>bookingService</td><td><a href="https://developer.openactive.io/data-model/types/bookingservice"><code>BookingService</code></a></td><td>Details about the Booking System</td></tr><tr><td>broker</td><td><a href="https://developer.openactive.io/data-model/types/organization"><code>Organization</code></a></td><td>The organisation or developer providing an application that allows Customers to make bookings. Those applications will be clients of the API defined in this specification. If brokerRole is set to <a href="https://openactive.io/NoBroker">https://openactive.io/NoBroker</a> this is not required.</td></tr><tr><td>brokerRole</td><td><a href="https://openactive.io/BrokerType"><code>BrokerType</code></a></td><td>Either <a href="https://openactive.io/AgentBroker">https://openactive.io/AgentBroker</a>, <a href="https://openactive.io/ResellerBroker">https://openactive.io/ResellerBroker</a> or <a href="https://openactive.io/NoBroker">https://openactive.io/NoBroker</a>, as agreed in advance between the Broker and Seller.</td></tr><tr><td>customer</td><td><a href="https://developer.openactive.io/data-model/types/person"><code>Person</code></a><br>- or -<br><a href="https://developer.openactive.io/data-model/types/organization"><code>Organization</code></a></td><td>The person or organization purchasing the Order.</td></tr><tr><td>identifier</td><td><a href="https://schema.org/Text"><code>Text</code></a></td><td><p>The Order UUID of the Order, OrderQuote or OrderProposal, which is required within the Orders feed.</p><p><br>Example</p><p><code>"identifier": "123e4567-e89b-12d3-a456-426614174000"</code></p></td></tr><tr><td>lease</td><td><a href="https://developer.openactive.io/data-model/types/lease"><code>Lease</code></a></td><td>The Lease on the OrderItems which lasts for the duration specified by the Booking System.</td></tr><tr><td>orderCreationStatus</td><td><a href="https://openactive.io/OrderCreationStatus"><code>OrderCreationStatus</code></a></td><td>This property is internal to the Broker in this version of the specification.</td></tr><tr><td>orderNumber</td><td><a href="https://schema.org/Text"><code>Text</code></a></td><td>The Customer-facing identifier of the Order.</td></tr><tr><td>orderProposalVersion</td><td><a href="https://schema.org/URL"><code>URL</code></a></td><td>The unique URL representing this version of the OrderProposal, or the version of the OrderProposal to which this Order is related.</td></tr><tr><td>orderRequiresApproval</td><td><a href="https://schema.org/Boolean"><code>Boolean</code></a></td><td>Whether the Booking Flow with Approval must be used to book the set of OrderItems included. must be true if any of the OrderItems require approval.</td></tr><tr><td>orderedItem</td><td>Array of <a href="https://developer.openactive.io/data-model/types/orderitem"><code>OrderItem</code></a></td><td>The items that constitute the Order.</td></tr><tr><td>payment</td><td><a href="https://developer.openactive.io/data-model/types/payment"><code>Payment</code></a></td><td>The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.</td></tr><tr><td>seller</td><td><a href="https://developer.openactive.io/data-model/types/organization"><code>Organization</code></a><br>- or -<br><a href="https://developer.openactive.io/data-model/types/person"><code>Person</code></a><br>- or -<br><code>@id</code> reference</td><td>The organisation (schema:Organization) or person (schema:Person) providing access to events or facilities via a Booking System. e.g. a leisure provider or independent instructor running a yoga classes.</td></tr><tr><td>taxCalculationExcluded</td><td><a href="https://schema.org/Boolean"><code>Boolean</code></a></td><td>Set to true when business-to-business tax calculation is required by the seller or brokerRole settings, but not supported by the Broker.</td></tr><tr><td>totalPaymentDue</td><td><a href="https://developer.openactive.io/data-model/types/pricespecification"><code>PriceSpecification</code></a></td><td><pre><code>  &#x3C;/td>
&#x3C;/tr>
&#x3C;tr>
  &#x3C;td style="text-align:left">&#x3C;b>totalPaymentTax&#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 Order.&#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/)".