# Bob Box API Documentation

> The Bob Box API lets you book parcels into Bob Box smart lockers and pickup points across South Africa, and track them until collection. Base URL: production `https://api.bobbox.co.za`.

Every page is also available as plain Markdown by appending `.md` to its URL path.

## Introduction

- [Welcome to the Bob Box API](/introduction.md): The Bob Box API is the gateway to South Africa's courier-agnostic smart locker network.

## Workflows

- [Integration workflows](/workflows.md): The delivery patterns the Bob Box network supports, and how each one maps onto the API.

## Getting started

- [Getting started](/getting-started.md): This walks through the core integration flow: authenticate, find a location, create a reservation, and hand your customer the PIN that opens the locker.

## Authentication

- [Authentication](/authentication.md): Bob Box integrations use an API key as a bearer token.

## Locations

- [Locations](/locations.md): The Locations API lets you find Bob Box locker locations — for showing pickup and dropoff points to your customers.
- [GET Get account locations](/locations/account-locations.md): Retrieve locker locations available to your account.

## Reservations

- [Reservations](/reservations.md): The Reservations API is the core of the Bob Box integration — reserving a locker compartment for a parcel, looking up reservations, and cancelling one.
- [POST Create reservation](/reservations/create-reservation.md): Reserve a compartment at a location for a parcel.
- [GET Get reservations](/reservations/reservations.md): Retrieve your account's reservations, filterable by location, status, reference, or a named date range.
- [GET Get reservation PINs](/reservations/reservation-pins.md): Re-fetch the PINs for a reservation.
- [POST Cancel reservation](/reservations/cancel-reservation.md): Cancel a reservation that has not been dropped off yet, freeing up the compartment.

## Webhooks

- [Webhooks](/webhooks.md): Instead of polling the Get reservations endpoint, you can have Bob Box push a POST to your own URL whenever a reservation's status changes or its PINs are re...

## Optional

- [Complete documentation in a single file](/llms-full.txt)