Storeep API Documentation. Build on your store data.
Build integrations with the Storeep API to access your store's products and orders programmatically.
AuthenticationBearer tokens and how to create and manage them.ProductsProducts with media, variants, options and market prices.OrdersOrders with items, addresses and fulfillment status.WebhooksCreate and manage the webhooks of your store.Error HandlingStatus codes, error responses and how to handle them.Rate LimitsHow many requests you can send and what happens past the limit.
Quick Start
- Create an access token
Go to Settings → Access tokens in your Storeep dashboard and create a new token with the permissions you need.
- Make your first request
Use the token in the
Authorizationheader to authenticate API requests.
cURL
curl -X GET https://api.storeep.com/v1/products \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Base URL
All API requests are made to the following base URL:
https://api.storeep.com/v1Response Format
All responses are returned in JSON format. Successful responses include a data array and a meta object with pagination details.
JSON
{
"data": [...],
"meta": {
"pagination": {
"total": 150,
"count": 20,
"per_page": 20,
"current_page": 1,
"total_pages": 8,
"links": {
"next": "https://api.storeep.com/v1/products?page=2"
}
}
}
}Available Endpoints
| Method | Endpoint | Description | Permission |
|---|---|---|---|
| GET | /api/v1/products | List all products | products:read |
| GET | /api/v1/products/{id} | Get a single product | products:read |
| GET | /api/v1/orders | List all orders | orders:read |
| GET | /api/v1/orders/{id} | Get a single order | orders:read |
| GET | /api/v1/webhooks | List all webhooks | webhooks:read |
| POST | /api/v1/webhooks | Create a webhook | webhooks:write |
| PUT | /api/v1/webhooks?id= | Update a webhook | webhooks:write |
| DELETE | /api/v1/webhooks?id= | Delete a webhook | webhooks:write |