Skip to content

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, required

    Your booking name from Booking settings, such as northwilds.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe organisation.
    • dataOrganisation

      Fields of data
      • slugstring

      • brandNamestring

      • logoUrlstring or null

      • colourstring or null

      • contactEmailstring or null

      • paymentsobject

        Fields of payments
        • onlineboolean

          Whether online payment works right now.

        • publishableKeystring or null

          Your Stripe publishable key.

      • organiserany

        legalName, registration and address.

      • guaranteeany

        provider and text.

      • termsUrlstring or null

      • localesstring[]

        The languages you offer, the main one first.

      • defaultLocalestring

      • localestring

      • fallbackstring[]

        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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

  • activitystringquery

    Only trips with this activity.

  • countrystringquery

    Two letters, such as NO.

  • categorystringquery

    Only trips in this category.

  • idsstringquery

    Up to 100 trip ids, separated by commas. Also returns unlisted trips.

Responses

  • 200OKThe trips.
    • dataTrip[]

      Fields of data
      • idstring

      • slugstring

        Such as lofoten-ridge-walk.

      • namestring

      • draftboolean

        Only with a key that reads drafts.

      • categorystring or null

      • tagsstring[]

      • activitiesstring[]

      • countriesstring[]

        Two letters each.

      • areasstring[]

      • areastring or null

        The areas joined with commas.

      • summarystring

      • badgestring or null

      • daysinteger or null

      • difficultyany or any or null

        The difficulty set on the trip.

      • groupSizeany

        min and max.

      • imagesImage[]

        Fields of Image

      • seoobject

        Fields of seo
        • titlestring

        • descriptionstring

        • imageImage or any or null

          Fields of image

          One of:

          Image

          • idstring or null

          • urlstring

            Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

          • mimeTypestring

          • widthinteger or null

          • heightinteger or null

          • altstring

          • titlestring or null

          • focalPointobject or null

          any or null

      • currencystring

        The trip's main currency.

      • priceFrominteger or null

        The 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 integer

        By currency, such as EUR and NOK.

      • ratingany or any or null

        average and count.

      • bookingModestring

        One of instant, request, closed.
      • nextDeparturestring or null

      • departuresDeparture[]

        Fields of Departure

      • cmsEntryIdstring or null

        The CMS Orbit entry for the trip page, when linked.

      • localestring

      • fallbackstring[]

        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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/trips'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • tripSlugstringpath, required

    The trip's address.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe trip.
    • dataTripDetail

      Fields of data
      • idstring

      • slugstring

        Such as lofoten-ridge-walk.

      • namestring

      • draftboolean

        Only with a key that reads drafts.

      • categorystring or null

      • tagsstring[]

      • activitiesstring[]

      • countriesstring[]

        Two letters each.

      • areasstring[]

      • areastring or null

        The areas joined with commas.

      • summarystring

      • badgestring or null

      • daysinteger or null

      • difficultyany or any or null

        The difficulty set on the trip.

      • groupSizeany

        min and max.

      • imagesImage[]

        Fields of Image

      • seoobject

        Fields of seo
        • titlestring

        • descriptionstring

        • imageImage or any or null

          Fields of image

          One of:

          Image

          • idstring or null

          • urlstring

            Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

          • mimeTypestring

          • widthinteger or null

          • heightinteger or null

          • altstring

          • titlestring or null

          • focalPointobject or null

          any or null

      • currencystring

        The trip's main currency.

      • priceFrominteger or null

        The 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 integer

        By currency, such as EUR and NOK.

      • ratingany or any or null

        average and count.

      • bookingModestring

        One of instant, request, closed.
      • nextDeparturestring or null

      • departuresDeparture[]

        Fields of Departure

      • cmsEntryIdstring or null

        The CMS Orbit entry for the trip page, when linked.

      • localestring

      • fallbackstring[]

        Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

      • descriptionstring

        HTML.

      • highlightsstring[]

      • includedstring[]

      • notIncludedstring[]

      • itineraryany[]

      • packagesany[]

      • addOnsany[]

      • paymentPlanany

        Deposit and instalments.

      • paymentPlanByCurrencymap of any

      • cancellationany

        The cancellation terms.

      • questionsany[]

        Questions for the booking form.

      • travellerFieldsany

        Which traveller details are required.

      • travellersany

        How many travellers a booking may have.

      • guidesobject[]

        Fields of guides
        • namestring

        • rolestring

        • biostring

        • photoany or any or null

        • languagesstring[]

        • slugstring

        • imageImage or any or null

          Fields of image

          One of:

          Image

          • idstring or null

          • urlstring

            Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

          • mimeTypestring

          • widthinteger or null

          • heightinteger or null

          • altstring

          • titlestring or null

          • focalPointobject or null

          any or null

      • staysobject[]

        Fields of stays
        • idstring

        • namestring

        • locationstring

        • countrystring or null

        • websitestring or null

        • ratingnumber or null

        • descriptionstring

        • imagesImage[]

          Fields of Image

        • nightsinteger

      • termsstring

      • brochureUrlstring or null

      • invitationForstring or null

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/trips/lofoten-ridge-walk'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe guides.
    • dataGuide[]

      Fields of data
      • slugstring

        Made from the name, such as kari-nordmann.

      • namestring

      • rolestring

      • biostring

      • imageImage or any or null

        Fields of image

        One of:

        Image

        • idstring or null

        • urlstring

          Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

        • mimeTypestring

        • widthinteger or null

        • heightinteger or null

        • altstring

        • titlestring or null

        • focalPointobject or null

          Fields of focalPoint
          • xnumber

          • ynumber

        any or null

      • languagesstring[]

      • profileany

        home, since, quote, story, approach, loves, favourites and pickWhy.

      • tripCountinteger

      • seoobject

        Fields of seo
        • titlestring

        • descriptionstring

        • imageImage or any or null

          Fields of image

          One of:

          Image

          • idstring or null

          • urlstring

            Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

          • mimeTypestring

          • widthinteger or null

          • heightinteger or null

          • altstring

          • titlestring or null

          • focalPointobject or null

          any or null

      • localestring

      • fallbackstring[]

        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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/guides'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • guideSlugstringpath, required

    The guide's address.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe guide.
    • dataGuideDetail

      Fields of data
      • slugstring

        Made from the name, such as kari-nordmann.

      • namestring

      • rolestring

      • biostring

      • imageImage or any or null

        Fields of image

        One of:

        Image

        • idstring or null

        • urlstring

          Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

        • mimeTypestring

        • widthinteger or null

        • heightinteger or null

        • altstring

        • titlestring or null

        • focalPointobject or null

          Fields of focalPoint
          • xnumber

          • ynumber

        any or null

      • languagesstring[]

      • profileany

        home, since, quote, story, approach, loves, favourites and pickWhy.

      • tripCountinteger

      • seoobject

        Fields of seo
        • titlestring

        • descriptionstring

        • imageImage or any or null

          Fields of image

          One of:

          Image

          • idstring or null

          • urlstring

            Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

          • mimeTypestring

          • widthinteger or null

          • heightinteger or null

          • altstring

          • titlestring or null

          • focalPointobject or null

          any or null

      • localestring

      • fallbackstring[]

        Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

      • tripsTrip[]

        Fields of Trip

      • pickTrip or any or null

        Fields of pick

        One of:

        Trip

        • idstring

        • slugstring

          Such as lofoten-ridge-walk.

        • namestring

        • draftboolean

          Only with a key that reads drafts.

        • categorystring or null

        • tagsstring[]

        • activitiesstring[]

        • countriesstring[]

          Two letters each.

        • areasstring[]

        • areastring or null

          The areas joined with commas.

        • summarystring

        • badgestring or null

        • daysinteger or null

        • difficultyany or any or null

          The difficulty set on the trip.

        • groupSizeany

          min and max.

        • imagesImage[]

          Fields of Image

        • seoobject

          Fields of seo
          • titlestring

          • descriptionstring

          • imageImage or any or null

        • currencystring

          The trip's main currency.

        • priceFrominteger or null

          The 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 integer

          By currency, such as EUR and NOK.

        • ratingany or any or null

          average and count.

        • bookingModestring

          One of instant, request, closed.
        • nextDeparturestring or null

        • departuresDeparture[]

          Fields of Departure

        • cmsEntryIdstring or null

          The CMS Orbit entry for the trip page, when linked.

        • localestring

        • fallbackstring[]

          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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/guides/kari-nordmann'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe continents.
    • dataContinentSummary[]

      Fields of data
      • keystring

        Such as europe.

      • namestring

      • publishedboolean

      • taglinestring or null

      • coverany or any or null

        url and alt.

      • countriesCountrySummary[]

        Fields of CountrySummary

      • localestring

      • fallbackstring[]

        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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • continentstringpath, required

    Such as europe.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe continent.
    • dataContinent

      Fields of data
      • keystring

        Such as europe.

      • namestring

      • publishedboolean

      • taglinestring or null

      • coverany or any or null

        url and alt.

      • countriesCountrySummary[]

        Fields of CountrySummary

      • localestring

      • fallbackstring[]

        Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

      • contentContent or any or null

        Once you publish its introduction.

        Fields of content

        One of:

        Content

        • headingstring

        • taglinestring

        • introstring

        • guidestring

        • imagesany[]

        • bestTimestring

        • entrystring

        • seoobject

          Fields of seo
          • titlestring

          • descriptionstring

        any or null

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations/europe'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • continentstringpath, required

    Such as europe.

  • countrystringpath, required

    The country's slug or two-letter code.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe country.
    • dataCountry

      Fields of data
      • codestring

      • slugstring

      • namestring

      • flagstring

      • continentobject

        Fields of continent
        • keystring

        • namestring

      • factsany

        name, officialName, continent, capital, languages, religion, vaccines, drivingSide, callingCode, currency, timeZone, capitalAt, centre and mapId.

      • labelsmap of string

        Tile headings in the chosen language.

      • contentContent or any or null

        Fields of content

        One of:

        Content

        • headingstring

        • taglinestring

        • introstring

        • guidestring

        • imagesany[]

        • bestTimestring

        • entrystring

        • seoobject

          Fields of seo
          • titlestring

          • descriptionstring

        any or null

      • tripsTrip[]

        Fields of Trip

      • liveany

        timeZone, weather (temperature, symbol, description, icon, at, credit, or null) and rate (from, to, rate, date). Show weather.credit wherever you show the weather.

      • localestring

      • fallbackstring[]

        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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name, or no published trip or destination there.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many requests from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
