API reference - Sparqle API

The endpoints in this section are defined according to Sparqle’s OpenAPI specification. Each page includes the request schema, an interactive playground, and example responses.

Base URL

All requests go to one of the environment base URLs:

Test — https://staging-v2.sparqle.tech
Live — https://v2.sparqle.com

Authentication

Send your API key in the api-key header on every request.

Endpoints

Endpoint	Method	Purpose
`/orders`	`POST`	Create an order.
`/orders/check/{locationId}`	`POST`	Validate an address and serviceability.
`/orders/label/{orderId}`	`GET`	Fetch a single label.
`/orders/label/bundle/{orderBundleId}`	`GET`	Fetch all labels in a bundle.
`/orders/cancel/{orderId}`	`PATCH`	Cancel an order.
`/pickup-points`	`GET`	Find nearby pickup points.
`/coverage/postal-codes/{locationId}`	`GET`	List the postal code areas a location covers.