Introduction

Budbee is a last-mile delivery service operating across Scandinavia. This documentation covers the REST API for creating and managing delivery orders, tracking parcels, and handling returns.

Overview

The Budbee API is a RESTful JSON API. All requests and responses use application/json unless otherwise specified. Versioning is communicated via the Content-Type header (e.g. application/vnd.budbee.orders-v2+json).

Environments

Use the sandbox environment for development and testing. Orders created in the sandbox do not result in real deliveries.

Date & Time Format

All timestamps in the Budbee API are represented as Unix epoch milliseconds (not ISO 8601). For example, 1717257600000 represents 2024-06-01T16:00:00Z.

Important: Do not use ISO 8601 strings for date fields. Always use Unix epoch milliseconds.

Typical Integration Flow

1. Authenticate — obtain your API key and secret from the Budbee merchant portal
2. Validate postal code — check the recipient address is within the delivery area
3. Get delivery dates — retrieve available delivery windows for the postal code
4. Create order — submit the order with recipient details and the chosen interval
5. Add parcels — attach one or more parcels to the order and retrieve label URLs
6. Print labels — download and print labels for each parcel
7. Track — use tracking URLs to follow parcel status
8. Webhooks — receive real-time status updates via webhook callbacks

Prerequisites

Before going live you will need:

• API credentials (key + secret) from your Budbee account manager
• At least one collection point (sender address) configured in the Budbee merchant portal
• Confirmation of which product codes are enabled for your account