Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Topics

Introduction
Servers
Concepts
Main Features
Flow Diagrams
Webhooks
Authentication

Endpoints

Locker API
Parcel API
Carrier API
Courier App
Enduser App

Webhooks

Locker Events
- Webhook for locker updates POST
Parcel Events
- Webhook for parcel updates POST
Collection Events
- Webhook for pickup notifications POST

Powered by Bump.sh

Flow Diagrams

The main flow diagrams can be found here for implementation guidance:

Parcel Booking Flow

Parcel Cancel Flow

Courier Collection/Delivery Flow