# Sparqle API

> Create deliveries, fetch labels, and track orders with the Sparqle API.

## Docs

- [Sparqle API](https://docs.sparqle.com/introduction.md): Create deliveries, fetch shipping labels, and track orders in real time.
- [Quickstart](https://docs.sparqle.com/quickstart.md): Create your first Sparqle delivery and print its label.
- [Authentication](https://docs.sparqle.com/authentication.md): Authenticate every request with your Sparqle API key.
- [Environments](https://docs.sparqle.com/environments.md): Test and live base URLs for the Sparqle API.
- [Order lifecycle](https://docs.sparqle.com/concepts/order-lifecycle.md): Every status a Sparqle order moves through, and what each one means.
- [Routing & fallback](https://docs.sparqle.com/concepts/routing.md): Check deliverability before creating, and fall back to another carrier when needed.
- [Pickup points](https://docs.sparqle.com/concepts/pickup-points.md): Let a shopper collect their parcel from a pickup point or parcel locker instead of at home.
- [Labels](https://docs.sparqle.com/concepts/labels.md): Fetch printable PDF labels for an order or a whole bundle.
- [Order bundling](https://docs.sparqle.com/concepts/order-bundling.md): Ship several parcels together by grouping orders into one delivery bundle.
- [Webhooks](https://docs.sparqle.com/webhooks.md): Receive a POST to your endpoint whenever an order changes status.
- [Errors & rate limits](https://docs.sparqle.com/errors.md): How the Sparqle API reports failures and throttles requests.
- [Upload orders from a spreadsheet](https://docs.sparqle.com/guides/manual-order-upload.md): Create multiple orders from an Excel or CSV file in the Sparqle dashboard.
- [API reference](https://docs.sparqle.com/api-reference/introduction.md): Endpoints, request bodies, and response schemas for the Sparqle API.
- [Create order](https://docs.sparqle.com/api-reference/orders/create-order.md): Create a delivery order. Returns the created order including its `orderId`, `barcode`, and `trackingUrl`.
- [Check order](https://docs.sparqle.com/api-reference/orders/check-order.md): Validate a delivery address and serviceability for a location before creating an order.
- [Get label](https://docs.sparqle.com/api-reference/orders/get-label.md): Fetch the shipping label for an order as a base64-encoded PDF.
- [Get label by bundle ID](https://docs.sparqle.com/api-reference/orders/get-label-by-bundle-id.md): Fetch the labels for all orders in a bundle.
- [Cancel order](https://docs.sparqle.com/api-reference/orders/cancel-order.md): Cancel an order. Allowed up to and including the `in_transit` status.
- [Search pickup points](https://docs.sparqle.com/api-reference/pickup-points/search-pickup-points.md): Find the pickup points (PUDO locations) closest to an address or coordinate, ordered by distance. Pass the `pudoId` of the point your shopper selects straight through to the order's `pudoId`.

## OpenAPI Specs

- [openapi](https://docs.sparqle.com/api-reference/openapi.json)