Skip to main content

MyBeezBox API (v2)

Download OpenAPI specification:Download

Welcome to MyBeezBox API v2. The interface and the logic were rebuilt from scratch to provide better, more RESTful experience.

Useful links

destinations

destinations_list

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json
Example

This is an example of region, department and a city of a partner.

[
  • {
    }
]

terms

Get partner legal information

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

Legal information of the current partner

[
  • {
    }
]

Get refund and withdrawal terms in all languages

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

Translated Refund & Withdrawal terms for the current partner, to be displayed in its purchase website.

[
  • {
    }
]

partners

partners_list

Authorizations:
tokenAuth
query Parameters
department
string
id
Array of integers

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

region
string
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This is an example of a partner's detailed information.

{}

partners_retrieve

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this partner.

header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This is an example of a partner's detailed information.

  • label_and_network is a list of objects with the following keys:
    • name the name of the label (e.g. "1 Michelin 2025")
    • logo the absolute url of the logo a the label (e.g. "https://www.label/example.png")
{
  • "id": 999,
  • "name": "Agency Name",
  • "agency_website": "https://partner-website.com",
  • "description": {
    },
  • "region": "Corse",
  • "department": "Haute-Corse",
  • "latitude": 42.5,
  • "longitude": 8.8,
  • "managers": {
    },
  • "nearby": {
    },
  • "practical_information": {
    },
  • "access": {
    },
  • "facilities": {
    },
  • "social_links": {},
  • "label_and_network": []
}

partners_me_retrieve

Get basic information about the current partner.

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json
{
  • "agency_email": "string",
  • "agency_name": "string",
  • "id": 0,
  • "name": "string",
  • "site": "string"
}

product-information

product_information_vouchers_list

Get Vouchers product configuration.

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This example of Partner's Voucher product configuration

  • All delivery modes are activated, except for 'On site pickup'.
  • 'destination' and 'universe' filters are deactivated.
  • There's no hero image for vouchers.
{
  • "title": {
    },
  • "subtitle": {
    },
  • "hero_image": null,
  • "activated_destination_filter": false,
  • "activated_universe_filter": false,
  • "activated_price_filter": true,
  • "activated_target_filter": true,
  • "activated_theme_filter": true,
  • "activated_environment_filter": true,
  • "activated_offer_ordering_by_ranking": true,
  • "validity_period": 365,
  • "validity_period_unit": 1,
  • "method_of_display": 1,
  • "default_prototype_image": null
}

universes

universes_list

Get all universes from all voucher prototypes of a partner.

Authorizations:
tokenAuth
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json
Example

This is an example of Universe which has a sub-universe and a sub-sub-universe

[
  • {
    }
]

voucher-prototypes

voucher_prototypes_list

Returns a paginated list of voucher prototypes for the authenticated partner or marketplace.

Filters and ordering parameters are applied to the queryset. If the request comes from a marketplace client, an additional field partners_count is included in the response. This field indicates the number of distinct affiliate partners associated with the full filtered result set, before pagination is applied.

Authorizations:
tokenAuth
query Parameters
active
boolean
category
integer
destination
string
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

partner
integer
price_max
string or null <decimal> (Base price) ^-?\d{0,6}(?:\.\d{0,4})?$

Price per night or single usage/entry

price_min
string or null <decimal> (Base price) ^-?\d{0,6}(?:\.\d{0,4})?$

Price per night or single usage/entry

theme
Array of integers
universe
Array of integers
with_sub_universes
boolean

If true, results will include voucher prototypes from selected universes and all their descendants.

header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This is an example of Voucher Prototype object.

  • Texts are in EN, FR and ES languages only.
  • Prototype has no themes
  • It's a prototype for Partner(id=1)
{
  • "count": 123,
  • "results": [
    ],
  • "partners_count": 12
}

voucher_prototypes_retrieve

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this voucher's prototype.

header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This is an example of Voucher Prototype object.

  • Texts are in EN, FR and ES languages only.
  • It's a prototype for Partner(id=1)
{}

Voucher prototype options

Returns a paginated list of available options for a given voucher prototype. Includes a boolean field is_included indicating whether each option is included in the prototype.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this voucher's prototype.

query Parameters
active
boolean

If true, returns active options only.

header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json

This is an example of Voucher Prototype Option object.

{
  • "count": 123,
  • "results": [
    ],
  • "partners_count": 12
}

website-configuration

website_configuration_list

Get Partner's website configuration.

Authorizations:
tokenAuth
query Parameters
fields
string
Examples:
  • fields=languages - languages
  • fields=activated_products,links - activated_products, links
  • fields=images,style,seo,blocks - images, style, seo, blocks

Fields to include in the response (comma-separated). When missing, all fields are included.

header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

Response samples

Content type
application/json
Example

This is an example of Partner configuration containing all possible fields.

  • amex payments activated, but not bcmc.
  • Only 3 languages (fr, en and es) are activated with French being partner's default language.
  • The partner has workshops feature active, but C&C is not activated.
  • is_marketplace is False, the partner isn't a marketplace.
  • All links are visible
  • cancel_and_refund, about_us, faq and legal_notice should be handled by the client.
  • terms_of_service and privacy are external URLs.
  • terms_of_service is different for each country.
{
  • "activated_products": {
    },
  • "contact": {
    },
  • "credit_card_providers": {
    },
  • "languages": {
    },
  • "links": {
    },
  • "images": {},
  • "style": {
    },
  • "seo": {
    },
  • "blocks": {
    },
  • "is_marketplace": false
}