TTocler Docs
Dashboard
API reference›Shop API

Orders

List and read orders with their money, lines, payment and delivery; deliver a service line.

Updated 3 November 2026Live from Tocler
GET /v1/orders Your shop’s API keyorders:read

The shop’s orders, newest first, up to 100 a page. Page with starting_after = the last order id you got.

  • statusstringquery
    pending, paid, cancelled, expired or refunded.
  • viastringquery
    shop or api.
  • created_afterstringquery
    ISO date-time.
  • limitintegerquery
    1–100 (default 25).
  • starting_afterstringquery
    An order id from the previous page.
Errors
  • 403 missing_scope — The key lacks orders:read.
  • 401 invalid_key — No key, a wrong key, or a revoked / expired key (key_revoked, key_expired).
  • 429 rate_limited — Over the key’s requests per minute — wait for RateLimit-Reset.
curl -X GET 'https://api.tocler.com/v1/orders' \
  -H 'Authorization: Bearer tk_live_…'
GET /v1/orders/{id} Your shop’s API keyorders:read

An order with its money (in the order’s currency), its lines, payment and delivery. Follow a Tocler Pay payment here: status becomes paid once Tocler confirmed it on the blockchain.

  • idstringpathrequired
    The order id.
Errors
  • 403 missing_scope — The key lacks orders:read.
  • 404 not_found — No such order in this shop.
  • 401 invalid_key — No key, a wrong key, or a revoked / expired key (key_revoked, key_expired).
  • 429 rate_limited — Over the key’s requests per minute — wait for RateLimit-Reset.
curl -X GET 'https://api.tocler.com/v1/orders/{id}' \
  -H 'Authorization: Bearer tk_live_…'
POST /v1/orders/{id}/lines/{index}/deliver Your shop’s API keyorders:write

Mark a paid service line delivered, with a note the buyer sees (the same as “Mark delivered” in the Dashboard; the buyer is emailed). Physical goods are shipped in the Dashboard (Shipments). Send an Idempotency-Key header.

  • Idempotency-Keystringheaderrequired
    1–64 letters, digits, _ - : . — the same one when you retry. The same key with another body → 409 idempotency_mismatch.
  • idstringpathrequired
    The order id.
  • indexintegerpathrequired
    The line’s index (from lines).
  • messagestringbody
    A note for the buyer (2–5,000 characters).
Errors
  • 403 missing_scope — The key lacks orders:write.
  • 404 not_found — No such order.
  • 409 conflict — This line is not waiting for delivery (not paid, already delivered, or shipped goods).
  • 401 invalid_key — No key, a wrong key, or a revoked / expired key (key_revoked, key_expired).
  • 429 rate_limited — Over the key’s requests per minute — wait for RateLimit-Reset.
curl -X POST 'https://api.tocler.com/v1/orders/{id}/lines/{index}/deliver' \
  -H 'Authorization: Bearer tk_live_…' \
  -H 'Content-Type: application/json' \
  -d '{
  "message": "Your account was boosted to level 40. Enjoy!"
}'
Was this page helpful?