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": "d0ef3146-1b36-407a-9f85-3b7e13e8ce47"
}

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": "d0ef3146-1b36-407a-9f85-3b7e13e8ce47"
}

destinations

List voucher destinations

Returns the distinct cities, departments, and regions available from the partner's voucher prototypes.

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.

[
  • {
    }
]

ecommerce

ecommerce_cart_create

A ViewSet to CREATE and RETRIEVE shopping cart data for ecommerce Products.

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

Partner's site domain (optional)

Request Body schema:
required
required
Array of objects (EcommerceProductCartItem)
string or string
id
string or null <uuid>

If provided, replaces an existing cart

Responses

Request samples

Content type
{
  • "items": [
    ],
  • "return_url": "",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "return_url": "",
  • "last_modified": 0,
  • "funnel_url": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get ecommerce cart

Returns the current ecommerce cart data for the given cart ID.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
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
{
  • "items": [
    ],
  • "return_url": "",
  • "last_modified": 0,
  • "funnel_url": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get product categories list

Get the list of product categories. Empty categories are included by default.

Authorizations:
tokenAuth
query Parameters
hide_empty
boolean

Exclude categories without active, available products. Defaults to false, so empty categories are included unless this is true.

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 product category.

[]

Get shop products list

Get paginated list of shop products. The list can be filtered by ?category.

Authorizations:
tokenAuth
query Parameters
category
string
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

This is an example of a shop product.

{}

Get shop product details

Get detailed information for a shop product, including images, attributes, variants, and ecommerce delivery options.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this product.

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 detailed shop product data.

{
  • "id": 1,
  • "name": {
    },
  • "short_description": {
    },
  • "category": 12,
  • "category_name": {
    },
  • "current_stock": 8,
  • "is_highlight": true,
  • "cover_image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/media_manager/ecommerce_product_1.png",
  • "has_attributes": true,
  • "price": "16.00",
  • "long_description": {
    },
  • "booking_conditions": {
    },
  • "images": [],
  • "attributes": [
    ],
  • "variants": [
    ],
  • "delivery_options": {
    }
}

event-prototypes

Get event

Returns detailed information for an event.

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": [
    ],
  • "lowest_price": "string",
  • "lowest_price_formatted": {
    },
  • "currency_code": "string",
  • "delivery_options": {
    }
}

event-slots

List event slots

Returns available event slots displayed on the purchase website.

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

This is an example of an Event with one slot available.

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

gift

Get gift

Resolves a gift code and returns the normalized gift payload.

Authorizations:
tokenAuth
path Parameters
code
required
string

A gift code

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
{
  • "product_type": "voucher",
  • "product": {
    },
  • "creation_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "can_be_extended": true,
  • "extension_duration": 0,
  • "extension_price": "string",
  • "extension_link": "string",
  • "dashboard_link": "string",
  • "currency": "string",
  • "formatted_value": {
    },
  • "value": "string",
  • "options": [
    ],
  • "booking_systems": {
    },
  • "booking_modules": {
    },
  • "linked_partners": {
    }
}

List linked gift partners

Returns partners linked to the gift code.

Authorizations:
tokenAuth
path Parameters
code
required
string

A gift code

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": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "has_next": true,
  • "has_previous": true,
  • "current_page": 0,
  • "page_range": [
    ],
  • "results": [
    ]
}

giftcard-prototypes

List giftcard prototypes

Returns active giftcard configurations available for purchase.

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": [
    ]
}

Get giftcard prototype

Returns the details of a giftcard configuration.

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=73527684-ac0c-4140-82a6-e315b24986e2",
  • "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

Returns the authenticated partner's legal information in all supported 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

Legal information of the current partner

[
  • {
    }
]

Get refund and withdrawal terms in all languages

Returns the authenticated partner's refund and withdrawal terms in all supported 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.

[
  • {
    }
]

network-vouchers-boxes

List network voucher boxes

Returns active network voucher boxes available on the marketplace purchase website.

Authorizations:
tokenAuth
query Parameters
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.

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 network voucher box

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

Get network voucher box

Returns detailed information for a network voucher box.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Network voucher box.

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 network voucher box

{
  • "id": 1,
  • "is_active": true,
  • "is_highlight": true,
  • "display_nb_offers": false,
  • "nb_offers": 2,
  • "name": {
    },
  • "short_description": {
    },
  • "price": "49.00",
  • "price_formatted": {
    },
  • "people_included": 1,
  • "currency_code": "EUR",
  • "funnel_link": "https://marketplace.qa.bonkdo.com/en/networkvoucher/customization/1/",
  • "cover_image": null,
  • "ranking": 1000,
  • "universes": [ ],
  • "long_description": {
    },
  • "max_number_usages": 1,
  • "max_days_after_first_usage": 30,
  • "images": [ ],
  • "delivery_options": null
}

