# UrbnBox

- [UrbnBox integrations](https://urbnbox.mintlify.app/index.md): Send UrbnBox deliveries from your own systems: create delivery orders, track them, and send parcels between towns.
- [Choose an integration](https://urbnbox.mintlify.app/guides/integration-options.md): Choose the lowest-friction way to send UrbnBox deliveries from your stack.
- [Quickstart](https://urbnbox.mintlify.app/quickstart.md): Create your first UrbnBox delivery order and follow it to the customer's door.
- [Pickup-point shipments](https://urbnbox.mintlify.app/guides/pickup-point-shipments.md): Send a parcel between UrbnBox pickup points with the Partner API: quote, create and track it.
- [Checkout widget](https://urbnbox.mintlify.app/guides/checkout-widget.md): Embed the UrbnBox locker booking widget in an existing checkout.
- [Shopify](https://urbnbox.mintlify.app/guides/shopify.md): Connect Shopify to UrbnBox without copying API tokens or configuring callbacks by hand.
- [WooCommerce](https://urbnbox.mintlify.app/guides/woocommerce.md): Add UrbnBox locker delivery as a WooCommerce shipping method.
- [Partners and vendors](https://urbnbox.mintlify.app/concepts/partners-and-vendors.md): Understand the difference between a Partner and a Vendor on the UrbnBox platform.
- [Authentication](https://urbnbox.mintlify.app/concepts/authentication.md): Authenticate UrbnBox server-side and browser-side API requests.
- [API reference overview](https://urbnbox.mintlify.app/reference-overview.md): Understand the UrbnBox integration API base URL, conventions, and endpoint groups.
- [Orders](https://urbnbox.mintlify.app/api-reference/vendor/orders.md): Create, list, read and cancel delivery orders with the Vendor API.
- [Webhooks](https://urbnbox.mintlify.app/api-reference/vendor/webhooks.md): Receive real-time event notifications for order and shipment state changes.
- [List orders](https://urbnbox.mintlify.app/api-reference/vendor-api/list-orders.md): Returns the vendor's orders, newest first. Use `cursor` with the `next_cursor` from the previous response to page through them.
- [Create a delivery order](https://urbnbox.mintlify.app/api-reference/vendor-api/create-a-delivery-order.md): Creates a delivery or pickup order for products in the vendor's UrbnBox catalogue and reserves their stock. When `external_reference` matches an existing order, that order is returned instead of a new one (still `201`).
- [Download orders CSV template](https://urbnbox.mintlify.app/api-reference/vendor-api/download-orders-csv-template.md): Returns `urbnbox-orders-template.csv` — a pre-formatted CSV with correct headers and two example rows. No authentication required. Fill it in, then POST to `/api/vendor/v1/orders/import-csv`.
- [Bulk import orders via CSV](https://urbnbox.mintlify.app/api-reference/vendor-api/bulk-import-orders-via-csv.md): Upload a CSV file to validate and preview order creation. Returns a row-by-row result — valid rows and any errors. Use `/api/vendor/v1/orders/csv-template` to download the correct format first.
- [List webhooks](https://urbnbox.mintlify.app/api-reference/vendor-api/list-webhooks.md)
- [Create webhook](https://urbnbox.mintlify.app/api-reference/vendor-api/create-webhook.md)
- [Delete webhook](https://urbnbox.mintlify.app/api-reference/vendor-api/delete-webhook.md)
- [Get earnings summary](https://urbnbox.mintlify.app/api-reference/vendor-api/get-earnings-summary.md): Returns the authenticated vendor's ledger balance and recent payout history.
- [Pickup-point shipments](https://urbnbox.mintlify.app/api-reference/vendor/shipments.md): Send parcels between UrbnBox pickup points with the Vendor API.
- [List shipments](https://urbnbox.mintlify.app/api-reference/vendor-api/list-shipments.md)
- [Create shipment](https://urbnbox.mintlify.app/api-reference/vendor-api/create-shipment.md)
- [Download shipments CSV template](https://urbnbox.mintlify.app/api-reference/vendor-api/download-shipments-csv-template.md): Returns `urbnbox-shipments-template.csv` — a pre-formatted CSV with correct headers and two example rows. No authentication required. Fill it in, then POST to `/api/vendor/v1/shipments/import-csv`.
- [Bulk import shipments via CSV](https://urbnbox.mintlify.app/api-reference/vendor-api/bulk-import-shipments-via-csv.md): Upload a CSV file to validate shipment rows. Returns per-row results. Use `/api/vendor/v1/shipments/csv-template` to download the correct format first.
- [Get a shipment quote](https://urbnbox.mintlify.app/api-reference/vendor-api/get-a-shipment-quote.md): Returns a price quote for a shipment without creating it.
- [Create a shipment quote](https://urbnbox.mintlify.app/api-reference/shipments/create-a-shipment-quote.md): Checks locker availability and returns a fee quote. The origin locker is selected by the server.
- [Create a shipment](https://urbnbox.mintlify.app/api-reference/shipments/create-a-shipment.md): Creates a locker-to-locker shipment. This endpoint requires a secret partner key. The deposit PIN is returned only in this response.
- [Retrieve a shipment](https://urbnbox.mintlify.app/api-reference/shipments/retrieve-a-shipment.md): Returns a shipment owned by the authenticated partner.
- [List locker availability](https://urbnbox.mintlify.app/api-reference/checkout-sessions/list-locker-availability.md): Returns active locker spaces available for partner checkout.
- [Create a checkout session](https://urbnbox.mintlify.app/api-reference/checkout-sessions/create-a-checkout-session.md): Creates a partner checkout session and holds a locker. Supply an Idempotency-Key when retrying a request.
- [Retrieve a checkout session](https://urbnbox.mintlify.app/api-reference/checkout-sessions/retrieve-a-checkout-session.md): Returns a checkout session owned by the authenticated partner.
- [Cancel a checkout session](https://urbnbox.mintlify.app/api-reference/checkout-sessions/cancel-a-checkout-session.md): Cancels a partner checkout session.
- [List public stores](https://urbnbox.mintlify.app/api-reference/store-discovery/list-public-stores.md): Returns active stores and their available capacity.
- [Find nearby stores](https://urbnbox.mintlify.app/api-reference/store-discovery/find-nearby-stores.md): Returns stores within a radius of a geographic coordinate.
- [List public booking options](https://urbnbox.mintlify.app/api-reference/public-bookings/list-public-booking-options.md): Returns locker spaces for the browser checkout widget.
- [Create a public locker booking](https://urbnbox.mintlify.app/api-reference/public-bookings/create-a-public-locker-booking.md): Creates the locker booking used by the checkout widget.
- [Get Shopify carrier rates](https://urbnbox.mintlify.app/api-reference/shopify/get-shopify-carrier-rates.md): Shopify calls this endpoint to request an UrbnBox shipping rate. The callback URL is provisioned by UrbnBox with a signed partner-bound token.
- [Process a paid Shopify order](https://urbnbox.mintlify.app/api-reference/shopify/process-a-paid-shopify-order.md): Creates an UrbnBox shipment for a connected Shopify store when a paid order selected UrbnBox delivery.

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [UrbnBox](https://portal.urbnbox.io)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.