# Bob Go API Documentation

> The Bob Go API lets you rate, book and track shipments across every courier Bob Go supports, using a single integration. Base URLs: sandbox `https://api.sandbox.bobgo.co.za`, production `https://api.bobgo.co.za`.

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

## Introduction

- [Bob Go API](/introduction.md): The Bob Go API lets you rate, book and track shipments across every courier Bob Go supports, using a single integration.

## Authentication

- [Authentication](/authentication.md): Bob Go authenticates API traffic with a long-lived API key presented as a bearer token.

## Getting started

- [Getting started](/getting-started.md): There are two ways in, and which one you want depends on whether Bob Go should know about your orders.

## Important concepts

- [Important concepts](/important-concepts.md): A few objects and ideas turn up across the whole API.

## Rates at checkout

- [POST Get checkout rates](/rates-at-checkout.md): Returns the shipping options a buyer should be offered, priced by the rules you have configured in Bob Go.

## Orders

- [Orders](/orders.md): An order is what your buyer placed.
- [POST Create an order](/orders/order-create.md): Creates an order on your Bob Go account.
- [PATCH Update an order](/orders/order-update.md): Updates an existing order.
- [GET Get orders](/orders/order-list.md): Lists orders on your account, most recently placed first.
- [GET Get order fulfillments](/orders/order-fulfillments.md): Returns every fulfilment on an order, one per shipment or buyer collection, newest first.
- [POST Create a return](/orders/order-return.md): Books a return shipment against an existing order: the courier collects from the buyer and delivers back to you.

## Packages

- [Packages](/packages.md): A package is a saved box: a name and its outer dimensions.
- [POST Create packages](/packages/packages-create.md): Creates one or more packages.
- [POST Update packages](/packages/packages-update.md): The same endpoint as Create packages(packagescreate.md).
- [GET Get packages](/packages/packages-get.md): Lists the packages on your account, the default package first and then by name.
- [DELETE Delete a package](/packages/packages-delete.md): Deletes one package, given its id in the JSON body.

## Rates

- [Rates](/rates.md): Ask the couriers what a consignment will cost you to ship.
- [POST Get rates](/rates/rates.md): Asks every courier enabled on your account to quote for a set of parcels moving between two addresses, and returns their answers in one response.
- [GET Get an existing rate request](/rates/rate-request.md): Returns a rate request you already made, with whatever the couriers have answered by now.

## Shipments

- [Shipments](/shipments.md): A shipment is a booking with a courier: parcels, two addresses, a service level and a price.
- [POST Create a shipment](/shipments/shipment-create.md): Books a courier for a set of parcels.
- [GET Get shipments](/shipments/shipment-list.md): Lists shipments on your account, newest first.
- [POST Cancel a shipment](/shipments/shipment-cancel.md): Cancels a shipment and refunds the charge to your Bob Go account.
- [GET Get a waybill](/shipments/shipment-waybill.md): Generates the waybill PDF for one or more shipments and returns a JSON envelope with a link to it, not the file itself.
- [GET Get a sticker waybill](/shipments/shipment-sticker-waybill.md): Produces a label sized for a sticker printer, rather than the A4/A5 waybill from GET /v2/shipments/waybill(shipmentwaybill.md).
- [GET Get a proof of delivery](/shipments/shipment-pod.md): Returns the courier's proof of delivery for a shipment, typically a signature or a delivery photograph.
- [GET Poll a queued label batch](/shipments/file-history.md): Reads one generated-file record.

## Tracking events

- [GET Get tracking events](/tracking-events.md): Returns the tracking history for a shipment: every checkpoint the courier has reported, plus the shipment's current status and the courier's branding.

## Webhooks

- [Webhooks](/webhooks.md): Bob Go pushes events to a URL you own, so you do not have to poll.
- [POST Subscribe to a webhook](/webhooks/webhooks-post.md): Creates subscriptions, or changes existing ones.
- [GET Get webhook subscriptions](/webhooks/webhooks-get.md): Lists the webhook subscriptions on your account, ordered by topic.
- [DELETE Delete a webhook subscription](/webhooks/webhooks-delete.md): Removes one or more subscriptions, given their ids in the JSON body.

## Pickup points

- [GET Get pickup point locations](/pickup-points.md): A pickup point is a locker or a staffed counter that stands in for a street address.

## Optional

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