Generate a token
Personal Access Tokens (PATs) are created from your store admin panel:
- Sign in to your admin panel.
- Go to Settings → API Tokens.
- Click Create token.
- Give it a name and check the scopes you need.
- Copy and save the displayed token — it is shown only once.
Each token has the shape:
nvl_live_a4f2c8e1b3d7… Use the token in your requests
Send the token in the Authorization header on every request:
curl https://api.nuvlyx.com/api/v1/external/orders \
-H "Authorization: Bearer nvl_live_a4f2c8e1b3d7…" JavaScript / Node
const r = await fetch("https://api.nuvlyx.com/api/v1/external/orders", {
headers: { Authorization: `Bearer ${process.env.NUVLYX_TOKEN}` }
});
const orders = await r.json(); Python
import os, requests
r = requests.get(
"https://api.nuvlyx.com/api/v1/external/orders",
headers={"Authorization": f"Bearer {os.environ['NUVLYX_TOKEN']}"},
)
orders = r.json() Available scopes
A scope is an atomic permission granted to a token. If your token lacks the
scope an endpoint requires, the API responds 403 Forbidden.
| Scope | Allows |
|---|---|
products:read | List products and variations. |
products:write | Create and update products. |
inventory:read | Inspect inventory and stock. |
inventory:write | Upload licenses and move stock. |
orders:read | Read orders and their status. |
orders:write | Create orders on behalf of customers. |
customers:read | Read customers and their data. |
customers:write | Create and update customers. (coming soon) |
wallet:read | Inspect wallet balance. |
wallet:write | Top up customer wallets. |
webhooks:manage | Manage webhook endpoints. |
Security best practices
- Use minimum scopes: if your bot only reads orders, don't grant
wallet:write. - Store the token in environment variables, never in versioned code.
- Rotate tokens periodically: create a new one and revoke the old one once the integration switches over.
- Revoke immediately if you suspect a token leaked. The action is irreversible.
- Always use HTTPS. The API rejects plain HTTP requests.
Auth errors
| Status | When |
|---|---|
401 | Token missing, malformed, revoked or expired. |
403 | Token is valid but lacks the required scopes. |
401 | The store that owns the token is suspended. |