search

openactive / open-booking-api

Repository for the Open Booking API specification
Other
2 stars 3 forks source link

Allow broker to send a reference identifier and URL #213

Open nickevansuk opened 3 years ago

nickevansuk commented 3 years ago

There are cases where the Broker has an internal order reference, and also where the Broker has a URL that can be displayed within the Booking System (e.g. to open a Seller admin panel that displays the Order within the Broker).

To allow the broker to optionally include either of the above, something like this might be appropriate: 

{
  "@type": "Order",
  "brokerReference": {
    "@type": "Order",
    "orderNumber": "AB000001",
    "url": "https://example-broker.com/orders/AB000001",
  },
  "payment": {
    "@type": "Payment",
    "url": "https://connect.stripe.com/express/3nTY2IyFR3ZM",
    ...
  },
  ...
}

Note that the root Order belongs to the Booking System