Publishing Data
Using data
Open Booking API
Data Model
Specifications
OrderProposal
This page describes the OrderProposal type.
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
Property
Expected Type
Description
@id
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/order-proposals/1a80eca5-99f1-4e9a-81da-937e5621b246"broker
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 https://openactive.io/NoBroker this is not required.
brokerRole
Either https://openactive.io/AgentBroker, https://openactive.io/ResellerBroker or https://openactive.io/NoBroker, as agreed in advance between the Broker and Seller.
identifier
The Order UUID of the Order, OrderQuote or OrderProposal, which is required within the Orders feed.
Example
"identifier": "123e4567-e89b-12d3-a456-426614174000"lease
The Lease on the OrderItems which lasts for the duration specified by the Booking System.
orderCreationStatus
This property is internal to the Broker in this version of the specification.
orderCustomerNote
1
</td>
2
</tr>
3
<tr>
4
<td style="text-align:left"><b>orderNumber</b></td>
5
<td style="text-align:left">
6
<a href="https://schema.org/Text"><code>Text</code></a>
7
</td>
8
<td style="text-align:left">
9
<p>The Customer-facing identifier of the Order.</p>
10
</td>
11
</tr>
12
<tr>
13
<td style="text-align:left"><b>orderProposalStatus</b></td>
14
<td style="text-align:left">
15
<a href="https://openactive.io/OrderProposalStatus"><code>OrderProposalStatus</code></a>
16
</td>
17
<td style="text-align:left">
18
19
</td>
20
</tr>
21
<tr>
22
<td style="text-align:left"><b>orderProposalVersion</b></td>
23
<td style="text-align:left">
24
<a href="https://schema.org/URL"><code>URL</code></a>
25
</td>
26
<td style="text-align:left">
27
<p>The unique URL representing this version of the OrderProposal, or the version of the OrderProposal to which this Order is related.</p>
28
</td>
29
</tr>
30
<tr>
31
<td style="text-align:left"><b>orderSellerNote</b></td>
32
<td style="text-align:left">
33
<a href="https://schema.org/Text"><code>Text</code></a>
34
</td>
35
<td style="text-align:left">
36
37
</td>
38
</tr>
39
<tr>
40
<td style="text-align:left"><b>orderedItem</b></td>
41
<td style="text-align:left">
42
Array of <a href="https://developer.openactive.io/data-model/types/orderitem"><code>OrderItem</code></a>
43
</td>
44
<td style="text-align:left">
45
<p>The items that constitute the Order.</p>
46
</td>
47
</tr>
48
<tr>
49
<td style="text-align:left"><b>payment</b></td>
50
<td style="text-align:left">
51
<a href="https://developer.openactive.io/data-model/types/payment"><code>Payment</code></a>
52
</td>
53
<td style="text-align:left">
54
<p>The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.</p>
55
</td>
56
</tr>
57
<tr>
58
<td style="text-align:left"><b>seller</b></td>
59
<td style="text-align:left">
60
<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>
61
</td>
62
<td style="text-align:left">
63
<p>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.</p>
64
</td>
65
</tr>
66
<tr>
67
<td style="text-align:left"><b>taxCalculationExcluded</b></td>
68
<td style="text-align:left">
69
<a href="https://schema.org/Boolean"><code>Boolean</code></a>
70
</td>
71
<td style="text-align:left">
72
<p>Set to true when business-to-business tax calculation is required by the seller or brokerRole settings, but not supported by the Broker.</p>
73
</td>
74
</tr>
75
<tr>
76
<td style="text-align:left"><b>totalPaymentDue</b></td>
77
<td style="text-align:left">
78
<a href="https://developer.openactive.io/data-model/types/pricespecification"><code>PriceSpecification</code></a>
79
</td>
80
<td style="text-align:left">
81
82
</td>
83
</tr>
84
<tr>
85
<td style="text-align:left"><b>totalPaymentTax</b></td>
86
<td style="text-align:left">
87
Array of <a href="https://developer.openactive.io/data-model/types/taxchargespecification"><code>TaxChargeSpecification</code></a>
88
</td>
89
<td style="text-align:left">
90
<p>Breakdown of tax payable for the Order.</p>
91
</td>
92
</tr>
Copied!
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".
Last modified 3mo ago
Copy link