curl 'https://app.bifrostorbit.com/travel/api/public/northwilds/destinations/europe/norway'

Try it

Example answer

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

Request body

  • departureIdstringrequired

  • travellersobject[]required

    Up to 24 items.
    Fields of travellers
    • packageIdstring or any or nulloptional

      Default null.
  • addOnsobject[]optional

    Default []. Up to 40 items.
    Fields of addOns
    • idstringrequired

      Up to 40 characters.
    • quantityintegerrequired

      At least 0. At most 24.
  • discountCodestring or any or nulloptional

    Default null.
  • currencystring or any or nulloptional

    Default null.
  • localestring or any or nulloptional

    Default null.

Responses

  • 200OKThe price.
    • dataQuote

      Fields of data
      • currencystring

      • linesobject[]

        Fields of lines
        • idstring

        • kindstring

          One of package, addOn, discount.
        • refIdstring or null

        • labelstring

        • unitAmountinteger

        • quantityinteger

        • amountinteger

      • subtotalinteger

        Before the discount. In minor units, so 124000 with EUR is €1,240.00.

      • discountinteger

        Taken off. In minor units, so 124000 with EUR is €1,240.00.

      • totalinteger

        The total. In minor units, so 124000 with EUR is €1,240.00.

      • codestring or null

        The discount code used.

      • scheduleobject[]

        Fields of schedule
        • labelstring

        • dueDatestring

        • amountinteger

      • dueNowinteger

        Paid 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 409ConflictNot enough places left, or an extra sold out.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableA field is missing or in the wrong format.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

