Skip to main content
API docs by Redocly

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

contact-requests

contact_requests_create

A viewset for the use_funnel.ContactRequest model.

Note: for the moment, the mixins used only allow the creation of a ContactRequest object with a POST request. Add more mixins to enable GET requests on list and detail views.

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

Partner's site domain (optional)

Request Body schema:
required
gift_code
required
string
full_name
required
string
email
required
string <email>
phone_number
string or null
message
required
string
partner
required
string <uuid>

Responses

Request samples

Content type

This is an example of a contact request's information.

  • partner is the UUID of the partner selling the gift product for which we create a contact request.
{
  • "id": 1,
  • "gift_code": "voucher_code",
  • "full_name": "Jane Doe",
  • "email": "janedoe@mybeezbox.com",
  • "phone_number": "+33 123 456 780",
  • "message": "I would like to use this gift code.",
  • "related_product_details": {
    },
  • "partner": "e2df88b9-3380-4eac-bab6-8b7dfc2c61b9"
}

Response samples

Content type
application/json

This is an example of a contact request's information.

  • partner is the UUID of the partner selling the gift product for which we create a contact request.
{
  • "id": 1,
  • "gift_code": "voucher_code",
  • "full_name": "Jane Doe",
  • "email": "janedoe@mybeezbox.com",
  • "phone_number": "+33 123 456 780",
  • "message": "I would like to use this gift code.",
  • "related_product_details": {
    },
  • "partner": "e2df88b9-3380-4eac-bab6-8b7dfc2c61b9"
}

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.

[
  • {
    }
]

event-prototypes

event_prototypes_retrieve

A view set to retrieve detailed data for an event:

  • Event's details
  • Event's available slots.
  • Event's formula

Refs: https://app.clickup.com/t/86c6n9bkd

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this event.

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
{
  • "id": 0,
  • "name": {
    },
  • "short_description": {
    },
  • "long_description": {
    },
  • "booking": {
    },
  • "cover_image": "string",
  • "images": [
    ],
  • "slots": [
    ],
  • "formulas": "string",
  • "lowest_price": "string",
  • "lowest_price_formatted": {
    },
  • "currency_code": "string",
  • "delivery_options": {
    }
}

event-slots

event_slots_list

ViewSet for listing Events' slots.

Refs: https://app.clickup.com/t/86c6n9b6x

Each Event is presented by their first available slot. If the partner's ticket settings checks "Display event per slots", all available slots are displayed.

This view uses querysets of Slot objects.

For a detail endpoint of an Event, another view with a queryset of Event objects is needed.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

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
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

gift

gift_retrieve

Resolve a gift code to a concrete gift and return its normalized payload.

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

Partner's site domain (optional)

Responses

gift_linked_partners_retrieve

Return the partners linked to this gift code.

Rules (mirrors legacy):

  • Voucher → one partner: selling_partner
  • Giftcard → one partner: selling_partner
  • NetworkGiftcard → network_giftcards_settings.allowed_partners
  • NetworkVoucher → DISTINCT partners behind box.get_validated_offers()
Authorizations:
tokenAuth
path Parameters
code
required
string
header Parameters
X-Partner-Domain
string
Examples:
  • staging.bonkdo.com - staging.bonkdo.com

Partner's site domain (optional)

Responses

giftcard-prototypes

giftcard_prototypes_list

Get "Giftcard Prototypes" – i.e Giftcard Settings for partner(s) .

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

partner
integer
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 Giftcard Prototype object (giftcard settings).

{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

giftcard_prototypes_retrieve

Get "Giftcard Prototypes" – i.e Giftcard Settings for partner(s) .

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Giftcard settings.

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 Giftcard Prototype object (giftcard settings).

{
  • "customized_amount": true,
  • "description": {
    },
  • "funnel_link": "https://demo.bonkdo.com/giftcards/customization/?partner=26f390aa-7056-4e2b-9005-7b657c9d1b02",
  • "id": 1,
  • "logo": "https://mybb-storage-prod.s3.fr-par.scw.cloud/custom_giftcards_logo.png",
  • "minimum_amount": "50.00",
  • "money_pot": {},
  • "partner_id": 1,
  • "partner_name": "Nom commercial",
  • "predefined_amounts": [
    ],
  • "terms_of_use": {
    },
  • "title": {
    },
  • "validity_period": 365,
  • "validity_unit": "days",
  • "minimum_amount_formatted": {
    },
  • "predefined_amounts_formatted": [
    ]
}

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.

{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

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": {
    },
  • "image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/test/image.png",
  • "logo": null,
  • "region": "Corse",
  • "department": "Haute-Corse",
  • "latitude": 42.5,
  • "longitude": 8.8,
  • "commercial_description": {
    },
  • "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

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": {
    },
  • "image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/test/image.png",
  • "logo": null,
  • "region": "Corse",
  • "department": "Haute-Corse",
  • "latitude": 42.5,
  • "longitude": 8.8,
  • "commercial_description": {
    },
  • "managers": {
    },
  • "nearby": {
    },
  • "practical_information": {
    },
  • "access": {
    },
  • "facilities": {
    },
  • "social_links": {},
  • "label_and_network": []
}

product-information

