Developers

Saleya Integration API

Read and change the catalog, stock, orders and customers of a store from your system, and get webhooks when something changes.

Loading the search index…

Your first request

  1. 1

    In the store admin, open Settings → API and webhooks and create an app with the scopes it needs — the Quickstart guide shows it step by step.

  2. 2

    Issue a token for the app. It is shown once: keep it with the other secrets of your system. How tokens are rotated and revoked is in Apps, tokens and scopes.

  3. 3

    Call GET /me with the token: the response shows the store and the scopes the token has.

Example request
curl "https://api.saleya.app/v1/me" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
  • Errors

    A page for every error type: when it happens, what to do and the body of the response.

    Errors →
  • Changelog

    Every change of the API contract by date, the versioning policy and an Atom feed to follow them.

    Changelog →

API guides

How the Saleya Integration API behaves beyond a single endpoint: access, sync, retries, conflicts, limits and webhooks.

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.

Guides →