Network voucher box offers

Returns a paginated list of available offers for a given network voucher box. Results can be filtered by country, region, or department.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Network voucher box.

query Parameters
country
string

Filter by ISO 3166-1 alpha-2 country code (case-insensitive). Accepts a comma-separated list (e.g. fr,it,es).

department
string

Filter by department name (case-insensitive). Accepts a comma-separated list.

field
string
Enum: "country" "department" "region"

Single field to return instead of the paginated offers. Returns a distinct list of objects with display and value keys for all the available offers.

region
string

Filter by region name (case-insensitive). Accepts a comma-separated list.

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 the default paginated offers response.

{
  • "count": 1,
  • "current_page": 1,
  • "has_next": false,
  • "has_previous": false,
  • "next": null,
  • "previous": null,
  • "page_range": [
    ],
  • "results": [
    ]
}

network-vouchers-universes

List network voucher universes

Get all the universes from all the network voucher boxes for a marketplace.

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

[
  • {
    }
]

partners

List partners

Returns active partners available to the authenticated partner or marketplace.

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": [
    ]
}

Get partner

Returns detailed information for a partner.

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_name": {
    },
  • "department_name": {
    },
  • "latitude": 42.5,
  • "longitude": 8.8,
  • "commercial_description": {
    },
  • "managers": {
    },
  • "nearby": {
    },
  • "practical_information": {
    },
  • "access": {
    },
  • "facilities": {
    },
  • "social_links": {},
  • "label_and_network": [],
  • "mygift_page_title": {
    },
  • "mygift_page_description": {
    }
}

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_name": {
    },
  • "department_name": {
    },
  • "latitude": 42.5,
  • "longitude": 8.8,
  • "commercial_description": {
    },
  • "managers": {
    },
  • "nearby": {
    },
  • "practical_information": {
    },
  • "access": {
    },
  • "facilities": {
    },
  • "social_links": {},
  • "label_and_network": [],
  • "mygift_page_title": {
    },
  • "mygift_page_description": {
    }
}

product-information

Get ecommerce product information

Returns the E-commerce/Shop product config for the 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 Ecommerce product information

{}

Get Tickets product information

Returns the events/tickets configuration for the 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 Events product information

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

Get Giftcards product information

Returns the Giftcards configuration for the 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
[
  • {
    }
]

Get Network Giftcards product information

Returns the Network Giftcards configuration for the marketplace.

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

Get Network Vouchers product information

Returns the Network Vouchers configuration for the marketplace.

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 Marketplace's Network Vouchers product information

{
  • "title": {
    },
  • "description": {
    },
  • "terms_of_use": {
    },
  • "offer_name_type": {
    },
  • "display_by_universe": true,
  • "validity_period": 365,
  • "validity_period_unit": 1,
  • "activated_product_feature": false,
  • "activated_group_payment": true,
  • "display_offers_map": false,
  • "activated_offer_country_filter": false,
  • "activated_offer_department_filter": false,
  • "activated_offer_region_filter": false,
  • "logo": "https://mybb-storage-prod.s3.fr-par.scw.cloud/network_vouchers_logo.png"
}

Get Vouchers product information

Returns the Vouchers configuration for the 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 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,
  • "activated_group_payment": false
}

Get Workshops product information

Returns the Workshops configuration for the 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 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,
  • "activated_group_payment": 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
}

products-categories

List voucher categories

Get all categories from all visible products 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.

[
  • {
    }
]

products-destinations

List voucher destinations

Returns the distinct cities, departments, and regions available from the partner's voucher prototypes.

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.

[
  • {
    }
]

products-themes

List voucher themes

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

products-universes

List voucher universes

Get all universes from all visible products 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

[
  • {
    }
]

shops

Get shop products list

Get paginated list of shop products. The list can be filtered by ?category.

Authorizations:
tokenAuth
query Parameters
category
string
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

This is an example of a shop product.

{}

Get shop product details

Get detailed information for a shop product, including images, attributes, variants, and ecommerce delivery options.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this product.

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 detailed shop product data.

{
  • "id": 1,
  • "name": {
    },
  • "short_description": {
    },
  • "category": 12,
  • "category_name": {
    },
  • "current_stock": 8,
  • "is_highlight": true,
  • "cover_image": "https://mybb-storage-prod.s3.fr-par.scw.cloud/media_manager/ecommerce_product_1.png",
  • "has_attributes": true,
  • "price": "16.00",
  • "long_description": {
    },
  • "booking_conditions": {
    },
  • "images": [],
  • "attributes": [
    ],
  • "variants": [
    ],
  • "delivery_options": {
    }
}

