Marks the parcel shipped and emails the buyer, with the tracking link when there is one. A parcel paid as tracked needs a tracking number. Pickup orders are handed over on the site with the buyer's code instead.
Authentication
API key in the header Authorization: Bearer kv_live_…. This call needs a Read and write key. Create keys under Your store → API.
Path parameters
Name
Type
Description
numberRequired
string
The order number, like KL-2026-004127.
Body application/json
Field
Type
Description
carrier
string
One of the carriers in the shipping form, like PostNL or DAO; anything else is saved as Other.
tracking
string
The tracking number: letters, digits and dashes, 4 to 40.
Responses
OK. The order, now shipped. See the example response with the request examples.
Can't be shipped now: not paid, already shipped, a pickup order, or a shipping change waits for the buyer.
{
"error": {
"code": "cannot_ship",
"message": "This order can't be marked shipped now."
}
}
The tracking number isn't valid.
{
"error": {
"code": "invalid_tracking",
"message": "Tracking numbers use letters, digits and dashes (4-40)."
}
}
Missing, unknown or revoked key.
{
"error": {
"code": "unauthorized",
"message": "This API key doesn't exist or was revoked."
}
}
A Read only key, or the store is suspended or closed.
{
"error": {
"code": "read_only_key",
"message": "This is a read-only key. Create a read and write key to change anything."
}
}
Too many requests. Wait the seconds in Retry-After.
{
"error": {
"code": "rate_limited",
"message": "Too many requests: up to 120 a minute per key. Try again in 12 s."
}
}
Still stuck? Contact us; we reply within 2 business days.