Travel Orbit booking API
Trips with live prices and places, guides, destinations, quotes, bookings and the traveller portal, for your own website.
The booking API lets your own website show trips with live prices and places and take bookings. It needs no key: it returns what the booking pages show anyway, and payments go straight from the traveller's browser to your Stripe account. A key is optional; a key that reads drafts (trv_sk_) works only from a server.
Any website may read the organisation, trips, guides and destinations. Quotes and bookings answer only your allowed websites and servers. Answers are JSON in data; errors are error with a code and a message you can show the traveller. Amounts are whole minor units. Lists come whole, with no pages.
Requests are limited for each network (IP address) and organisation: about 120 catalogue reads a minute (6,000 for a server calling with a key), 30 quotes, 5 bookings, 20 booking checks, 1 portal sign-in code and 2 code checks a minute, with short bursts allowed. Over the limit the answer is 429 rate_limited; no rate-limit headers are sent, so wait a minute and try again.
Read the guideOpenAPI 3.1 document
Try it settings
https://app.bifrostorbit.com/travel/api/public
Reading trips, guides and destinations needs no key. A public key (trv_pk_) from API keys in Travel Orbit counts your requests.
Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.
OrganisationBrand, organiser, guarantee and languages.
The organisation
GET/{slug}Key optional
What a booking page needs around the trips: brand, organiser, travel guarantee, languages and whether online payment works right now.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe organisation.dataOrganisationFields of data
slugstringbrandNamestringlogoUrlstring or nullcolourstring or nullcontactEmailstring or nullpaymentsobjectFields of payments
onlinebooleanWhether online payment works right now.
publishableKeystring or nullYour Stripe publishable key.
organiseranylegalName, registration and address.
guaranteeanyprovider and text.
termsUrlstring or nulllocalesstring[]The languages you offer, the main one first.
defaultLocalestringlocalestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds'Try it
Example answer
{ "data": { "slug": "northwilds", "brandName": "Northwilds", "logoUrl": "https://northwilds.com/logo.svg", "colour": "#1f4e46", "contactEmail": "trips@northwilds.com", "payments": { "online": true, "publishableKey": "pk_live_…" }, "organiser": { "legalName": "Northwilds AS", "registration": "NO 912 345 678", "address": "Markveien 35, 0554 Oslo, Norway" }, "guarantee": { "provider": "Reisegarantifondet", "text": "Your money is protected by the Norwegian travel guarantee fund." }, "termsUrl": "https://northwilds.com/terms/", "locales": [ "en", "nb" ], "defaultLocale": "en", "locale": "en", "fallback": [] }}TripsTrips with departures and prices.
List trips
GET/{slug}/tripsKey optional
Published, public trips, in the order they were created, all at once with no pages. With a key that reads drafts, draft trips too. Cacheable for 30 seconds.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
localestringqueryA language you offer, such as nb. Without it, your main language.
activitystringqueryOnly trips with this activity.
countrystringqueryTwo letters, such as NO.
categorystringqueryOnly trips in this category.
idsstringqueryUp to 100 trip ids, separated by commas. Also returns unlisted trips.
Responses
200OKThe trips.dataTrip[]Fields of data
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/trips'Try it
Example answer
{ "data": [ { "id": "6650f1c2a9e4b3d2c1f0ea01", "slug": "lofoten-ridge-walk", "name": "Lofoten ridge walk", "draft": false, "category": "Walking holidays", "tags": [ "Small group" ], "activities": [ "hiking" ], "countries": [ "NO" ], "areas": [ "Lofoten" ], "area": "Lofoten", "summary": "Seven days on the ridges and white beaches of Lofoten, with nights in red fishing cabins.", "badge": "New", "days": 7, "difficulty": "moderate", "groupSize": { "min": 4, "max": 12 }, "images": [ { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } ], "seo": { "title": "Lofoten ridge walk | Northwilds", "description": "Seven days on the ridges and beaches of Lofoten with a Northwilds guide.", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } }, "currency": "NOK", "priceFrom": 1240000, "currencies": [ "NOK", "EUR" ], "pricesFrom": { "NOK": 1240000, "EUR": 109000 }, "rating": { "average": 4.9, "count": 37 }, "bookingMode": "instant", "nextDeparture": "2027-06-14", "departures": [ { "id": "6650f1c2a9e4b3d2c1f0ea07", "startDate": "2027-06-14", "endDate": "2027-06-20", "flexible": false, "guaranteed": true, "status": "open", "seatsLeft": 6, "capacity": 12, "prices": { "per-person": 1240000 }, "priceFrom": 1240000, "pricesByCurrency": { "NOK": { "per-person": 1240000 }, "EUR": { "per-person": 109000 } }, "priceFromByCurrency": { "NOK": 1240000, "EUR": 109000 }, "bookingDeadline": "2027-05-31" } ], "cmsEntryId": null, "locale": "en", "fallback": [] } ]}Get a trip
GET/{slug}/trips/{tripSlug}Key optional
Everything in the list, plus the itinerary, packages, extras, payment plan, questions, guides and places to stay. An old address still answers, with the current slug.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
tripSlugstringpath, requiredThe trip's address.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe trip.dataTripDetailFields of data
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
descriptionstringHTML.
highlightsstring[]includedstring[]notIncludedstring[]itineraryany[]packagesany[]addOnsany[]paymentPlananyDeposit and instalments.
paymentPlanByCurrencymap of anycancellationanyThe cancellation terms.
questionsany[]Questions for the booking form.
travellerFieldsanyWhich traveller details are required.
travellersanyHow many travellers a booking may have.
guidesobject[]Fields of guides
namestringrolestringbiostringphotoany or any or nulllanguagesstring[]slugstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
staysobject[]Fields of stays
idstringnamestringlocationstringcountrystring or nullwebsitestring or nullratingnumber or nulldescriptionstringimagesImage[]nightsinteger
termsstringbrochureUrlstring or nullinvitationForstring or null
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/trips/lofoten-ridge-walk'Try it
Example answer
{ "data": { "id": "6650f1c2a9e4b3d2c1f0ea01", "slug": "lofoten-ridge-walk", "name": "Lofoten ridge walk", "draft": false, "category": "Walking holidays", "tags": [ "Small group" ], "activities": [ "hiking" ], "countries": [ "NO" ], "areas": [ "Lofoten" ], "area": "Lofoten", "summary": "Seven days on the ridges and white beaches of Lofoten, with nights in red fishing cabins.", "badge": "New", "days": 7, "difficulty": "moderate", "groupSize": { "min": 4, "max": 12 }, "images": [ { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } ], "seo": { "title": "Lofoten ridge walk | Northwilds", "description": "Seven days on the ridges and beaches of Lofoten with a Northwilds guide.", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } }, "currency": "NOK", "priceFrom": 1240000, "currencies": [ "NOK", "EUR" ], "pricesFrom": { "NOK": 1240000, "EUR": 109000 }, "rating": { "average": 4.9, "count": 37 }, "bookingMode": "instant", "nextDeparture": "2027-06-14", "departures": [ { "id": "6650f1c2a9e4b3d2c1f0ea07", "startDate": "2027-06-14", "endDate": "2027-06-20", "flexible": false, "guaranteed": true, "status": "open", "seatsLeft": 6, "capacity": 12, "prices": { "per-person": 1240000 }, "priceFrom": 1240000, "pricesByCurrency": { "NOK": { "per-person": 1240000 }, "EUR": { "per-person": 109000 } }, "priceFromByCurrency": { "NOK": 1240000, "EUR": 109000 }, "bookingDeadline": "2027-05-31" } ], "cmsEntryId": null, "locale": "en", "fallback": [], "description": "<p>Walk the ridges of Lofoten with the sea on both sides.</p>", "highlights": [ "Sunset from Reinebringen", "A night in a rorbu fishing cabin" ], "included": [ "Six nights in cabins", "All breakfasts", "A Northwilds guide" ], "notIncluded": [ "Flights to Leknes" ], "itinerary": [ { "day": 1, "title": "Arrive in Reine", "body": "Meet the group at the harbour for a short evening walk." } ], "packages": [ { "id": "per-person", "name": "Per person", "prices": { "per-person": 1240000 }, "pricesByCurrency": { "EUR": 109000 } } ], "addOns": [ { "id": "gear-hire", "name": "Boots and poles", "price": 45000, "pricesByCurrency": { "EUR": 4000 } } ], "paymentPlan": { "deposit": { "kind": "percent", "value": 20 }, "balanceDueDays": 60, "instalments": 1 }, "paymentPlanByCurrency": {}, "cancellation": { "text": "Free cancellation until 60 days before departure." }, "questions": [], "travellerFields": { "dateOfBirth": true, "nationality": false, "passport": false }, "travellers": { "min": 1, "max": 6 }, "guides": [ { "name": "Kari Nordmann", "role": "Mountain guide", "bio": "Kari grew up in Henningsvær and has led walks in Lofoten for twelve summers.", "photo": null, "languages": [ "en", "nb" ], "slug": "kari-nordmann", "image": null } ], "stays": [ { "id": "reine-rorbuer", "name": "Reine Rorbuer", "location": "Reine", "country": "NO", "website": "https://northwilds.com/stays/reine-rorbuer/", "rating": 4.6, "description": "Red fishing cabins on stilts above the harbour.", "images": [], "nights": 2 } ], "terms": "Bookings follow the Northwilds booking terms.", "brochureUrl": null, "invitationFor": null }}GuidesThe people who lead your trips.
List guides
GET/{slug}/guidesKey optional
Guides who lead a public trip or have a bio, by name, all at once. Cacheable for 60 seconds.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe guides.dataGuide[]Fields of data
slugstringMade from the name, such as kari-nordmann.
namestringrolestringbiostringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
any or null
languagesstring[]profileanyhome, since, quote, story, approach, loves, favourites and pickWhy.
tripCountintegerseoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/guides'Try it
Example answer
{ "data": [ { "slug": "kari-nordmann", "name": "Kari Nordmann", "role": "Mountain guide", "bio": "Kari grew up in Henningsvær and has led walks in Lofoten for twelve summers.", "image": null, "languages": [ "en", "nb" ], "profile": { "home": "Henningsvær", "since": 2014 }, "tripCount": 2, "seo": { "title": "Kari Nordmann | Northwilds", "description": "Mountain guide in Lofoten.", "image": null }, "locale": "en", "fallback": [] } ]}Get a guide
GET/{slug}/guides/{guideSlug}Key optional
Everything in the list, plus the public trips they lead and the trip they recommend.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
guideSlugstringpath, requiredThe guide's address.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe guide.dataGuideDetailFields of data
slugstringMade from the name, such as kari-nordmann.
namestringrolestringbiostringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
any or null
languagesstring[]profileanyhome, since, quote, story, approach, loves, favourites and pickWhy.
tripCountintegerseoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
tripsTrip[]pickTrip or any or nullFields of pick
One of:
Trip
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
any or null
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/guides/kari-nordmann'Try it
Example answer
{ "data": { "slug": "kari-nordmann", "name": "Kari Nordmann", "role": "Mountain guide", "bio": "Kari grew up in Henningsvær and has led walks in Lofoten for twelve summers.", "image": null, "languages": [ "en", "nb" ], "profile": { "home": "Henningsvær", "since": 2014 }, "tripCount": 2, "seo": { "title": "Kari Nordmann | Northwilds", "description": "Mountain guide in Lofoten.", "image": null }, "locale": "en", "fallback": [], "trips": [ { "id": "6650f1c2a9e4b3d2c1f0ea01", "slug": "lofoten-ridge-walk", "name": "Lofoten ridge walk", "draft": false, "category": "Walking holidays", "tags": [ "Small group" ], "activities": [ "hiking" ], "countries": [ "NO" ], "areas": [ "Lofoten" ], "area": "Lofoten", "summary": "Seven days on the ridges and white beaches of Lofoten, with nights in red fishing cabins.", "badge": "New", "days": 7, "difficulty": "moderate", "groupSize": { "min": 4, "max": 12 }, "images": [ { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } ], "seo": { "title": "Lofoten ridge walk | Northwilds", "description": "Seven days on the ridges and beaches of Lofoten with a Northwilds guide.", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } }, "currency": "NOK", "priceFrom": 1240000, "currencies": [ "NOK", "EUR" ], "pricesFrom": { "NOK": 1240000, "EUR": 109000 }, "rating": { "average": 4.9, "count": 37 }, "bookingMode": "instant", "nextDeparture": "2027-06-14", "departures": [ { "id": "6650f1c2a9e4b3d2c1f0ea07", "startDate": "2027-06-14", "endDate": "2027-06-20", "flexible": false, "guaranteed": true, "status": "open", "seatsLeft": 6, "capacity": 12, "prices": { "per-person": 1240000 }, "priceFrom": 1240000, "pricesByCurrency": { "NOK": { "per-person": 1240000 }, "EUR": { "per-person": 109000 } }, "priceFromByCurrency": { "NOK": 1240000, "EUR": 109000 }, "bookingDeadline": "2027-05-31" } ], "cmsEntryId": null, "locale": "en", "fallback": [] } ], "pick": { "id": "6650f1c2a9e4b3d2c1f0ea01", "slug": "lofoten-ridge-walk", "name": "Lofoten ridge walk", "draft": false, "category": "Walking holidays", "tags": [ "Small group" ], "activities": [ "hiking" ], "countries": [ "NO" ], "areas": [ "Lofoten" ], "area": "Lofoten", "summary": "Seven days on the ridges and white beaches of Lofoten, with nights in red fishing cabins.", "badge": "New", "days": 7, "difficulty": "moderate", "groupSize": { "min": 4, "max": 12 }, "images": [ { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } ], "seo": { "title": "Lofoten ridge walk | Northwilds", "description": "Seven days on the ridges and beaches of Lofoten with a Northwilds guide.", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } }, "currency": "NOK", "priceFrom": 1240000, "currencies": [ "NOK", "EUR" ], "pricesFrom": { "NOK": 1240000, "EUR": 109000 }, "rating": { "average": 4.9, "count": 37 }, "bookingMode": "instant", "nextDeparture": "2027-06-14", "departures": [ { "id": "6650f1c2a9e4b3d2c1f0ea07", "startDate": "2027-06-14", "endDate": "2027-06-20", "flexible": false, "guaranteed": true, "status": "open", "seatsLeft": 6, "capacity": 12, "prices": { "per-person": 1240000 }, "priceFrom": 1240000, "pricesByCurrency": { "NOK": { "per-person": 1240000 }, "EUR": { "per-person": 109000 } }, "priceFromByCurrency": { "NOK": 1240000, "EUR": 109000 }, "bookingDeadline": "2027-05-31" } ], "cmsEntryId": null, "locale": "en", "fallback": [] } }}DestinationsContinents and countries.
List destinations
GET/{slug}/destinationsKey optional
Continents and countries your public trips visit, plus countries published without trips. Cacheable for 5 minutes.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe continents.dataContinentSummary[]Fields of data
keystringSuch as europe.
namestringpublishedbooleantaglinestring or nullcoverany or any or nullurl and alt.
countriesCountrySummary[]localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations'Try it
Example answer
{ "data": [ { "key": "europe", "name": "Europe", "published": true, "tagline": "From the Arctic to the Alps.", "cover": null, "countries": [ { "code": "NO", "slug": "norway", "name": "Norway", "flag": "https://app.bifrostorbit.com/travel/flags/no.svg", "tripCount": 3, "published": true, "tagline": "Fjords, ridges and the midnight sun.", "cover": { "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "alt": "Walkers on a grassy ridge above the sea in Lofoten" }, "locale": "en", "fallback": [] } ], "locale": "en", "fallback": [] } ]}Get a continent
GET/{slug}/destinations/{continent}Key optional
A continent with its countries, and your introduction once published.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
continentstringpath, requiredSuch as europe.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe continent.dataContinentFields of data
keystringSuch as europe.
namestringpublishedbooleantaglinestring or nullcoverany or any or nullurl and alt.
countriesCountrySummary[]localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
contentContent or any or nullOnce you publish its introduction.
Fields of content
One of:
Content
headingstringtaglinestringintrostringguidestringimagesany[]bestTimestringentrystringseoobjectFields of seo
titlestringdescriptionstring
any or null
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations/europe'Try it
Example answer
{ "data": { "key": "europe", "name": "Europe", "published": true, "tagline": "From the Arctic to the Alps.", "cover": null, "countries": [ { "code": "NO", "slug": "norway", "name": "Norway", "flag": "https://app.bifrostorbit.com/travel/flags/no.svg", "tripCount": 3, "published": true, "tagline": "Fjords, ridges and the midnight sun.", "cover": { "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "alt": "Walkers on a grassy ridge above the sea in Lofoten" }, "locale": "en", "fallback": [] } ], "locale": "en", "fallback": [], "content": { "heading": "Walking in Norway", "tagline": "Fjords, ridges and the midnight sun.", "intro": "Norway is made for walking.", "guide": "<p>June to August brings long light evenings.</p>", "images": [], "bestTime": "June to September", "entry": "No visa for EU and UK citizens for short stays.", "seo": { "title": "Walking holidays in Norway | Northwilds", "description": "Guided walks in Lofoten and the fjords." } } }}Get a country
GET/{slug}/destinations/{continent}/{country}Key optional
Facts, your text, trips, local time, weather and the exchange rate. A country with neither trips nor published text is 404.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
continentstringpath, requiredSuch as europe.
countrystringpath, requiredThe country's slug or two-letter code.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe country.dataCountryFields of data
codestringslugstringnamestringflagstringcontinentobjectFields of continent
keystringnamestring
factsanyname, officialName, continent, capital, languages, religion, vaccines, drivingSide, callingCode, currency, timeZone, capitalAt, centre and mapId.
labelsmap of stringTile headings in the chosen language.
contentContent or any or nullFields of content
One of:
Content
headingstringtaglinestringintrostringguidestringimagesany[]bestTimestringentrystringseoobjectFields of seo
titlestringdescriptionstring
any or null
tripsTrip[]liveanytimeZone, weather (temperature, symbol, description, icon, at, credit, or null) and rate (from, to, rate, date). Show weather.credit wherever you show the weather.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenA key that reads drafts, sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name, or no published trip or destination there.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many requests from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations/europe/norway'Try it
Example answer
{ "data": { "code": "NO", "slug": "norway", "name": "Norway", "flag": "https://app.bifrostorbit.com/travel/flags/no.svg", "continent": { "key": "europe", "name": "Europe" }, "facts": { "name": "Norway", "officialName": "Kingdom of Norway", "capital": "Oslo", "languages": [ "Norwegian" ], "drivingSide": "right", "callingCode": "+47", "currency": "NOK", "timeZone": "Europe/Oslo" }, "labels": { "capital": "Capital", "languages": "Languages", "currency": "Currency" }, "content": { "heading": "Walking in Norway", "tagline": "Fjords, ridges and the midnight sun.", "intro": "Norway is made for walking.", "guide": "<p>June to August brings long light evenings.</p>", "images": [], "bestTime": "June to September", "entry": "No visa for EU and UK citizens for short stays.", "seo": { "title": "Walking holidays in Norway | Northwilds", "description": "Guided walks in Lofoten and the fjords." } }, "trips": [ { "id": "6650f1c2a9e4b3d2c1f0ea01", "slug": "lofoten-ridge-walk", "name": "Lofoten ridge walk", "draft": false, "category": "Walking holidays", "tags": [ "Small group" ], "activities": [ "hiking" ], "countries": [ "NO" ], "areas": [ "Lofoten" ], "area": "Lofoten", "summary": "Seven days on the ridges and white beaches of Lofoten, with nights in red fishing cabins.", "badge": "New", "days": 7, "difficulty": "moderate", "groupSize": { "min": 4, "max": 12 }, "images": [ { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } ], "seo": { "title": "Lofoten ridge walk | Northwilds", "description": "Seven days on the ridges and beaches of Lofoten with a Northwilds guide.", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } } }, "currency": "NOK", "priceFrom": 1240000, "currencies": [ "NOK", "EUR" ], "pricesFrom": { "NOK": 1240000, "EUR": 109000 }, "rating": { "average": 4.9, "count": 37 }, "bookingMode": "instant", "nextDeparture": "2027-06-14", "departures": [ { "id": "6650f1c2a9e4b3d2c1f0ea07", "startDate": "2027-06-14", "endDate": "2027-06-20", "flexible": false, "guaranteed": true, "status": "open", "seatsLeft": 6, "capacity": 12, "prices": { "per-person": 1240000 }, "priceFrom": 1240000, "pricesByCurrency": { "NOK": { "per-person": 1240000 }, "EUR": { "per-person": 109000 } }, "priceFromByCurrency": { "NOK": 1240000, "EUR": 109000 }, "bookingDeadline": "2027-05-31" } ], "cmsEntryId": null, "locale": "en", "fallback": [] } ], "live": { "timeZone": "Europe/Oslo", "weather": { "temperature": 4, "symbol": "cloudy", "description": "Cloudy", "icon": "cloudy", "at": "2026-11-10T09:30:00.000Z", "credit": "Weather from MET Norway" }, "rate": { "from": "EUR", "to": "NOK", "rate": 11.42, "date": "2026-11-10" } }, "locale": "en", "fallback": [] }}BookingQuotes, bookings and checking a booking.
Price a booking
POST/{slug}/quoteKey optional
Prices a booking without saving anything. Call it whenever the traveller changes their choices. 30 a minute.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Request body
departureIdstringrequired
Up to 24 items.travellersobject[]requiredFields of travellers
Default null.packageIdstring or any or nulloptional
Default []. Up to 40 items.addOnsobject[]optionalFields of addOns
Up to 40 characters.idstringrequired
At least 0. At most 24.quantityintegerrequired
Default null.discountCodestring or any or nulloptional
Default null.currencystring or any or nulloptional
Default null.localestring or any or nulloptional
Responses
200OKThe price.dataQuoteFields of data
currencystringlinesobject[]Fields of lines
idstring
One of package, addOn, discount.kindstringrefIdstring or nulllabelstringunitAmountintegerquantityintegeramountinteger
subtotalintegerBefore the discount. In minor units, so 124000 with EUR is €1,240.00.
discountintegerTaken off. In minor units, so 124000 with EUR is €1,240.00.
totalintegerThe total. In minor units, so 124000 with EUR is €1,240.00.
codestring or nullThe discount code used.
scheduleobject[]Fields of schedule
labelstringdueDatestringamountinteger
dueNowintegerPaid at checkout. In minor units, so 124000 with EUR is €1,240.00.
seatsLeftinteger or null
400Bad requestThe booking can't be made as asked, such as a currency the trip isn't sold in or a departure that has closed.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
409ConflictNot enough places left, or an extra sold out.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableA field is missing or in the wrong format.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/quote' \ -H 'Content-Type: application/json' \ -d '{"departureId":"6650f1c2a9e4b3d2c1f0ea07","travellers":[{"packageId":"per-person"},{"packageId":"per-person"}],"addOns":[{"id":"gear-hire","quantity":2}],"currency":"NOK","locale":"nb"}'Try it
It answers only your allowed websites, so a browser on the docs gets 403. Use the API playground in Travel Orbit.
Example answer
{ "data": { "currency": "NOK", "lines": [ { "id": "package-per-person", "kind": "package", "refId": "per-person", "label": "Per person", "unitAmount": 1240000, "quantity": 2, "amount": 2480000 }, { "id": "addon-gear-hire", "kind": "addOn", "refId": "gear-hire", "label": "Boots and poles", "unitAmount": 45000, "quantity": 2, "amount": 90000 } ], "subtotal": 2570000, "discount": 0, "total": 2570000, "code": null, "schedule": [ { "label": "Deposit", "dueDate": "2026-11-10", "amount": 514000 }, { "label": "Balance", "dueDate": "2027-04-15", "amount": 2056000 } ], "dueNow": 514000, "seatsLeft": 6 }}Make a booking
POST/{slug}/bookingsKey optional
Holds places and starts the payment, or sends a request when the trip takes requests or online payment is off. A held booking keeps its places until holdExpiresAt.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Request body
departureIdstringrequiredleadobjectrequiredFields of lead
Up to 80 characters.firstNamestringrequired
Up to 80 characters.lastNamestringrequiredemailstringrequired
Default null.phonestring or any or nulloptional
Up to 24 items.travellersobject[]requiredFields of travellers
Up to 80 characters.firstNamestringrequired
Up to 80 characters.lastNamestringrequired
Default null.emailstring or any or nulloptional
Default null.phonestring or any or nulloptional
Default null.dateOfBirthstring or any or nulloptional
Default null.nationalitystring or any or nulloptional
Default null.passportstring or any or nulloptional
Default null.addressstring or any or nulloptional
Default null.dietarystring or any or nulloptional
Default null.emergencyContactstring or any or nulloptional
Default null.packageIdstring or any or nulloptional
Default {}.answersmap of string or booleanoptional
Default []. Up to 40 items.addOnsobject[]optionalFields of addOns
Up to 40 characters.idstringrequired
At least 0. At most 24.quantityintegerrequired
Default null.discountCodestring or any or nulloptional
Default null.currencystring or any or nulloptional
Default {}.answersmap of string or booleanoptional
Default null.messagestring or any or nulloptional
Default null.localestring or any or nulloptionalacceptTermstruerequired
Responses
201CreatedThe booking, and the payment to take or null.dataobjectFields of data
bookingBookingpaymentPayment or any or nullFields of payment
One of:
Payment
kindstringpayment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.
One of payment, setup.clientSecretstringpublishableKeystringamountintegercurrencystring
any or null
400Bad requestThe booking can't be made as asked, such as a missing traveller detail or answer.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
409ConflictNot enough places left, or a package or extra sold out.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableA field is missing or in the wrong format.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/bookings' \ -H 'Content-Type: application/json' \ -d '{"departureId":"6650f1c2a9e4b3d2c1f0ea07","lead":{"firstName":"Ingrid","lastName":"Berg","email":"ingrid@northwilds.com","phone":"+47 912 34 567"},"travellers":[{"firstName":"Ingrid","lastName":"Berg","dateOfBirth":"1990-04-12","packageId":"per-person"}],"addOns":[{"id":"gear-hire","quantity":1}],"currency":"NOK","locale":"en","acceptTerms":true}'Try it
It holds real places and emails the traveller.
Example answer
{ "data": { "booking": { "id": "6650f1c2a9e4b3d2c1f0ea51", "reference": "NO-7KQ2MX", "status": "held", "total": 1240000, "currency": "NOK", "schedule": [ { "id": "deposit", "label": "Deposit", "dueDate": "2026-11-10", "amount": 248000, "status": "due" }, { "id": "balance", "label": "Balance", "dueDate": "2027-04-15", "amount": 992000, "status": "due" } ], "holdExpiresAt": "2026-11-10T10:00:00.000Z" }, "payment": { "kind": "payment", "clientSecret": "pi_3QkNorthwilds_secret_…", "publishableKey": "pk_live_…", "amount": 248000, "currency": "NOK" } }}Check a booking after payment
POST/{slug}/bookings/{reference}/checkKey optional
With the lead traveller's email. When the booking is still held or has expired, Travel Orbit asks Stripe first.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
referencestringpath, requiredSuch as NO-7KQ2MX.
Request body
emailstringrequired
Responses
200OKThe booking.dataobjectFields of data
bookingBooking
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundAn unknown reference, or an email that doesn't match.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableNo email.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/bookings/NO-7KQ2MX/check' \ -H 'Content-Type: application/json' \ -d '{"email":"ingrid@northwilds.com"}'Try it
It needs a real booking.
Example answer
{ "data": { "booking": { "id": "6650f1c2a9e4b3d2c1f0ea51", "reference": "NO-7KQ2MX", "status": "confirmed", "total": 1240000, "currency": "NOK", "schedule": [ { "id": "deposit", "label": "Deposit", "dueDate": "2026-11-10", "amount": 248000, "status": "paid" }, { "id": "balance", "label": "Balance", "dueDate": "2027-04-15", "amount": 992000, "status": "due" } ], "holdExpiresAt": null } }}Traveller portalTravellers sign in with an email code; call these from your server.
Send a sign-in code
POST/{slug}/portal/codeNo key
Emails a 6-digit code, valid for 10 minutes. Always answers { sent: true }, but only sends to an email with a booking, at most once every 45 seconds.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Request body
emailstringrequiredlocalestringoptional
Responses
200OKSent, or not, without saying which.dataobjectFields of data
senttrue
400Bad requestNot an email address.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableNo email.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/code' \ -H 'Content-Type: application/json' \ -d '{"email":"ingrid@northwilds.com","locale":"en"}'Try it
It emails a real traveller.
Example answer
{ "data": { "sent": true }}Check the code
POST/{slug}/portal/verifyNo key
Checks the code (5 tries) and sets the travel.portal session cookie for 12 hours.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Request body
emailstringrequiredcodestringrequired
Responses
200OKSigned in.dataobjectFields of data
emailstring
400Bad requestA wrong or expired code.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableNo code.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/verify' \ -H 'Content-Type: application/json' \ -d '{"email":"ingrid@northwilds.com","code":"482913"}'Try it
It needs a code from a real inbox.
Example answer
{ "data": { "email": "ingrid@northwilds.com" }}Sign out
DELETE/{slug}/portal/verifyNo key
Ends the session.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
Responses
200OKSigned out.dataobjectFields of data
signedOuttrue
401UnauthorisedA key that is wrong, revoked, expired or for another organisation.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X DELETE 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/verify' \ -H 'Cookie: travel.portal=…'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "signedOut": true }}The traveller's bookings
GET/{slug}/portal/bookingsNo key
With what is paid and what is due, all at once.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
localestringqueryA language you offer, such as nb. Without it, your main language.
Responses
200OKThe signed-in email, the language used and the bookings.dataobjectFields of data
emailstringlocalestringbookingsPortalBooking[]
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo organisation with that booking name.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/bookings' \ -H 'Cookie: travel.portal=…'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "email": "ingrid@northwilds.com", "locale": "en", "bookings": [ { "reference": "NO-7KQ2MX", "leadFirstName": "Ingrid", "tripName": "Lofoten ridge walk", "tripSlug": "lofoten-ridge-walk", "image": { "id": "6650f1c2a9e4b3d2c1f0ea31", "url": "https://media.bifrostorbit.com/northwilds/lofoten-ridge.jpg", "mimeType": "image/jpeg", "width": 2400, "height": 1600, "alt": "Walkers on a grassy ridge above the sea in Lofoten", "title": null, "focalPoint": { "x": 0.5, "y": 0.4 } }, "days": 7, "departureDate": "2027-06-14", "status": "confirmed", "travellers": [ { "id": "t1", "firstName": "Ingrid", "lastName": "Berg", "phone": "+47 912 34 567", "dateOfBirth": "1990-04-12", "nationality": "Norwegian", "passport": "NO1234567", "dietary": null, "emergencyContact": "Ola Berg, +47 913 45 678" } ], "payments": [ { "id": "6650f1c2a9e4b3d2c1f0ea71", "kind": "deposit", "method": "card", "amount": 248000, "currency": "NOK", "at": "2026-11-10T09:30:00.000Z" } ], "lines": [ { "label": "Per person", "quantity": 1, "amount": 1240000 } ], "currency": "NOK", "total": 1240000, "paid": 248000, "schedule": [ { "id": "deposit", "label": "Deposit", "dueDate": "2026-11-10", "amount": 248000, "status": "paid" }, { "id": "balance", "label": "Balance", "dueDate": "2027-04-15", "amount": 992000, "status": "due" } ], "autoCharge": true, "cardSaved": true } ] }}Pay what is due
POST/{slug}/portal/payNo key
Starts a payment for the next instalment, everything left or chosen instalments. instalments is next unless you say.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
Request body
referencestringrequiredinstalmentsstring or string[]optional
Responses
200OKThe payment.dataobjectFields of data
paymentPayment or any or nullFields of payment
One of:
Payment
kindstringpayment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.
One of payment, setup.clientSecretstringpublishableKeystringamountintegercurrencystring
any or null
400Bad requestThe booking can't take payments, nothing is due, or online payment is off.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo booking with that reference for the signed-in traveller.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableNo reference.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/pay' \ -H 'Cookie: travel.portal=…' \ -H 'Content-Type: application/json' \ -d '{"reference":"NO-7KQ2MX","instalments":"next"}'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "payment": { "kind": "payment", "clientSecret": "pi_3QkNorthwilds_secret_…", "publishableKey": "pk_live_…", "amount": 992000, "currency": "NOK" } }}Automatic payments
POST/{slug}/portal/auto-chargeNo key
Turns automatic payments from the saved card on or off.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
Request body
referencestringrequiredonbooleanrequired
Responses
200OKChanged.dataobjectFields of data
referencestringautoChargeboolean
400Bad requestNo card saved yet.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo booking with that reference for the signed-in traveller.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableA field is missing.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/auto-charge' \ -H 'Cookie: travel.portal=…' \ -H 'Content-Type: application/json' \ -d '{"reference":"NO-7KQ2MX","on":true}'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "reference": "NO-7KQ2MX", "autoCharge": true }}The conversation about a booking
GET/{slug}/portal/messagesNo key
Messages between the traveller and your team, all at once.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
referencestringquery, requiredThe booking.
Responses
200OKThe messages.dataobjectFields of data
referencestringmessagesany[]
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo booking with that reference for the signed-in traveller.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableNo reference.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/messages?reference=NO-7KQ2MX' \ -H 'Cookie: travel.portal=…'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "reference": "NO-7KQ2MX", "messages": [ { "id": "6650f1c2a9e4b3d2c1f0ea61", "kind": "traveller", "author": "Ingrid Berg", "authorId": null, "body": "Can I bring my own walking poles?", "emailed": null, "via": "portal", "at": "2026-11-10T09:30:00.000Z" }, { "id": "6650f1c2a9e4b3d2c1f0ea62", "kind": "reply", "author": "Kari Nordmann", "authorId": "6650f1c2a9e4b3d2c1f0ea81", "body": "Of course. Bring them along, and we have spares in Reine.", "emailed": true, "via": null, "at": "2026-11-10T09:30:00.000Z" } ] }}Send a message
POST/{slug}/portal/messagesNo key
Sends the traveller's message to your team.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
Request body
referencestringrequiredbodystringrequired
Responses
200OKThe message sent.dataobjectFields of data
messageany
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo booking with that reference for the signed-in traveller.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableA field is missing.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/messages' \ -H 'Cookie: travel.portal=…' \ -H 'Content-Type: application/json' \ -d '{"reference":"NO-7KQ2MX","body":"Can I bring my own walking poles?"}'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "message": { "id": "6650f1c2a9e4b3d2c1f0ea61", "kind": "traveller", "author": "Ingrid Berg", "authorId": null, "body": "Can I bring my own walking poles?", "emailed": null, "via": "portal", "at": "2026-11-10T09:30:00.000Z" } }}Update a traveller
POST/{slug}/portal/travellersNo key
Until the trip starts. Only phone, dateOfBirth, nationality, passport, dietary and emergencyContact can change.
Parameters
slugstringpath, requiredYour booking name from Booking settings, such as northwilds.
Cookiestringheader, requiredtravel.portal=… from the verify answer. Call the portal from your own server.
Request body
referencestringrequiredtravellerIdstringrequiredchangesmap of string or nullrequired
Responses
200OKThe booking's travellers.dataobjectFields of data
travellersany[]
400Bad requestThe booking is cancelled or the trip has started.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
401UnauthorisedNo signed-in traveller, or a key that isn't valid.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
403ForbiddenThe website isn't in the allowed websites, or a key that reads drafts was sent from a browser.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
404Not foundNo such booking or traveller for the signed-in traveller.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
422UnprocessableA field is missing or too long.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
curl -X POST 'https://app.bifrostorbit.com/travel/api/public/northwilds/portal/travellers' \ -H 'Cookie: travel.portal=…' \ -H 'Content-Type: application/json' \ -d '{"reference":"NO-7KQ2MX","travellerId":"t1","changes":{"passport":"NO1234567"}}'Try it
It needs a traveller signed in to the portal.
Example answer
{ "data": { "travellers": [ { "id": "t1", "firstName": "Ingrid", "lastName": "Berg", "phone": "+47 912 34 567", "dateOfBirth": "1990-04-12", "nationality": "Norwegian", "passport": "NO1234567", "dietary": null, "emergencyContact": "Ola Berg, +47 913 45 678" } ] }}SchemasThe shapes the endpoints above answer with and take.
Error
errorobjectFields of error
codestringinvalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.
messagestringWords you can show the traveller, in the language of the request.
issuesany[]sometimesOn 422: each field that failed, with its path and message.
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
Organisation
slugstringbrandNamestringlogoUrlstring or nullcolourstring or nullcontactEmailstring or nullpaymentsobjectFields of payments
onlinebooleanWhether online payment works right now.
publishableKeystring or nullYour Stripe publishable key.
organiseranylegalName, registration and address.
guaranteeanyprovider and text.
termsUrlstring or nulllocalesstring[]The languages you offer, the main one first.
defaultLocalestringlocalestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
Departure
idstringstartDatestringSuch as 2027-05-14.
endDatestring or nullflexiblebooleanDates to be decided.
guaranteedboolean
One of open, full, closed.statusstringseatsLeftinteger or nullnull for no limit.
capacityinteger or nullpricesmap of integerBy package id, in the main currency.
priceFrominteger or nullpricesByCurrencymap of map of integerBy currency, then by package id.
priceFromByCurrencymap of integerBy currency, such as EUR and NOK.
bookingDeadlinestring or null
Trip
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
TripDetail
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
descriptionstringHTML.
highlightsstring[]includedstring[]notIncludedstring[]itineraryany[]packagesany[]addOnsany[]paymentPlananyDeposit and instalments.
paymentPlanByCurrencymap of anycancellationanyThe cancellation terms.
questionsany[]Questions for the booking form.
travellerFieldsanyWhich traveller details are required.
travellersanyHow many travellers a booking may have.
guidesobject[]Fields of guides
namestringrolestringbiostringphotoany or any or nulllanguagesstring[]slugstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
staysobject[]Fields of stays
idstringnamestringlocationstringcountrystring or nullwebsitestring or nullratingnumber or nulldescriptionstringimagesImage[]nightsinteger
termsstringbrochureUrlstring or nullinvitationForstring or null
Guide
slugstringMade from the name, such as kari-nordmann.
namestringrolestringbiostringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
any or null
languagesstring[]profileanyhome, since, quote, story, approach, loves, favourites and pickWhy.
tripCountintegerseoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
GuideDetail
slugstringMade from the name, such as kari-nordmann.
namestringrolestringbiostringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
any or null
languagesstring[]profileanyhome, since, quote, story, approach, loves, favourites and pickWhy.
tripCountintegerseoobjectFields of seo
titlestringdescriptionstringimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or null
any or null
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
tripsTrip[]pickTrip or any or nullFields of pick
One of:
Trip
idstringslugstringSuch as lofoten-ridge-walk.
namestringdraftbooleanOnly with a key that reads drafts.
categorystring or nulltagsstring[]activitiesstring[]countriesstring[]Two letters each.
areasstring[]areastring or nullThe areas joined with commas.
summarystringbadgestring or nulldaysinteger or nulldifficultyany or any or nullThe difficulty set on the trip.
groupSizeanymin and max.
imagesImage[]seoobjectFields of seo
titlestringdescriptionstringimageImage or any or null
currencystringThe trip's main currency.
priceFrominteger or nullThe lowest price in the main currency. In minor units, so 124000 with EUR is €1,240.00.
currenciesstring[]Every currency it is sold in, the main one first.
pricesFrommap of integerBy currency, such as EUR and NOK.
ratingany or any or nullaverage and count.
One of instant, request, closed.bookingModestringnextDeparturestring or nulldeparturesDeparture[]cmsEntryIdstring or nullThe CMS Orbit entry for the trip page, when linked.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
any or null
CountrySummary
codestringTwo letters.
slugstringnamestringflagstringA round SVG flag.
tripCountintegerpublishedbooleantaglinestring or nullcoverany or any or nullurl and alt.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
ContinentSummary
keystringSuch as europe.
namestringpublishedbooleantaglinestring or nullcoverany or any or nullurl and alt.
countriesCountrySummary[]localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
Content
headingstringtaglinestringintrostringguidestringimagesany[]bestTimestringentrystringseoobjectFields of seo
titlestringdescriptionstring
Continent
keystringSuch as europe.
namestringpublishedbooleantaglinestring or nullcoverany or any or nullurl and alt.
countriesCountrySummary[]localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
contentContent or any or nullOnce you publish its introduction.
Fields of content
One of:
Content
headingstringtaglinestringintrostringguidestringimagesany[]bestTimestringentrystringseoobjectFields of seo
titlestringdescriptionstring
any or null
Country
codestringslugstringnamestringflagstringcontinentobjectFields of continent
keystringnamestring
factsanyname, officialName, continent, capital, languages, religion, vaccines, drivingSide, callingCode, currency, timeZone, capitalAt, centre and mapId.
labelsmap of stringTile headings in the chosen language.
contentContent or any or nullFields of content
One of:
Content
headingstringtaglinestringintrostringguidestringimagesany[]bestTimestringentrystringseoobjectFields of seo
titlestringdescriptionstring
any or null
tripsTrip[]liveanytimeZone, weather (temperature, symbol, description, icon, at, credit, or null) and rate (from, to, rate, date). Show weather.credit wherever you show the weather.
localestringfallbackstring[]Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.
Quote
currencystringlinesobject[]Fields of lines
idstring
One of package, addOn, discount.kindstringrefIdstring or nulllabelstringunitAmountintegerquantityintegeramountinteger
subtotalintegerBefore the discount. In minor units, so 124000 with EUR is €1,240.00.
discountintegerTaken off. In minor units, so 124000 with EUR is €1,240.00.
totalintegerThe total. In minor units, so 124000 with EUR is €1,240.00.
codestring or nullThe discount code used.
scheduleobject[]Fields of schedule
labelstringdueDatestringamountinteger
dueNowintegerPaid at checkout. In minor units, so 124000 with EUR is €1,240.00.
seatsLeftinteger or null
QuoteInput
departureIdstring
Up to 24 items.travellersobject[]Fields of travellers
Default null.packageIdstring or any or nullsometimes
Default []. Up to 40 items.addOnsobject[]sometimesFields of addOns
Up to 40 characters.idstring
At least 0. At most 24.quantityinteger
Default null.discountCodestring or any or nullsometimes
Default null.currencystring or any or nullsometimes
Default null.localestring or any or nullsometimes
BookingInput
departureIdstringleadobjectFields of lead
Up to 80 characters.firstNamestring
Up to 80 characters.lastNamestringemailstring
Default null.phonestring or any or nullsometimes
Up to 24 items.travellersobject[]Fields of travellers
Up to 80 characters.firstNamestring
Up to 80 characters.lastNamestring
Default null.emailstring or any or nullsometimes
Default null.phonestring or any or nullsometimes
Default null.dateOfBirthstring or any or nullsometimes
Default null.nationalitystring or any or nullsometimes
Default null.passportstring or any or nullsometimes
Default null.addressstring or any or nullsometimes
Default null.dietarystring or any or nullsometimes
Default null.emergencyContactstring or any or nullsometimes
Default null.packageIdstring or any or nullsometimes
Default {}.answersmap of string or booleansometimes
Default []. Up to 40 items.addOnsobject[]sometimesFields of addOns
Up to 40 characters.idstring
At least 0. At most 24.quantityinteger
Default null.discountCodestring or any or nullsometimes
Default null.currencystring or any or nullsometimes
Default {}.answersmap of string or booleansometimes
Default null.messagestring or any or nullsometimes
Default null.localestring or any or nullsometimesacceptTermstrue
Booking
idstringreferencestringSuch as NO-7KQ2MX.
statusstringheld, requested, confirmed, expired or cancelled.
totalintegercurrencystringscheduleobject[]Fields of schedule
idstringlabelstringdueDatestringamountinteger
One of due, paid, failed, waived.statusstring
holdExpiresAtstring or nullPlaces are kept until then.
Payment
kindstringpayment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.
One of payment, setup.clientSecretstringpublishableKeystringamountintegercurrencystring
PortalBooking
referencestringleadFirstNamestringtripNamestringtripSlugstring or nullimageImage or any or nullFields of image
One of:
Image
idstring or nullurlstringTakes ?w= and ?format= (webp, avif or jpeg) for images from the media library.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullfocalPointobject or nullFields of focalPoint
xnumberynumber
any or null
daysinteger or nulldepartureDatestring or nullstatusstringtravellersobject[]Fields of travellers
idstringfirstNamestringlastNamestringphonestring or nulldateOfBirthstring or nullnationalitystring or nullpassportstring or nulldietarystring or nullemergencyContactstring or null
paymentsobject[]Fields of payments
idstringkindstringmethodstringamountintegercurrencystringatstring
linesobject[]Fields of lines
labelstringquantityintegeramountinteger
currencystringtotalintegerpaidintegerscheduleobject[]Fields of schedule
idstringlabelstringdueDatestringamountintegerstatusstring
autoChargebooleancardSavedboolean