The Shopflow API.Built for Developers.
REST and GraphQL APIs with predictable resource-oriented URLs, JSON responses, and standard HTTP status codes.
api.shopflow.io/v2
Bearer Token (JWT)
1,000 req/min
URL-based /v2/
TLS 1.3 required
Two APIs. One Platform.
Use REST for simplicity. GraphQL for precision. Mix both freely.
REST API
Resource-oriented endpoints. Predictable. Easy to debug. Perfect for server integrations and mobile apps.
GraphQL API
Fetch exactly what you need. No over-fetching. Ideal for headless storefronts and complex queries.
First API Call in 3 Minutes
No account needed to explore. Use sk_test_ keys in sandbox.
Get Your API Key
# Dashboard → Settings → API KeysSHOPFLOW_SECRET=sk_test_...
sk_test_ = sandbox. sk_live_ = production.
Install SDK
npm install @shopflow/node
Also available: pip, composer, gem
Make Your First Call
import Shopflow from '@shopflow/node';const sf = new Shopflow({secretKey: process.env.SHOPFLOW_SECRET,});const products = await sf.products.list({const products = await sf.products.list({limit: 10,status: 'active',});console.log(products.data);
Get a list of your products in seconds.
Works in Every Stack
Official SDKs for Node, Python, PHP, Ruby. Raw REST and GraphQL for everything else.
import Shopflow from '@shopflow/node';
const sf = new Shopflow({
secretKey: process.env.SHOPFLOW_SECRET,
environment: 'production',
});
const order = await sf.orders.create({
customer: {
email: 'john@example.com',
firstName: 'John',
lastName: 'Doe',
},
lineItems: [
{
productId: 'prod_01HXYZ',
variantId: 'var_01HABC',
quantity: 2,
},
],
payment: {
method: 'net_30',
currency: 'CAD',
},
});
// → { id: 'ord_01HXYZ', status: 'confirmed', total: 'CA$52.35' }Response
{
"id": "ord_01HXYZ789",
"status": "confirmed",
"total": {
"amount": 5235,
"currency": "CAD",
"formatted": "CA$52.35"
}
}API Reference Overview
All endpoints. All methods. One platform.
| METHOD | ENDPOINT | DESCRIPTION | AUTH | RATE LIMIT |
|---|---|---|---|---|
| GET | /v2/products | List products | Required | 1000/min |
| GET | /v2/products/:id | Get product | Required | 1000/min |
| POST | /v2/orders | Create order | Required | 500/min |
| GET | /v2/orders/:id | Get order | Required | 1000/min |
| PATCH | /v2/orders/:id | Update order | Required | 500/min |
| POST | /v2/customers | Create customer | Required | 500/min |
| GET | /v2/inventory | Check stock | Required | 2000/min |
| POST | /v2/webhooks | Register webhook | Required | 100/min |
| DELETE | /v2/webhooks/:id | Remove webhook | Required | 100/min |
Start Building Today
Free sandbox. Full API access. No credit card required.