Get started

Build your first app

Create a private app, call the API and get webhooks in ten minutes.

Apps reach a store through the same public API the StoreLyne admin uses. A private app belongs to one store and is made by the seller, so there is no review and no OAuth to set up.

1. Create the app

In the admin open Settings, Develop apps, choose Create an app, name it and tick only the access it needs (see scopes). The access token (pat_live_...) is shown once: store it as a secret. The seller can change the access later without a new token, rotate the token, or uninstall the app, which revokes it at once.

2. Make a call

curl https://api.storelyne.com/admin/2026-11/orders?limit=10   -H "Authorization: Bearer pat_live_..."

Every list is paged with limit and after (pagination). Every POST needs an Idempotency-Key header (idempotency). Errors always have the same shape, with a docs link for the code (error codes).

3. Change something

curl https://api.storelyne.com/admin/2026-11/products   -H "Authorization: Bearer pat_live_..."   -H "Idempotency-Key: $(uuidgen)"   -H "Content-Type: application/json"   -d '{"title":"Pricing Workbook","type":"digital","status":"active","variants":[{"price":49900}]}'

Money is always in paise (49900 is ₹499) with the store currency. IDs have a prefix that names the kind: prd_, ord_, var_.

4. Hear about changes

Subscribe to webhooks instead of polling (webhooks), and check the StoreLyne-Signature header on every delivery.

Versions

The version is in the URL (2026-11). Nothing breaks inside a version: fields are only added. A new version is announced with a migration guide.