API reference#
Every endpoint the Distribution API exposes — 25 operations across 22 paths — generated from the OpenAPI document that the running service publishes.
The machine-readable spec is at /openapi/distribution.json.
Health#
| Endpoint | |
|---|---|
GET | Verify your API key |
Search#
| Endpoint | |
|---|---|
POST | Search listings |
Listings#
| Endpoint | |
|---|---|
GET | List listings |
GET | Get one listing |
Availability#
| Endpoint | |
|---|---|
GET | List daily availability |
Rates#
| Endpoint | |
|---|---|
GET | List rates |
Promotions#
| Endpoint | |
|---|---|
GET | List promotions running on listings |
Filters#
| Endpoint | |
|---|---|
GET | Filter bar for your channel |
Orders#
| Endpoint | |
|---|---|
POST | Price an order without creating it |
POST | Price a new order |
GET | Get a priced order |
POST | Reprice an order |
Bookings#
| Endpoint | |
|---|---|
POST | Book an order on credit |
GET | Get one booking |
GET | List bookings |
PATCH | Amend a booking in place |
POST | Apply an amendment to a booking |
GET | Quote a cancellation |
POST | Cancel a booking |
Ledger#
| Endpoint | |
|---|---|
GET | List ledger entries |
GET | Get statement |
Invoices#
| Endpoint | |
|---|---|
GET | List invoices |
GET | Get one invoice |
GET | Download an invoice PDF |
POST | Run billing now |