Skip to main content
The Sparqle API lets you plug Sparqle delivery into your own systems. Create an order, print the label we generate, and receive status updates over webhooks as the parcel moves from your warehouse to your customer’s door.

​
What you can do

Create orders

Submit a delivery and receive a Sparqle orderId, barcode, and tracking URL.

Validate before you commit

Use Check order to validate an address and serviceability before creating.

Print labels

Fetch a base64-encoded PDF label for a single order or a whole bundle.

Track in real time

Subscribe to status webhooks across the full order lifecycle.

​
How it works

1

Authenticate

Every request is authenticated with an API key sent in the api-key header. See Authentication.
2

Create an order

POST /orders with the recipient address and your locationId. Sparqle returns an orderId, a barcode, and a trackingUrl.
3

Print the label

Fetch the label with GET /orders/label/{orderId} and print the PDF.
4

Track the delivery

Receive webhooks as the order moves through its lifecycle, or poll the order endpoint.

​
Before you start

You’ll need an API key and at least one locationId (the pickup location orders are dispatched from). Both are provided by your Sparqle contact — reach out to [email protected] if you don’t have them yet.

Jump to the quickstart

Create your first order in a few minutes.