Developers
API guides
How the Saleya Integration API behaves beyond a single endpoint: access, sync, retries, conflicts, limits and webhooks.
Guides
Getting started
- Quickstart
Get a token in the store admin and make the first requests: the token, the store and the first page of products.
- Apps, tokens and scopes
What an app can do, how scopes limit it, how tokens are issued, rotated and revoked, and how to keep them safe.
- Development store
Test the integration in a separate store of your account: the API has no test tokens.
Working with data
- Pagination and sync
Read lists page by page and keep a copy up to date with the sync cursor, deleted records included.
- Bulk operations
Set stock, write products and export orders by thousands with one NDJSON file instead of a request per record.
- Webhooks
Subscribe an endpoint to store events, check the signature in PHP, Node.js or Python and handle retries.
- Accounting through the API
Load store accounting into your books or ERP and keep it current: which tax to use, money, withholdings and closed periods.
Reliable integrations
- Errors
What an error looks like, what each status means and which errors are worth retrying.
- Idempotency
Repeat a write after a timeout without applying it twice: the Idempotency-Key header.
- Versions and If-Match
Change a record without overwriting what was changed in the store after you read it.
- Rate limits
How many requests an app and a store may send, how to read the limit headers and what to do on 429.
- API versioning
What may appear in /v1 without notice, what never changes, and how deprecations and new versions are announced.