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 from the label: 6 to 40 letters, digits and dashes (PostNL: 3S and 11 more, or the international RR123456789NL form). Required when the parcel was paid as tracked.
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."
}
}
A tracked parcel without a tracking number.
{
"error": {
"code": "tracking_required",
"message": "The parcel was paid as tracked, so a tracking number is required."
}
}
The tracking number isn't valid for the carrier.
{
"error": {
"code": "invalid_tracking",
"message": "PostNL tracking numbers start with 3S and have 13 characters."
}
}
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."
}
}
Hai ancora bisogno di aiuto? Contattaci: rispondiamo entro 2 giorni lavorativi.
Usiamo i cookie necessari per mantenere l’accesso e salvare il tuo carrello. Se sei d’accordo, contiamo anche le visite, per capire cosa migliorare. Nessun cookie pubblicitario.