status. Over the API and in webhooks, the
status is the lowercase value in the API value column below (for example
in_transit). Statuses progress as the parcel is printed, scanned, and
delivered — with separate branches for returns and exceptions.
Happy path
1
draft
The order was created and accepted. No label scanned yet.
2
expected
A label has been printed. Sparqle is expecting the parcel to enter the
network.
3
in_transit
The parcel has had its first carrier scan and is moving through the network.
4
out_for_delivery
In the bike, en route from the local depot to the recipient.
5
completed
Delivered. This is the terminal success state.
All statuses
Cancelling an order
You can cancel an order usingPATCH /orders/cancel/{orderId}. Succesfull cancellation depends on the order status. Up until in_transit every order can be cancelled. Once a parcel is out_for_delivery or beyond,
it may depend on the specific order if it can be cancelled. This can not be inferred from the API.
Terminal states (
completed, returned, lost, cancelled) won’t change
again.