product_information_events_list

Override list to a singleton result

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 is an example of a Partner's Events product information

{
  • "title": {
    },
  • "description": {
    },
  • "tos_url": {},
  • "display_fully_booked_events": false,
  • "display_events_per_slots": true
}

product_information_giftcards_list

Get Giftcards 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
[
  • {
    }
]

product_information_network_giftcards_list

Get Network Giftcards 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 Marketplace's Network Giftcards configuration

  • Money Pot is activated
  • Giftcard has custom logo file
  • MoneyPot uses default logo image
{
  • "title": {
    },
  • "description": {
    },
  • "giftcard": {
    },
  • "money_pot": {
    }
}

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": {
    },
  • "short_description": {
    },
  • "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
}

product_information_workshops_list

Override the list endpoint to a singleton result

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 is an example of a Partner's Workshops product information

{
  • "title": {
    },
  • "description": {
    },
  • "tos_url": {},
  • "display_workshops_by_month": false,
  • "display_workshops_per_session": true,
  • "display_fully_booked_sessions": false,
  • "activated_month_filter": true,
  • "activated_day_filter": true,
  • "activated_time_filter": true,
  • "activated_price_filter": false,
  • "activated_category_filter": false,
  • "activated_duration_filter": false,
  • "activated_target_filter": false,
  • "activated_level_filter": false,
  • "activated_theme_filter": false,
  • "min_nb_free_places_for_label_shown": 3,
  • "display_phone_number": true,
  • "phone_number": "",
  • "default_workshop_image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/default_workshop_image.png",
  • "logo": "https://mybb-storage-prod.s3.fr-par.scw.cloud/workshops_logo.png",
  • "validity_period": 365,
  • "validity_period_unit": 1
}

themes

themes_list

Get all themes 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
[
  • {
    }
]

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-categories

voucher_categories_list

Get all categories 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

This is an example of Voucher Prototype's Category object.

[
  • {
    }
]

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,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "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)
{
  • "booking_condition": {
    },
  • "category": null,
  • "cover_image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/media_manager/35922771-65f2-4093-8f6f-cf570b6a5e5b/321654651.jpg",
  • "currency_code": "EUR",
  • "delivery_options": {
    },
  • "description": {
    },
  • "display_max_capacity": true,
  • "display_validity_period": true,
  • "display_x_person": true,
  • "funnel_link": "https://qa.bonkdo.com/voucher/personalization/1000/",
  • "price_formatted": {
    },
  • "id": 1000,
  • "images": [],
  • "is_active": false,
  • "is_highlight": false,
  • "last_active_day": null,
  • "long_description": {
    },
  • "long_description_admin": {
    },
  • "max_capacity": 10,
  • "min_capacity": 1,
  • "name": {
    },
  • "partner_city": "Bordeaux",
  • "partner_department": "Gironde",
  • "partner_id": 1,
  • "partner_name": "Nom commercial",
  • "partner_region": "Nouvelle-Aquitaine",
  • "price": "420.00",
  • "price_scope": 6,
  • "ranking": 1,
  • "rent_conditions": {
    },
  • "specific_validity_period": null,
  • "fixed_expiration_date": null,
  • "type": "Standard",
  • "themes": [
    ],
  • "universe": 42
}

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,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "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

This is an example of Partner configuration, but only contact and images fields are selected.

{}

workshop-sessions

workshop_sessions_list

ViewSet for listing Workshops' sessions.

Similar to tickets' slots, each workshop is presented by their first available session.

  • If the partner's workshop settings checks "Display workshops per session", all available sessions are displayed.
  • If the partner's workshop settings checks "Display workshops by month", the nearest session for a month is displayed within sections, on the front part, for each month.
  • If the partner's workshop settings checks both "Display workshops per session" and "Display workshops by month", all the sessions are displayed within sections, on the front part, for each month.

This view uses querysets of Session objects.

For a detail endpoint of a Workshop, another view with a queryset of Workshop objects is needed.

Authorizations:
tokenAuth
query Parameters
category
integer
duration
integer
level
integer
month
integer
Enum: 1 10 11 12 2 3 4 5 6 7 8 9
  • 1 - January
  • 2 - February
  • 3 - March
  • 4 - April
  • 5 - May
  • 6 - June
  • 7 - July
  • 8 - August
  • 9 - September
  • 10 - October
  • 11 - November
  • 12 - December
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

price_max
string <decimal> (Selling price) ^-?\d{0,6}(?:\.\d{0,2})?$
price_min
string <decimal> (Selling price) ^-?\d{0,6}(?:\.\d{0,2})?$
recipe
Array of integers
skill
Array of integers
target
Array of integers
theme
Array of integers
time
Array of strings
Items Enum: "afternoon" "evening" "midday" "morning" "night" "night"
  • night - Night
  • morning - Morning
  • midday - Midday
  • afternoon - Afternoon
  • evening - Evening
  • night - Night
week_day
integer
Enum: 1 2 3 4 5 6 7
  • 1 - Sunday
  • 2 - Monday
  • 3 - Tuesday
  • 4 - Wednesday
  • 5 - Thursday
  • 6 - Friday
  • 7 - Saturday
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 workshop's session.

{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}