# SureDone API

> SureDone is a multichannel e-commerce platform. The public REST APIs (v1 legacy, v3 current) cover product inventory, orders, automations, bulk operations, webhooks, and account management. Authentication is via paired `X-Auth-User` + `X-Auth-Token` headers; tokens are generated at https://app.suredone.com/settings/organization/security.

## Specs

- [OpenAPI 3.1 — v3](https://docs.suredone.com/v3.json): current API. Orders, automations, webhooks, registration, account, logging.
- [OpenAPI 3.1 — v1](https://docs.suredone.com/v1.json): legacy API. Products, orders, bulk operations, settings, taxonomy, options.

## Reference UIs

- [API v3 reference](https://docs.suredone.com/): interactive Scalar UI for v3.
- [API v1 reference](https://docs.suredone.com/v1/): interactive Scalar UI for the legacy v1 surface.

## Full markdown reference

- [llms-full.txt](https://docs.suredone.com/llms-full.txt): full markdown rendering of both OpenAPI specs (~800 KB). v3 appears first, followed by a `<!-- END v3 / BEGIN v1 -->` boundary, then v1 (legacy). For token-budgeted ingestion, fetch only up to the boundary.

## v3 capability areas

- [Orders](https://docs.suredone.com/#tag/orders-requests): create, read, update, list, ship orders across all connected channels.
- [Automations](https://docs.suredone.com/#tag/automation-requests): trigger and inspect automation runs (imports, exports, sync jobs).
- [Webhooks](https://docs.suredone.com/#tag/webhooks): subscribe to platform events (order created, item updated, etc.).
- [Account](https://docs.suredone.com/#tag/account): manage account lifecycle and sub-users.
- [Registration](https://docs.suredone.com/#tag/registration): programmatic account creation for MaaS/partner integrations.
- [Logging](https://docs.suredone.com/#tag/logging-requests): query operational logs by user, channel, date range.

## v1 capability areas

- [Items](https://docs.suredone.com/v1/#tag/items): product CRUD, variants, custom fields.
- [Orders](https://docs.suredone.com/v1/#tag/orders): legacy order endpoints.
- [Bulk](https://docs.suredone.com/v1/#tag/bulk): bulk imports/exports (CSV-based).
- [Settings](https://docs.suredone.com/v1/#tag/settings): channel and account settings.
- [Taxonomy](https://docs.suredone.com/v1/#tag/taxonomy): category taxonomy lookups (eBay, Amazon, etc.).
- [Options](https://docs.suredone.com/v1/#tag/options): channel option definitions (size, color, etc.).
- [Authentication](https://docs.suredone.com/v1/#tag/authentication): legacy auth-token exchange.
- [Logs](https://docs.suredone.com/v1/#tag/logs): v1 log retrieval.

## Conventions

- Base URL: `https://api.suredone.com`
- Rate limits: 300 req/min on read endpoints (`GET`, `TRACE`, `CONNECT`); 60 req/min on write endpoints (`POST`, `PATCH`, `PUT`, `DELETE`); 300 req/min on `OPTIONS`. Responses include `X-Rate-Limit-Limit`, `X-Rate-Limit-Remaining`, `X-Rate-Limit-Reset`, `X-Rate-Limit-Type` headers and return `429` when throttled.
- All requests are JSON unless documented otherwise (bulk endpoints accept CSV).

## Support

- [SureDone Support Portal](https://support.suredone.com/): knowledge base and ticket submission.
- [SureDone Guides](https://www.suredone.com/guides/): conceptual guides and how-tos covering channel setup, fulfillment, fitment data, and integrations.
- Security disclosures: see [/.well-known/security.txt](https://docs.suredone.com/.well-known/security.txt).