Developers

API Reference

Access your data programmatically. Available on Growth and Pro plans.

Growth and Pro plans only. API access is not available on the Starter plan.Upgrade your plan to enable API access.

Getting an API key

Go to Settings → API Keys.
Click Generate new API key.
Give the key a descriptive name (e.g. ERP integration or Warehouse system).
Copy the key immediately — it will only be displayed once in full. Store it securely in your application's environment variables or secrets manager.

You can generate multiple API keys for different integrations. Each key can be revoked independently without affecting others. Revoked keys are permanently invalidated — generate a new key if you need to replace a revoked one.

Keep your API keys secret. API keys provide full read and write access to your workspace (equivalent to an Admin role). Never commit API keys to source control or expose them in client-side code.

Authentication

All API requests must include your API key in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_API_KEY

All requests must be made over HTTPS. Requests made over HTTP will be rejected.

Base URL

All API endpoints are relative to the base URL:

https://api.salync.com/v1

Rate limits

API rate limits apply per API key and reset every 24 hours at midnight UTC.

Plan	Requests per day	Burst limit
Growth	500	20 requests/minute
Pro	10,000	200 requests/minute

When you exceed the rate limit, the API returns a 429 Too Many Requests response. The response includes a Retry-After header with the number of seconds until your quota resets.

If your integration requires higher limits, contact support@salync.com to discuss a custom plan.

Response format

All responses are JSON. Successful responses return a 2xx status code. Error responses return a 4xx or 5xx status code along with a JSON body:

{

"error": "product_not_found",

"message": "No product found with SKU WIDGET-001"

}

Available resources

The Salync API provides endpoints for the following resources:

Products — list, retrieve, create, update, and archive products and variants.
Stock — retrieve current stock levels and create stock adjustments.
Suppliers — list and retrieve supplier records.
Purchase Orders — list, retrieve, and create purchase orders.
Channels — retrieve channel connection status and listing states.

Full API reference coming soon. We are working on a complete interactive API reference with request/response examples for every endpoint. In the meantime, if you need help integrating with the Salync API, email support@salync.com and we will assist you directly.

Webhooks

Webhooks are available on the Pro plan. You can configure webhooks to receive real-time notifications when events occur in your workspace — for example, when stock falls below a threshold, when a PO is received, or when a channel listing goes into error state.

Configure webhooks in Settings → Webhooks. Specify a destination URL and choose which event types to subscribe to. Salync will send a POST request with a JSON payload to your URL whenever a matching event occurs.

Billing & Plans →Team & Permissions →