> ## Documentation Index
> Fetch the complete documentation index at: https://urbnbox.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Choose an integration

> Choose the lowest-friction way to send UrbnBox deliveries from your stack.

Start with the integration that matches the system you already operate.

| Integration | Setup | Credential | Use it when |
| - | - | - | - |
| Vendor API: delivery orders | Your backend | Vendor API key | You want UrbnBox riders to deliver your orders to customers |
| Shopify Connect | UrbnBox dashboard | Shopify OAuth | Your store runs on Shopify |
| WooCommerce | WordPress plugin | Secret key | Your store runs on WooCommerce |
| Partner API: pickup-point shipments | Your backend | Secret key | You run a storefront, marketplace or OMS and send parcels between towns |
| Checkout widget | Customer browser | Publishable key | Customers choose a pickup point at checkout, with minimal frontend code |

## Delivery orders

Use the Vendor API when your system should hand orders to UrbnBox for delivery.
Your backend creates each order with the customer's details and address, and
reads its status as it moves from confirmation to delivery. You can also check
a spreadsheet of orders before you send them.

> **[Create your first delivery order](https://urbnbox.mintlify.site/quickstart.md)**
>
> Create a vendor API key and make your first request.

## Shopify

Shopify merchants should use **Connect Shopify** in the UrbnBox dashboard.
UrbnBox handles authorization, carrier-rate registration, and paid-order
webhooks automatically. You do not copy Shopify Admin API tokens into UrbnBox.
Shopify orders are delivered through UrbnBox pickup points.

> **[Connect Shopify](https://urbnbox.mintlify.site/guides/shopify.md)**
>
> See the merchant connection flow.

## WooCommerce

Install the UrbnBox WooCommerce shipping plugin and configure your UrbnBox
credential in WordPress. The plugin offers pickup-point delivery at checkout.

> **[Install the WooCommerce integration](https://urbnbox.mintlify.site/guides/woocommerce.md)**
>
> Configure the shipping method.

## Pickup-point shipments

Use the Partner API when your application already has a trusted backend and
sends parcels between towns. Your backend can request a quote, create
shipments, retrieve shipment state, and receive signed UrbnBox lifecycle
webhooks.

This suits custom storefronts, marketplaces, mobile backends, ERP and OMS
platforms. You do not need a platform-specific UrbnBox plugin.

> **[Send a pickup-point shipment](https://urbnbox.mintlify.site/guides/pickup-point-shipments.md)**
>
> Create credentials and make your first request.

## Checkout widget

Use the widget when you can add HTML and JavaScript to checkout but do not want
to build a pickup-point picker yourself.

> **[Embed the checkout widget](https://urbnbox.mintlify.site/guides/checkout-widget.md)**
>
> Add the widget to your page.


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