Request body

  • departureIdstringrequired

  • leadobjectrequired

    Fields of lead
    • firstNamestringrequired

      Up to 80 characters.
    • lastNamestringrequired

      Up to 80 characters.
    • emailstringrequired

    • phonestring or any or nulloptional

      Default null.
  • travellersobject[]required

    Up to 24 items.
    Fields of travellers
    • firstNamestringrequired

      Up to 80 characters.
    • lastNamestringrequired

      Up to 80 characters.
    • 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 null.
    • answersmap of string or booleanoptional

      Default {}.
  • addOnsobject[]optional

    Default []. Up to 40 items.
    Fields of addOns
    • idstringrequired

      Up to 40 characters.
    • quantityintegerrequired

      At least 0. At most 24.
  • discountCodestring or any or nulloptional

    Default null.
  • currencystring or any or nulloptional

    Default null.
  • answersmap of string or booleanoptional

    Default {}.
  • messagestring or any or nulloptional

    Default null.
  • localestring or any or nulloptional

    Default null.
  • acceptTermstruerequired

Responses

  • 201CreatedThe booking, and the payment to take or null.
    • dataobject

      Fields of data
      • bookingBooking

        Fields of Booking

      • paymentPayment or any or null

        Fields of payment

        One of:

        Payment

        • kindstring

          payment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.

          One of payment, setup.
        • clientSecretstring

        • publishableKeystring

        • amountinteger

        • currencystring

        any or null

  • 400Bad requestThe booking can't be made as asked, such as a missing traveller detail or answer.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 409ConflictNot enough places left, or a package or extra sold out.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableA field is missing or in the wrong format.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

