API Overview

Authorization

All requests made to the Synkro API require a valid Synkro access token. Include your token as a X-Synkro-Access-Token header on all API queries.

Creating an API key

You can create and manage your own API keys directly within the Synkro app:

1. In the Synkro settings navigate to API access.
2. Optionally give the key a name to help you identify what it is used for, e.g. “Warehouse integration”.
3. Click Create API key.

Your new API key will appear in the list below, where you can reveal and copy its value. You can create multiple API keys — for example, one per integration. Deleting a key immediately revokes it, and any integrations using it will stop working.

API access requires a Synkro plan which includes the offline API feature. If your current plan does not include it, the API access settings page will present an upgrade option.

If you have any questions about the Synkro API, please contact our customer support team.

Endpoints and requests

All Synkro API requests are scoped to the store associated with the provided access token, with the route determining the specific query or action to be performed. API endpoints follow this pattern, where store_name refers to the store’s store_name.myshopify.com url:

https://api.synkro-app.com/api/stores/{store_name}/inventory/bulk_update

The store associated with the provided store_name can be any store which is connected to the same Synkro user account as the store associated with the provided API access token. Attempts to access a different store will result in an unauthorized API response.

Rate limits

The Synkro API supports a limit of 5 requests per second. Beyond this limit, the API will return a 429 Too Many Requests error. If you encounter such an error, sleep your application process for a second before resuming your requests.

Status and error codes

All Synkro API queries return HTTP status codes that can tell you more about the response.

401 Unauthorized

The provided API access token does not have permission to access the store associated with the request.

403 Forbidden

The server is refusing to respond. This is typically caused by an invalid or missing API access token.

404 Not Found

The requested resource was not found.

429 Too Many Requests

The API rate limit has been exceeded. See Rate limits.