themes

List voucher themes

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

List voucher universes

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

List voucher categories

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

List voucher prototypes

Returns voucher prototypes available to the authenticated partner or marketplace.

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
}

Get voucher prototype

Returns detailed information for a voucher prototype.

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",
  • "department": {
    },
  • "partner_id": 1,
  • "partner_name": "Nom commercial",
  • "region": {
    },
  • "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
}

vouchers-catalog

List catalog products

Returns the partner's purchase-website catalog products with filtering and ordering.

Authorizations:
tokenAuth
query Parameters
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.

price_max
string <decimal> ^-?\d{0,6}(?:\.\d{0,2})?$

Base price of the product

price_min
string <decimal> ^-?\d{0,6}(?:\.\d{0,2})?$

Base price of the product

theme
Array of integers
universe
Array of integers
with_sub_universes
boolean

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

website-configuration

Get website configuration

Returns the authenticated partner's purchase 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,
  • "schema_org": {},
  • "gtm_code": null
}

workshop-categories

List workshop categories

Returns active workshop categories that contain available sessions.

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
{}

Get workshop category

Returns detailed information for a workshop category.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Category.

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": {
    },
  • "description": {
    },
  • "long_description": {
    },
  • "partner_agency_name": "string",
  • "currency_code": "string",
  • "price": "string",
  • "price_formatted": {
    },
  • "cover_image": "string",
  • "images": [
    ],
  • "use_restrictions": {
    },
  • "validity_period": 0,
  • "validity_period_unit": 0,
  • "specific_validity_period": 0,
  • "duration_formatted": {
    },
  • "delivery_options": {
    },
  • "funnel_link": "string"
}

workshop_categories_options_retrieve

Handler method for HTTP 'OPTIONS' request.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Category.

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

Workshop category workshops

Returns a paginated list of active workshops displayed on a workshop voucher category detail page.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this Category.

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": [
    ]
}

workshop-levels

List workshop levels

Returns workshop levels that contain available sessions.

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
{}

workshop-sessions

List workshop sessions

Returns available workshop sessions displayed on the purchase website.

Authorizations:
tokenAuth
query Parameters
category
Array of integers

Filter by category IDs. Repeat the parameter to select multiple categories.

duration
Array of integers

Multiple values may be separated by commas.

field
string
Enum: "duration" "month" "weekday"

Returns a non-paginated list of unique filter values instead of sessions. Other workshop-session filters are ignored so all available choices remain selectable.

level
Array of integers

Filter by level IDs. Repeat the parameter to select multiple levels.

month
Array of integers
Items Enum: 1 2 3 4 5 6 7 8 9 10 11 12

Filter by month numbers. Repeat the parameter to select multiple months.

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
Array of integers

Filter by weekday numbers. Repeat the parameter to select multiple weekdays.

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

Available workshop-session durations for building a filter.

[
  • {
    },
  • {
    }
]

workshop-themes

List workshop themes

Returns workshop themes configured for the partner.

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
{}

workshop-vouchers

Workshop voucher's available sessions

Returns available sessions for the voucher's category.

Authorizations:
tokenAuth
path Parameters
code
required
string
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

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": [
    ]
}

workshops

Get workshop

Returns detailed information for a workshop.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this workshop.

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": {
    },
  • "cover_image": "http://example.com",
  • "images": [
    ],
  • "short_description": {
    },
  • "long_description": {
    },
  • "booking_conditions": {
    },
  • "can_be_privatized": true,
  • "display_calendar": true,
  • "address": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "category": {
    },
  • "level": {
    },
  • "themes": [
    ],
  • "targets": [
    ],
  • "skills": [
    ],
  • "recipes": [
    ],
  • "activate_workshops_group_payment": true
}

workshops_options_retrieve

Handler method for HTTP 'OPTIONS' request.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this workshop.

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": {
    },
  • "cover_image": "http://example.com",
  • "images": [
    ],
  • "short_description": {
    },
  • "long_description": {
    },
  • "booking_conditions": {
    },
  • "can_be_privatized": true,
  • "display_calendar": true,
  • "address": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "category": {
    },
  • "level": {
    },
  • "themes": [
    ],
  • "targets": [
    ],
  • "skills": [
    ],
  • "recipes": [
    ],
  • "activate_workshops_group_payment": true
}

Workshop's sessions

Returns a list of free and active sessions for a given workshop.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this workshop.

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.

[
  • {
    }
]