Documentation

REST API

Shop-scoped REST API, OpenAPI, and problem+json errors.

Overview

The Ticaret API is shop-scoped. Most routes require a shop session. Version: 2026-07.

  • Machine-readable OpenAPI: GET {API}/openapi.json
  • Errors use problem+json (type, title, status, detail)
  • Mutating staff calls require CSRF

Identity

| Actor | Cookie | Notes |

|---|---|---|

| Staff | ticaret_staff | Admin / SDK |

| Customer | ticaret_customer | Storefront account |

| Platform | ticaret_platform | platform-web |

Example

curl -sS "$API_URL/openapi.json" | head
curl -sS -H "Cookie: ticaret_staff=..." "$API_URL/products"

Coverage

The full path list lives in openapi.json. Highlights: products/orders/customers, cart/checkout/payments, theme install, plugin grants, e-invoice/KVKK.

Vault secrets never appear in OpenAPI or GET payloads.