API overview
Connect your application to ZCard.
Choose the API for your role, then check authentication and fields.
Choose your API
SUPPLYConnect stores →
Signed requests, prices, stock, orders, and delivery.
STOREFRONTBuild a buyer experience →Catalog, members, cart, payments, and support.
ADMINManage your store →Products, inventory, orders, roles, and settings.
| API | Prefix | Authentication | Generated operations |
|---|---|---|---|
| Native Supply v2 | /api/supply/ | Four signed headers; Ping is public | 10 |
| Storefront | /api/v1/storefront/ | Public or member Bearer token, depending on operation | 74 |
| Admin | /api/v1/admin/ | Admin Bearer token and roles, except public operations | 259 |
The reference covers 343 operations across 49 services from the current generated definitions. Manually registered compatibility routes are documented separately. This count does not mean that all operations have passed runtime integration tests.
Start here
- Read Conventions for JSON names, numeric types, amounts, and versions.
- Choose Supply authentication, Storefront authentication, or Admin authentication.
- Browse the API reference and Error handling.
- For supply integrations, check the current implementation limitations before creating orders.
Download specifications and examples
- Wire-format OpenAPI JSON: JSON field names and numeric types reconciled against Go types.
- Original generated OpenAPI YAML: unmodified source snapshot; some JSON aliases differ from the default runtime codec.
- Node.js signed client: a read-only product-list example.
Examples use placeholder domains and credentials. Use your own test instance. This website does not send purchase or refund requests.