Test and Production System 💻

Use the sandbox to build and test your integration without triggering real transports.

The Cargoboard API is available in two environments:

EnvironmentBase URLUse it for
Sandbox (test)https://api-sandbox.cargoboard.comDevelopment and testing — no real transport is triggered
Productionhttps://api.cargoboard.comLive shipments — every order is executed and incurs costs
🚧

Production orders are real

An order sent to the production environment is scheduled for pickup: a truck will come to collect the goods, and real costs are incurred. Always build and test your integration in the sandbox first.

Sandbox

  • Test every endpoint without creating a real transport order — you can't break anything.
  • For test bookings you still receive an order confirmation by e-mail, so you can double-check the data you sent.
  • We're happy to help you test and validate the data you send to the API before you go live.

API keys per environment

The sandbox and production environment use different API keys. A key only works in the environment it was issued for — using it against the other environment results in 403 Forbidden (see Error Messages).

Going live

  1. Build your integration and test all calls you need — quotation, booking, labels, tracking — in the sandbox.
  2. Book a test order in the sandbox exactly as your system will send it later, and send the shipment number (data.reference) to Patrick at [email protected].
  3. We review the data you sent. This step prevents surcharges or missing information on your real shipments.
  4. Once everything is fine, we activate your production key. You'll find it in my.cargoboard.com under Account → Integration when you're logged in.
  5. Switch the base URL to https://api.cargoboard.com and replace your sandbox key with your production key.

Request an API key

Want to try the API? Request an API key from Patrick at [email protected] — he replies quickly.