OpenActive Developers
Data ValidatorDataset DashboardW3C Community Group
  • Welcome to our community
  • Publishing Data
    • Data Feeds
      • How an RPDE data feed works
      • Types of RDPE feed
      • Implementing RPDE
      • Testing RPDE feeds
      • Scaling RPDE feeds
    • Activity list references
    • Including geo coordinates
    • Schedules
    • Dataset Sites
    • Virtual Events
    • On-Demand Events
    • Opening Hours
    • Data Quality
  • Using data
    • Harvesting opportunity data
      • Large Integers in JavaScript
    • Tutorial: Consuming an RPDE feed
    • Attribution
  • Open Booking API
    • Key Decisions
    • Implementing booking
    • Testing booking
      • Configuring Test Suite
      • Implementing the Test Interface
        • Test Interface Actions
        • Create Opportunity Endpoint
      • Random Mode: Generating Test Opportunity Data
      • Running Test Suite
      • Generating the Conformance Certificate
  • Data Model
    • Data Model Overview
    • @context and JSON-LD
    • Types Reference
      • Action
      • AudioObject
      • BabyChanging
      • Barcode
      • BookingService
      • BooleanFormFieldSpecification
      • Brand
      • ChangingFacilities
      • ConceptScheme
      • Concept
      • CourseInstance
      • Course
      • Creche
      • CustomerAccount
      • DataCatalog
      • DataDownload
      • Dataset
      • DropdownFormFieldSpecification
      • DynamicPayment
      • Entitlement
      • EventSeries
      • Event
      • FacilityUse
      • FileUploadFormFieldSpecification
      • GeoCoordinates
      • HeadlineEvent
      • ImageObject
      • IndividualFacilityUse
      • InternalApplicationError
      • InternalLibraryConfigurationError
      • InternalLibraryError
      • Lease
      • LocationFeatureSpecification
      • Lockers
      • MediaObject
      • OfferOverride
      • Offer
      • OnDemandEvent
      • OpenBookingError
      • OpeningHoursSpecification
      • OrderItem
      • OrderProposal
      • OrderQuote
      • Order
      • Organization
      • ParagraphFormFieldSpecification
      • Parking
      • PartialSchedule
      • Payment
      • Person
      • Place
      • PostalAddress
      • PriceSpecification
      • PrivacyPolicy
      • PropertyValueSpecification
      • PropertyValue
      • QuantitativeValue
      • Schedule
      • ScheduledSession
      • SessionSeries
      • ShortAnswerFormFieldSpecification
      • Showers
      • Slot
      • SportsActivityLocation
      • TaxChargeSpecification
      • TermsOfUse
      • Terms
      • Toilets
      • Towels
      • VideoObject
      • VirtualLocation
      • WebAPI
  • Specifications
    • Specifications Overview
  • Useful links
    • Data Visualiser
    • Data Validator
    • Dataset Dashboard
    • Non-technical Guidance
  • OpenActive on GitHub
    • Overview
    • Activity List
    • Community
    • Controlled Vocabularies
    • Dataset Publication
    • Documentation
    • Implementation Support
    • Programmes
    • RPDE
    • SKOS
    • Specifications
    • Validators
Powered by GitBook
On this page
  • Properties
  • Optional properties
Edit on GitHub
  1. Data Model
  2. Types Reference

OrderProposal

This page describes the OrderProposal type.

PreviousOrderItemNextOrderQuote

Last updated 10 months ago

This type is derived from , 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

Must always be present and set to "@type": "OrderProposal"

@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 .

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"

bookingService

Details about the Booking System

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 this is not required.

brokerRole

Either , or , as agreed in advance between the Broker and Seller.

customer

- or -

The person or organization purchasing the Order.

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

Except as otherwise noted, the content of this page is licensed under the , and code samples are licensed under the , for anyone to access, use and share; using attribution "".

  </td>
</tr>
<tr>
  <td style="text-align:left"><b>orderNumber</b></td>
  <td style="text-align:left">
    <a href="https://schema.org/Text"><code>Text</code></a>
  </td>
  <td style="text-align:left">
    <p>The Customer-facing identifier of the Order.</p>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>orderProposalStatus</b></td>
  <td style="text-align:left">
    <a href="https://openactive.io/OrderProposalStatus"><code>OrderProposalStatus</code></a>
  </td>
  <td style="text-align:left">
    
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>orderProposalVersion</b></td>
  <td style="text-align:left">
    <a href="https://schema.org/URL"><code>URL</code></a>
  </td>
  <td style="text-align:left">
    <p>The unique URL representing this version of the  OrderProposal, or the version of the OrderProposal to which this Order is related.</p>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>orderSellerNote</b></td>
  <td style="text-align:left">
    <a href="https://schema.org/Text"><code>Text</code></a>
  </td>
  <td style="text-align:left">
    
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>orderedItem</b></td>
  <td style="text-align:left">
    Array of <a href="https://developer.openactive.io/data-model/types/orderitem"><code>OrderItem</code></a>
  </td>
  <td style="text-align:left">
    <p>The items that constitute the Order.</p>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>payment</b></td>
  <td style="text-align:left">
    <a href="https://developer.openactive.io/data-model/types/payment"><code>Payment</code></a>
  </td>
  <td style="text-align:left">
    <p>The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.</p>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>seller</b></td>
  <td style="text-align:left">
    <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 style="text-align:left">
    <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>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>taxCalculationExcluded</b></td>
  <td style="text-align:left">
    <a href="https://schema.org/Boolean"><code>Boolean</code></a>
  </td>
  <td style="text-align:left">
    <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>
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>totalPaymentDue</b></td>
  <td style="text-align:left">
    <a href="https://developer.openactive.io/data-model/types/pricespecification"><code>PriceSpecification</code></a>
  </td>
  <td style="text-align:left">
    
  </td>
</tr>
<tr>
  <td style="text-align:left"><b>totalPaymentTax</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 Order.</p>
  </td>
</tr>
https://schema.org/Order
Creative Commons Attribution License (CC-BY V4.0)
MIT License
OpenActive
Text
URL
RFC3986
BookingService
Organization
https://openactive.io/NoBroker
BrokerType
https://openactive.io/AgentBroker
https://openactive.io/ResellerBroker
https://openactive.io/NoBroker
Person
Organization
Text
Lease
OrderCreationStatus
Text