Getting Started

This document details the full technical specification of the FlashBox API.

Note that we have a Postman Collection available to help you play around with our API.

We have two available environments: Sandbox and Production. Here's more detail on each including account setup information:

SandBox Environment

API URL: https://api-sandbox.flashbox.co

Sandbox allows you to test your integration without sending requests and test your API calls without going through the live environment. It comes with a simulator that allows your orders to be handled by bots acting like real drivers.

To get set up in Sandbox Environment:

• Create a merchant account in sandbox
• Add a valid credit card (you can find the list of test credit card numbers, here. Do not use American Express)
• Get your API Key here

Once the steps above are completed, you will be able to authenticate using your JWT Access Token ready to use our API in Production.

📘

Mocking

6 different mocking scenarios are provided here for having a better overview of different versions of response objects.

Production Environment

API URL: https://api.flashbox.co

Our Production environment is where the real magic happens - you can create same-day and next-day orders in the real world! If you feel ready to move your code to production and start using the FlashBox API with real orders.

To get set up in Production:

• Create a merchant account in production
• Add a valid credit card
• Get your API Key here

Once the steps above are completed, you will be able to authenticate using your JWT Access Token ready to use our API in Production.

Please contact your Account Manager to discuss alternative payment methods or any other operational topics.