# Delivr Merchant API

> The Delivr Merchant API lets retailers quote and book same-day deliveries (on demand, a driver now, or in a service window) from their checkout, report when goods are ready, cancel, and receive signed webhooks.

- Base URLs: sandbox `https://driver-staging-api.delivr.no`; production is given at onboarding. All routes are under `/v1/merchant/`.
- The machine-readable contract is the OpenAPI 3.1 document at https://docs.delivr.no/openapi.yaml (webhooks included). Prefer it over prose for field names and types.
- Auth: `Authorization: Bearer dmk_...` (server-side only). Every write except `POST /v1/merchant/quotes` needs an `Idempotency-Key` UUID header.
- Money is integer minor units (øre), VAT included. Times are RFC 3339. Request bodies are strict: unknown fields are rejected.
- Every guide page is also plain Markdown: drop the trailing slash and add `.md`, e.g. https://docs.delivr.no/quickstart.md. The Docs list below links each one.
- Sandbox: robo drivers deliver on-demand orders in about two minutes. Send `POST /v1/merchant/orders/{id}/ready` after placing so the driver search starts at once.

## Docs

- [Overview](https://docs.delivr.no/overview.md): How the Delivr Merchant API fits into your checkout, your stores and your order system.
- [Quickstart](https://docs.delivr.no/quickstart.md): Add a store, quote a delivery, place an order and watch it get delivered in the sandbox.
- [Authentication](https://docs.delivr.no/authentication.md): API keys, scopes, and how to keep them safe.
- [Sandbox and testing](https://docs.delivr.no/sandbox.md): Test your integration end to end with robo drivers, no real SMS and directives for every failure path.
- [Store locations](https://docs.delivr.no/guides/locations.md): Register the stores and warehouses your goods are picked up from.
- [Quotes and orders](https://docs.delivr.no/guides/quotes-and-orders.md): Price the delivery options for an address, then book the one your shopper picks.
- [Showing options at checkout](https://docs.delivr.no/guides/checkout-options.md): When to quote, how to label on-demand and window options for shoppers, and what to keep for the order.
- [Order lifecycle](https://docs.delivr.no/guides/order-lifecycle.md): Every status, event and reason an order can have, and how to handle them.
- [Goods ready signals](https://docs.delivr.no/guides/ready-signals.md): Tell Delivr when the goods are packed, so the driver arrives when the parcel does.
- [Receiving webhooks](https://docs.delivr.no/webhooks.md): Get a signed HTTPS call for every change to your orders.
- [Verifying signatures](https://docs.delivr.no/webhooks/signatures.md): Check that a webhook really comes from Delivr and has not been replayed.
- [Event types](https://docs.delivr.no/webhooks/events.md): Every webhook event and when it is sent.
- [Testing webhooks](https://docs.delivr.no/webhooks/testing.md): Try your webhook handler locally with signed sample events, then with real sandbox events.
- [Requests and responses](https://docs.delivr.no/conventions.md): Formats, headers and conventions shared by every endpoint.
- [Idempotency](https://docs.delivr.no/conventions/idempotency.md): Retry any write safely with an Idempotency-Key.
- [Errors](https://docs.delivr.no/conventions/errors.md): Error format, codes, and what to do about each.
- [Rate limits](https://docs.delivr.no/conventions/rate-limits.md): How many requests you can make, and how to stay within the limit.
- [Versioning](https://docs.delivr.no/conventions/versioning.md): How the API changes, and how to stay compatible.
- [Cancelling](https://docs.delivr.no/guides/cancelling.md): Check what a cancellation costs, then cancel with a fee cap.
- [Fallbacks](https://docs.delivr.no/guides/fallbacks.md): What happens when an on-demand order fails, and how successor orders work.
- [Assisted checkout](https://docs.delivr.no/guides/assisted-checkout.md): Find a driver while the customer is still at your till or on the phone, then complete the sale.
- [The recipient's experience](https://docs.delivr.no/guides/recipient.md): What your customer sees, from the SMS to the tracking page.
- [Billing](https://docs.delivr.no/guides/billing.md): How Delivr prices and invoices your deliveries.
- [Go-live checklist](https://docs.delivr.no/go-live.md): What to check before you switch your integration to production.
- [Build with AI agents](https://docs.delivr.no/ai.md): Give your coding agent everything it needs to integrate the Delivr Merchant API.
- [Client libraries](https://docs.delivr.no/client-libraries.md): Generate a typed client from the OpenAPI document, or import it into Postman or Insomnia.
- [Glossary](https://docs.delivr.no/glossary.md): The terms these docs and the API use.
- [FAQ](https://docs.delivr.no/faq.md): Short answers to the questions integrators ask most.
- [Support](https://docs.delivr.no/support.md): How to get help with your integration.
- [Changelog](https://docs.delivr.no/changelog.md): Changes to the Delivr Merchant API, newest first.

## Documentation Sets

- [Abridged documentation](https://docs.delivr.no/llms-small.txt): a compact version of the documentation for Delivr Merchant API, with non-essential content removed
- [Complete documentation](https://docs.delivr.no/llms-full.txt): the full documentation for Delivr Merchant API

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [OpenAPI 3.1 document](https://docs.delivr.no/openapi.yaml): Every route, schema, error code and webhook.