Skip to main content
All requests take a per-brand token query parameter (shown as <token>). Base URL is https://api.operatorhub.travel/jsonservice/v1 unless noted.

​
availability

Live event availability for a product over a date range.
  • Required: productid (or productcode)
  • Optional: date, or startdate + enddate (Y-m-d). With no date, defaults to today.
  • Response: { "response": [ EventObject, … ] }
Request
Response (excerpt — example values)
Key fields: Quantity = total seats before bookings (the allocation); Remaining = bookable seats left; Description = free-text note (departure type + group holds, \n-separated); PurchasableVariationPrices[].PriceOnDate = the per-date price (dynamic-pricing-aware). See objects.

​
orders

A single order by id, or the first match of a filter. Note the /& form (trailing slash then &).
  • Required (one of): orderid, or filter[AgentReference], or filter[ExternalOrderID]
  • Optional: limit
  • Response: an OrderObject
By order id
By agent reference
By external order id
See OrderObject (includes Items[], Customer, Status, Agency, ExtraCustomers[]).

​
customerorders

The order ids a customer belongs to.
  • Required: customerid
  • Optional: limit
Request
The response is a list of order ids (commonly scalar ids under response).

​
customers

Find customers by a filter.
  • Required: a filter[...] (e.g. filter[Email], filter[Surname])
  • Optional: limit
  • Response: CustomerObject(s)
By email
By surname
See CustomerObject.

​
products

Product detail + pickup locations.
  • Optional: productid (single id or comma-separated list), productcode, live. With no parameters, returns all products.
  • Response: a ProductObject or array of them
Request
See ProductObject — carries Price, Variations[], ProductPickupLocations[], SpecialPrices[].

​
setcustomer

Edit an existing customer’s fields (a GET that mutates). Set field params first, customerid + token last.
  • Required: customerid
  • Optional: any CustomerObject field, plus tag groups (Tag<GroupID>)
  • Response: the updated CustomerObject

​
checkinview (unversioned)

The check-in manifest for a date. Unversioned — no /v1, path is /jsonservice/checkinview/search.
  • Required: checkinviewid, date (Y-m-d)
  • Response: { "response": { "Headers": [...], "Rows": [...] } } — a tabular manifest; columns vary per view.
Request