Getting Started

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

Note that we have also 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

The sandbox environment allows you to test your integration without sending requests and 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 and use it for the API routes which need authentication
• Set your webhooks up for whichever events you care about (to track parcels/shipments in real-time)

📘

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:

• Ask our experts to set up a production account for you
• Add a valid credit card or ask our support team to change your account type from Card-based to Credit (to be billed periodically)
• Get your API Key here and use it for the API routes which need authentication
• Update your company info and logo, and add your team members (to access your account for viewing/placing orders)
• Set your webhooks up for whichever events you care about (to track parcels/shipments in real-time)