Order

This page describes the Order 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

@type

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

@id

A unique URI-based identifier for the record.

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"

bookingService

Details about the Booking System

broker

brokerRole

customer

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"

orderCreationStatus

This property is internal to the Broker in this version of the specification.

orderNumber

The Customer-facing identifier of the Order.

orderProposalVersion

The unique URL representing this version of the OrderProposal, or the version of the OrderProposal to which this Order is related.

orderedItem

The items that constitute the Order.

payment

The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.

seller

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.

taxCalculationExcluded

Set to true when business-to-business tax calculation is required by the seller or brokerRole settings, but not supported by the Broker.

totalPaymentDue

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 updated