Beta program

The Beta program offers the opportunity to access and utilize the functionalities that have not been officially launched in the latest version of the API. During the Beta release, all the planned features for the final launch have been implemented. However, it may still contain some known issues, bugs, or incomplete functionalities that need to be addressed before the official release.

The Beta program includes only specific endpoints that can be clearly identified by a Beta header. It focuses solely on the designated Beta endpoints and does not encompass an entire API release.

Why is there a beta program?

The fundamental objective of the Beta program is to collect valuable insights that play a significant role in shaping future development endeavors.

During the duration of the Beta program, you can test and explore the functionality under various conditions and environments. Your participation allows you to provide feedback and suggestions concerning the API’s functionality, structure, documentation, new feature requests and thereby influence the final version of the API before its official launch.

This feedback directly contributes to shaping the endpoint into a more refined and user-centric product, by enhancing the usability and addressing any remaining bugs. It ensures that the endpoint meets your requirements and expectations effectively.

Types of Beta programs

Depending on the stage of the product’s development, bol offers the following two types of Beta programs:

  • Open Beta - The open Beta program is launched in early stages of development or to receive feedback from a wider audience. Under this program, the product is accessible to the public or a wide group of users without specific restrictions, allowing anyone interested to participate and provide feedback. The primary goal is to gather a diverse range of opinions and identify potential issues on a larger scale before the official release. This approach facilitates the refinement of the product and implementation of necessary improvements based on valuable user input.

  • Closed Beta - The closed beta program is launched in later stages of development or to receive focused and controlled feedback. This type of beta program restricts access to a limited group of selected users, often chosen based on specific criteria or invited through a registration process. Closed Beta users work closely with bol’s development team and provide targeted feedback on certain features or aspects of the product. This approach allows to address potential issues with a more manageable group of users and perform a thorough evaluation before the public release.

    All closed Beta endpoints reveal their status by displaying a Closed Beta tag.

Signing up for a Beta program

  • Open Beta - Open Beta programs offer public accessibility without requiring any registration from participants.

  • Closed Beta - To sign up for one of the limited spots of the upcoming closed Beta programs, mail us here.

    Ensure that you provide the following details in your email:

    • Retailer ID

    • Shop name

    • Phone number

    • Details of the beta you wish to participate in

Functional and project Beta

We differentiate between functional Beta and project Beta.

Functional Beta is used to review the behaviour of existing functionality in the API. For example, this could include:

  • Traffic consumption

  • Quality of data returned

  • Enhancing product placements

Project Beta allows us to preview new functionality that we hope to make part of the Retailer API. They are API endpoints that are still subject to possible change before going live, and we’re using these betas to gather feedback based on the way the API is designed.

What feedback we are looking for?

We are looking for any feedback on the functional and technical use. Some areas of feedback might include the following:

General

  • Is the Retailer API logically structured and understandable?

  • Do you see points of improvements?

Performance

  • How do you experience the performance?

  • Do the applied rate limits work for you?

Documentation

  • Is the functional documentation clear for you and was it complete?

  • Is the ReDoc API documentation correct and complete?

  • Does the demo environment work for you and cover all the scenarios?

What will you get from us?

We supply you with the following items:

  • Functional documentation at developers.bol.com

  • ReDoc documentation on api.bol.com

  • Demo environment for API simulation

  • Postman collection containing the endpoints

  • Access to the beta endpoints as long as the beta period runs

What do we expect from you?

Participating in the beta means that you will be involved actively in our testing and feedback program. With this, we expect the following from you:

  • When participating in the beta, beta-related questions can be posted on our GitHub page.

  • Issues that you encounter that are not part of one of the beta endpoints must be directed to Partner Services.

  • The current running production endpoints remain working. In case of issues, you can use the latest production version to support your regular business processes.

  • For each beta period, we define a moment to get into contact with each other. In this moment, we can get a better understanding of the rationale behind your findings/questions.

In case you encounter any issues, please let us know:

  • The endpoint name where you experience issues

  • The date and time on which you experienced an issue

  • The error you encountered

  • The result you were expecting

  • Reproduction path: what did you do that resulted in this error?

Our promises to you

During our beta program, we guarantee the following:

  • We refrain from making breaking changes to the API. What works in the beta will remain working on the production version. Developing against our external API means that you can reuse your code for the running production version.

  • In case a breaking change becomes unavoidable, we align together with all participants on the approach and timing.

  • Being part of the beta means being part of bol. We will work closely together and incorporate your feedback as much as we can.

Disclaimer

Please be aware that participation in a beta version of the API is at your own risk. Using our beta endpoints can have impact on your regular process as they might behave differently than expected. In this case, please reach out to the respective beta team. Penalties on your partner performance do not count for beta endpoints.