Getting Started
All API endpoints require authentication using an API key which can be readily obtained from your store dashboard.
Obtaining an API Key
Sign in
Log in to your account on our platform
Open API settings
Navigate to the API section in your account settings
Generate key
Create a new API key and copy it somewhere safe
Using Your API Key
Include your API key in the Authorization header of every request. The API uses standard HTTP methods: GET for reading, POST for creating, PATCH for updating, and DELETE for deleting resources.
Base URL
https://api.shoplink.gg/dev/v1curl "https://api.shoplink.gg/dev/v1/products/list?limit=5" \-H "Authorization: Bearer <token>"
Keep your keys secret
Each API key has full access to your store's data. Never expose them in client-side code, version control, or browser environments.
Error Responses
The API returns standard HTTP status codes. Error responses include a JSON body with an error field.
{"error": "Missing Authorization header. Expected: Authorization: Bearer <API_KEY>"}
Rate Limits
Each API key gets a set number of requests per minute, by the store's plan: 30 on Free, 120 on Starter and 250 on Pro. The minute starts with the key's first request. Every response includes rate-limit headers, and a request over the limit gets a 429.
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests allowed in the current window |
X-RateLimit-Remaining | Requests remaining before the limit is hit |
X-RateLimit-Reset | When the window resets, as a Unix timestamp in milliseconds |
Retry-After | Seconds to wait before retrying (only on 429) |
Built by Shoplink. API documentation.