201 CreatedJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • referencestringpath, required

    Such as NO-7KQ2MX.

Request body

  • emailstringrequired

Responses

  • 200OKThe booking.
  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundAn unknown reference, or an email that doesn't match.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableNo email.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

Request body

  • emailstringrequired

  • localestringoptional

Responses

  • 200OKSent, or not, without saying which.
    • dataobject

      Fields of data
      • senttrue

  • 400Bad requestNot an email address.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableNo email.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

Request body

  • emailstringrequired

  • codestringrequired

Responses

  • 200OKSigned in.
    • dataobject

      Fields of data
      • emailstring

  • 400Bad requestA wrong or expired code.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableNo code.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "data": {    "email": "ingrid@northwilds.com"  }}

Sign out

DELETE/{slug}/portal/verifyNo key

Ends the session.

Parameters

  • slugstringpath, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

Responses

  • 200OKSigned out.
    • dataobject

      Fields of data
      • signedOuttrue

  • 401UnauthorisedA key that is wrong, revoked, expired or for another organisation.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

  • localestringquery

    A language you offer, such as nb. Without it, your main language.

Responses

  • 200OKThe signed-in email, the language used and the bookings.
  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo organisation with that booking name.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

Request body

  • referencestringrequired

  • instalmentsstring or string[]optional

Responses

  • 200OKThe payment.
    • dataobject

      Fields of data
      • paymentPayment or any or null

        Fields of payment

        One of:

        Payment

        • kindstring

          payment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.

          One of payment, setup.
        • clientSecretstring

        • publishableKeystring

        • amountinteger

        • currencystring

        any or null

  • 400Bad requestThe booking can't take payments, nothing is due, or online payment is off.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo booking with that reference for the signed-in traveller.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableNo reference.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

Request body

  • referencestringrequired

  • onbooleanrequired

Responses

  • 200OKChanged.
    • dataobject

      Fields of data
      • referencestring

      • autoChargeboolean

  • 400Bad requestNo card saved yet.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo booking with that reference for the signed-in traveller.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableA field is missing.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

  • referencestringquery, required

    The booking.

Responses

  • 200OKThe messages.
    • dataobject

      Fields of data
      • referencestring

      • messagesany[]

  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo booking with that reference for the signed-in traveller.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableNo reference.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

Request body

  • referencestringrequired

  • bodystringrequired

Responses

  • 200OKThe message sent.
    • dataobject

      Fields of data
      • messageany

  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo booking with that reference for the signed-in traveller.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableA field is missing.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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, required

    Your booking name from Booking settings, such as northwilds.

  • Cookiestringheader, required

    travel.portal=… from the verify answer. Call the portal from your own server.

Request body

  • referencestringrequired

  • travellerIdstringrequired

  • changesmap of string or nullrequired

Responses

  • 200OKThe booking's travellers.
    • dataobject

      Fields of data
      • travellersany[]

  • 400Bad requestThe booking is cancelled or the trip has started.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 401UnauthorisedNo signed-in traveller, or a key that isn't valid.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 402Payment requiredThe booking pages are paused because the Travel Orbit plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 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.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 404Not foundNo such booking or traveller for the signed-in traveller.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 422UnprocessableA field is missing or too long.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

      • messagestring

        Words you can show the traveller, in the language of the request.

      • issuesany[]sometimes

        On 422: each field that failed, with its path and message.

Shell
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

200 OKJSON
{  "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

  • errorobject

    Fields of error
    • codestring

      invalid, forbidden, not_found, conflict, unauthorized, subscription_inactive, rate_limited or server_error.

    • messagestring

      Words you can show the traveller, in the language of the request.

    • issuesany[]sometimes

      On 422: each field that failed, with its path and message.

Image

  • idstring or null

  • urlstring

    Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

  • mimeTypestring

  • widthinteger or null

  • heightinteger or null

  • altstring

  • titlestring or null

  • focalPointobject or null

    Fields of focalPoint
    • xnumber

    • ynumber

Organisation

  • slugstring

  • brandNamestring

  • logoUrlstring or null

  • colourstring or null

  • contactEmailstring or null

  • paymentsobject

    Fields of payments
    • onlineboolean

      Whether online payment works right now.

    • publishableKeystring or null

      Your Stripe publishable key.

  • organiserany

    legalName, registration and address.

  • guaranteeany

    provider and text.

  • termsUrlstring or null

  • localesstring[]

    The languages you offer, the main one first.

  • defaultLocalestring

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

Departure

  • idstring

  • startDatestring

    Such as 2027-05-14.

  • endDatestring or null

  • flexibleboolean

    Dates to be decided.

  • guaranteedboolean

  • statusstring

    One of open, full, closed.
  • seatsLeftinteger or null

    null for no limit.

  • capacityinteger or null

  • pricesmap of integer

    By package id, in the main currency.

  • priceFrominteger or null

  • pricesByCurrencymap of map of integer

    By currency, then by package id.

  • priceFromByCurrencymap of integer

    By currency, such as EUR and NOK.

  • bookingDeadlinestring or null

Trip

  • idstring

  • slugstring

    Such as lofoten-ridge-walk.

  • namestring

  • draftboolean

    Only with a key that reads drafts.

  • categorystring or null

  • tagsstring[]

  • activitiesstring[]

  • countriesstring[]

    Two letters each.

  • areasstring[]

  • areastring or null

    The areas joined with commas.

  • summarystring

  • badgestring or null

  • daysinteger or null

  • difficultyany or any or null

    The difficulty set on the trip.

  • groupSizeany

    min and max.

  • imagesImage[]

    Fields of Image

  • seoobject

    Fields of seo
    • titlestring

    • descriptionstring

    • imageImage or any or null

      Fields of image

      One of:

      Image

      • idstring or null

      • urlstring

        Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

      • mimeTypestring

      • widthinteger or null

      • heightinteger or null

      • altstring

      • titlestring or null

      • focalPointobject or null

      any or null

  • currencystring

    The trip's main currency.

  • priceFrominteger or null

    The 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 integer

    By currency, such as EUR and NOK.

  • ratingany or any or null

    average and count.

  • bookingModestring

    One of instant, request, closed.
  • nextDeparturestring or null

  • departuresDeparture[]

    Fields of Departure

  • cmsEntryIdstring or null

    The CMS Orbit entry for the trip page, when linked.

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

TripDetail

  • idstring

  • slugstring

    Such as lofoten-ridge-walk.

  • namestring

  • draftboolean

    Only with a key that reads drafts.

  • categorystring or null

  • tagsstring[]

  • activitiesstring[]

  • countriesstring[]

    Two letters each.

  • areasstring[]

  • areastring or null

    The areas joined with commas.

  • summarystring

  • badgestring or null

  • daysinteger or null

  • difficultyany or any or null

    The difficulty set on the trip.

  • groupSizeany

    min and max.

  • imagesImage[]

    Fields of Image

  • seoobject

    Fields of seo
    • titlestring

    • descriptionstring

    • imageImage or any or null

      Fields of image

      One of:

      Image

      • idstring or null

      • urlstring

        Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

      • mimeTypestring

      • widthinteger or null

      • heightinteger or null

      • altstring

      • titlestring or null

      • focalPointobject or null

      any or null

  • currencystring

    The trip's main currency.

  • priceFrominteger or null

    The 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 integer

    By currency, such as EUR and NOK.

  • ratingany or any or null

    average and count.

  • bookingModestring

    One of instant, request, closed.
  • nextDeparturestring or null

  • departuresDeparture[]

    Fields of Departure

  • cmsEntryIdstring or null

    The CMS Orbit entry for the trip page, when linked.

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

  • descriptionstring

    HTML.

  • highlightsstring[]

  • includedstring[]

  • notIncludedstring[]

  • itineraryany[]

  • packagesany[]

  • addOnsany[]

  • paymentPlanany

    Deposit and instalments.

  • paymentPlanByCurrencymap of any

  • cancellationany

    The cancellation terms.

  • questionsany[]

    Questions for the booking form.

  • travellerFieldsany

    Which traveller details are required.

  • travellersany

    How many travellers a booking may have.

  • guidesobject[]

    Fields of guides
    • namestring

    • rolestring

    • biostring

    • photoany or any or null

    • languagesstring[]

    • slugstring

    • imageImage or any or null

      Fields of image

      One of:

      Image

      • idstring or null

      • urlstring

        Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

      • mimeTypestring

      • widthinteger or null

      • heightinteger or null

      • altstring

      • titlestring or null

      • focalPointobject or null

      any or null

  • staysobject[]

    Fields of stays
    • idstring

    • namestring

    • locationstring

    • countrystring or null

    • websitestring or null

    • ratingnumber or null

    • descriptionstring

    • imagesImage[]

      Fields of Image

    • nightsinteger

  • termsstring

  • brochureUrlstring or null

  • invitationForstring or null

Guide

  • slugstring

    Made from the name, such as kari-nordmann.

  • namestring

  • rolestring

  • biostring

  • imageImage or any or null

    Fields of image

    One of:

    Image

    • idstring or null

    • urlstring

      Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

    • mimeTypestring

    • widthinteger or null

    • heightinteger or null

    • altstring

    • titlestring or null

    • focalPointobject or null

      Fields of focalPoint
      • xnumber

      • ynumber

    any or null

  • languagesstring[]

  • profileany

    home, since, quote, story, approach, loves, favourites and pickWhy.

  • tripCountinteger

  • seoobject

    Fields of seo
    • titlestring

    • descriptionstring

    • imageImage or any or null

      Fields of image

      One of:

      Image

      • idstring or null

      • urlstring

        Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

      • mimeTypestring

      • widthinteger or null

      • heightinteger or null

      • altstring

      • titlestring or null

      • focalPointobject or null

      any or null

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

GuideDetail

  • slugstring

    Made from the name, such as kari-nordmann.

  • namestring

  • rolestring

  • biostring

  • imageImage or any or null

    Fields of image

    One of:

    Image

    • idstring or null

    • urlstring

      Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

    • mimeTypestring

    • widthinteger or null

    • heightinteger or null

    • altstring

    • titlestring or null

    • focalPointobject or null

      Fields of focalPoint
      • xnumber

      • ynumber

    any or null

  • languagesstring[]

  • profileany

    home, since, quote, story, approach, loves, favourites and pickWhy.

  • tripCountinteger

  • seoobject

    Fields of seo
    • titlestring

    • descriptionstring

    • imageImage or any or null

      Fields of image

      One of:

      Image

      • idstring or null

      • urlstring

        Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

      • mimeTypestring

      • widthinteger or null

      • heightinteger or null

      • altstring

      • titlestring or null

      • focalPointobject or null

      any or null

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

  • tripsTrip[]

    Fields of Trip

  • pickTrip or any or null

    Fields of pick

    One of:

    Trip

    • idstring

    • slugstring

      Such as lofoten-ridge-walk.

    • namestring

    • draftboolean

      Only with a key that reads drafts.

    • categorystring or null

    • tagsstring[]

    • activitiesstring[]

    • countriesstring[]

      Two letters each.

    • areasstring[]

    • areastring or null

      The areas joined with commas.

    • summarystring

    • badgestring or null

    • daysinteger or null

    • difficultyany or any or null

      The difficulty set on the trip.

    • groupSizeany

      min and max.

    • imagesImage[]

      Fields of Image

    • seoobject

      Fields of seo
      • titlestring

      • descriptionstring

      • imageImage or any or null

    • currencystring

      The trip's main currency.

    • priceFrominteger or null

      The 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 integer

      By currency, such as EUR and NOK.

    • ratingany or any or null

      average and count.

    • bookingModestring

      One of instant, request, closed.
    • nextDeparturestring or null

    • departuresDeparture[]

      Fields of Departure

    • cmsEntryIdstring or null

      The CMS Orbit entry for the trip page, when linked.

    • localestring

    • fallbackstring[]

      Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

    any or null

CountrySummary

  • codestring

    Two letters.

  • slugstring

  • namestring

  • flagstring

    A round SVG flag.

  • tripCountinteger

  • publishedboolean

  • taglinestring or null

  • coverany or any or null

    url and alt.

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

ContinentSummary

  • keystring

    Such as europe.

  • namestring

  • publishedboolean

  • taglinestring or null

  • coverany or any or null

    url and alt.

  • countriesCountrySummary[]

    Fields of CountrySummary

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

Content

  • headingstring

  • taglinestring

  • introstring

  • guidestring

  • imagesany[]

  • bestTimestring

  • entrystring

  • seoobject

    Fields of seo
    • titlestring

    • descriptionstring

Continent

  • keystring

    Such as europe.

  • namestring

  • publishedboolean

  • taglinestring or null

  • coverany or any or null

    url and alt.

  • countriesCountrySummary[]

    Fields of CountrySummary

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

  • contentContent or any or null

    Once you publish its introduction.

    Fields of content

    One of:

    Content

    • headingstring

    • taglinestring

    • introstring

    • guidestring

    • imagesany[]

    • bestTimestring

    • entrystring

    • seoobject

      Fields of seo
      • titlestring

      • descriptionstring

    any or null

Country

  • codestring

  • slugstring

  • namestring

  • flagstring

  • continentobject

    Fields of continent
    • keystring

    • namestring

  • factsany

    name, officialName, continent, capital, languages, religion, vaccines, drivingSide, callingCode, currency, timeZone, capitalAt, centre and mapId.

  • labelsmap of string

    Tile headings in the chosen language.

  • contentContent or any or null

    Fields of content

    One of:

    Content

    • headingstring

    • taglinestring

    • introstring

    • guidestring

    • imagesany[]

    • bestTimestring

    • entrystring

    • seoobject

      Fields of seo
      • titlestring

      • descriptionstring

    any or null

  • tripsTrip[]

    Fields of Trip

  • liveany

    timeZone, weather (temperature, symbol, description, icon, at, credit, or null) and rate (from, to, rate, date). Show weather.credit wherever you show the weather.

  • localestring

  • fallbackstring[]

    Fields not translated yet, which came in the main language, such as description or itinerary.day-3.body.

Quote

  • currencystring

  • linesobject[]

    Fields of lines
    • idstring

    • kindstring

      One of package, addOn, discount.
    • refIdstring or null

    • labelstring

    • unitAmountinteger

    • quantityinteger

    • amountinteger

  • subtotalinteger

    Before the discount. In minor units, so 124000 with EUR is €1,240.00.

  • discountinteger

    Taken off. In minor units, so 124000 with EUR is €1,240.00.

  • totalinteger

    The total. In minor units, so 124000 with EUR is €1,240.00.

  • codestring or null

    The discount code used.

  • scheduleobject[]

    Fields of schedule
    • labelstring

    • dueDatestring

    • amountinteger

  • dueNowinteger

    Paid at checkout. In minor units, so 124000 with EUR is €1,240.00.

  • seatsLeftinteger or null

QuoteInput

  • departureIdstring

  • travellersobject[]

    Up to 24 items.
    Fields of travellers
    • packageIdstring or any or nullsometimes

      Default null.
  • addOnsobject[]sometimes

    Default []. Up to 40 items.
    Fields of addOns
    • idstring

      Up to 40 characters.
    • quantityinteger

      At least 0. At most 24.
  • discountCodestring or any or nullsometimes

    Default null.
  • currencystring or any or nullsometimes

    Default null.
  • localestring or any or nullsometimes

    Default null.

BookingInput

  • departureIdstring

  • leadobject

    Fields of lead
    • firstNamestring

      Up to 80 characters.
    • lastNamestring

      Up to 80 characters.
    • emailstring

    • phonestring or any or nullsometimes

      Default null.
  • travellersobject[]

    Up to 24 items.
    Fields of travellers
    • firstNamestring

      Up to 80 characters.
    • lastNamestring

      Up to 80 characters.
    • 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 null.
    • answersmap of string or booleansometimes

      Default {}.
  • addOnsobject[]sometimes

    Default []. Up to 40 items.
    Fields of addOns
    • idstring

      Up to 40 characters.
    • quantityinteger

      At least 0. At most 24.
  • discountCodestring or any or nullsometimes

    Default null.
  • currencystring or any or nullsometimes

    Default null.
  • answersmap of string or booleansometimes

    Default {}.
  • messagestring or any or nullsometimes

    Default null.
  • localestring or any or nullsometimes

    Default null.
  • acceptTermstrue

Booking

  • idstring

  • referencestring

    Such as NO-7KQ2MX.

  • statusstring

    held, requested, confirmed, expired or cancelled.

  • totalinteger

  • currencystring

  • scheduleobject[]

    Fields of schedule
    • idstring

    • labelstring

    • dueDatestring

    • amountinteger

    • statusstring

      One of due, paid, failed, waived.
  • holdExpiresAtstring or null

    Places are kept until then.

Payment

  • kindstring

    payment: confirm with stripe.confirmPayment. setup: nothing is due today; confirm with stripe.confirmSetup to save the card.

    One of payment, setup.
  • clientSecretstring

  • publishableKeystring

  • amountinteger

  • currencystring

PortalBooking

  • referencestring

  • leadFirstNamestring

  • tripNamestring

  • tripSlugstring or null

  • imageImage or any or null

    Fields of image

    One of:

    Image

    • idstring or null

    • urlstring

      Takes ?w= and ?format= (webp, avif or jpeg) for images from the media library.

    • mimeTypestring

    • widthinteger or null

    • heightinteger or null

    • altstring

    • titlestring or null

    • focalPointobject or null

      Fields of focalPoint
      • xnumber

      • ynumber

    any or null

  • daysinteger or null

  • departureDatestring or null

  • statusstring

  • travellersobject[]

    Fields of travellers
    • idstring

    • firstNamestring

    • lastNamestring

    • phonestring or null

    • dateOfBirthstring or null

    • nationalitystring or null

    • passportstring or null

    • dietarystring or null

    • emergencyContactstring or null

  • paymentsobject[]

    Fields of payments
    • idstring

    • kindstring

    • methodstring

    • amountinteger

    • currencystring

    • atstring

  • linesobject[]

    Fields of lines
    • labelstring

    • quantityinteger

    • amountinteger

  • currencystring

  • totalinteger

  • paidinteger

  • scheduleobject[]

    Fields of schedule
    • idstring

    • labelstring

    • dueDatestring

    • amountinteger

    • statusstring

  • autoChargeboolean

  • cardSavedboolean