Products
Products management
1. Paginated products
Endpoint
GET /api/v1/shop/products?limit=3&offset=2
Request Headers
{
"X-API-Key": "your_tenant_api_key",
"Content-Type": "application/json"
}
Response Body (200)
{
"products": [
{
"id": 1,
"title": "Main product 1",
"description": "Main Product 1 Description",
"sku": "EH-1",
"price": "33.00",
"stock": 444,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 1,
"meta": [],
"variations": [
{
"id": 1,
"product_id": 1,
"title": "Main product variation 1",
"description": "Main product variation 1 description",
"sku": "EH-1-1",
"price": "67.00",
"stock": 7777,
"control_stock": true,
"published": true,
"position": 1,
"meta": [],
"created_at": "2025-03-27T18:26:18.000000Z",
"updated_at": "2025-03-31T01:30:01.000000Z",
"cover": null,
"gallery": []
},
{
"id": 2,
"product_id": 1,
"title": "Product 1 varation 2",
"description": "Main product variation 2 description",
"sku": "EH-1-2",
"price": "33.00",
"stock": 44,
"control_stock": false,
"published": false,
"position": 2,
"meta": [],
"created_at": "2025-03-31T00:19:06.000000Z",
"updated_at": "2025-03-31T08:27:32.000000Z",
"cover": null,
"gallery": []
}
],
"created_at": "2025-03-27T18:25:44.000000Z",
"updated_at": "2025-03-30T22:17:44.000000Z",
"cover": "https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"gallery": [
"https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"https://servicedog.biz/img/9a1a9304-556b-499d-ba59-9e50b92120a8/screenshot-20241216-122351.png?fm=jpg&q=80&fit=max&crop=1843%2C1038%2C65%2C0"
]
},
{
"id": 2,
"title": "Main product 2",
"description": "Main Product 2 Description",
"sku": "EH-2",
"price": "56.00",
"stock": 44,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 2,
"meta": [],
"variations": [],
"created_at": "2025-03-27T21:52:57.000000Z",
"updated_at": "2025-03-27T21:53:08.000000Z",
"cover": null,
"gallery": []
},
{
"id": 3,
"title": "Main product 3",
"description": "Main Product 3 Description",
"sku": "EH-3",
"price": "44.00",
"stock": 33,
"control_stock": false,
"published": true,
"is_active": 1,
"position": 3,
"meta": [],
"variations": [],
"created_at": "2025-03-27T21:53:32.000000Z",
"updated_at": "2025-03-27T22:12:02.000000Z",
"cover": null,
"gallery": []
}
],
"meta": {
"total": 3,
"limit": 12,
"offset": 0
}
}
2. Unpaginated products
Endpoint
GET /api/v1/shop/products/all
Request Headers
{
"X-API-Key": "your_tenant_api_key",
"Content-Type": "application/json"
}
Response Body (200)
{
"products": [
{
"id": 1,
"title": "Main product 1",
"description": "Main Product 1 Description",
"sku": "EH-1",
"price": "33.00",
"stock": 444,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 1,
"meta": [],
"variations": [
{
"id": 1,
"product_id": 1,
"title": "Main product variation 1",
"description": "Main product variation 1 description",
"sku": "EH-1-1",
"price": "67.00",
"stock": 7777,
"control_stock": true,
"published": true,
"position": 1,
"meta": [],
"created_at": "2025-03-27T18:26:18.000000Z",
"updated_at": "2025-03-31T01:30:01.000000Z",
"cover": null,
"gallery": []
}
],
"created_at": "2025-03-27T18:25:44.000000Z",
"updated_at": "2025-03-30T22:17:44.000000Z",
"cover": "https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"gallery": [
"https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"https://servicedog.biz/img/9a1a9304-556b-499d-ba59-9e50b92120a8/screenshot-20241216-122351.png?fm=jpg&q=80&fit=max&crop=1843%2C1038%2C65%2C0"
]
},
{
"id": 2,
"title": "Main product 2",
"description": "Main Product 2 Description",
"sku": "EH-2",
"price": "56.00",
"stock": 44,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 2,
"meta": [],
"variations": [],
"created_at": "2025-03-27T21:52:57.000000Z",
"updated_at": "2025-03-27T21:53:08.000000Z",
"cover": null,
"gallery": []
},
{
"id": 3,
"title": "Main product 3",
"description": "Main Product 3 Description",
"sku": "EH-3",
"price": "44.00",
"stock": 33,
"control_stock": false,
"published": true,
"is_active": 1,
"position": 3,
"meta": [],
"variations": [],
"created_at": "2025-03-27T21:53:32.000000Z",
"updated_at": "2025-03-27T22:12:02.000000Z",
"cover": null,
"gallery": []
}
]
}
3. Get one product or variation by SKU
Endpoint
GET /api/v1/shop/products/{productSKU}
Request Headers
{
"X-API-Key": "your_tenant_api_key",
"Content-Type": "application/json"
}
Response Body (200)
{
"product": {
"id": 1,
"title": "Main product 1",
"description": "Main Product 1 Description",
"sku": "EH-1",
"price": "33.00",
"stock": 444,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 1,
"meta": [],
"variations": [
{
"id": 1,
"product_id": 1,
"title": "Main product variation 1",
"description": "Main product variation 1 description",
"sku": "EH-1-1",
"price": "67.00",
"stock": 7777,
"control_stock": true,
"published": true,
"position": 1,
"meta": [],
"created_at": "2025-03-27T18:26:18.000000Z",
"updated_at": "2025-03-31T01:30:01.000000Z",
"cover": null,
"gallery": []
},
{
"id": 2,
"product_id": 1,
"title": "Product 1 varation 2",
"description": "Main product variation 2 description",
"sku": "EH-1-2",
"price": "33.00",
"stock": 44,
"control_stock": false,
"published": false,
"position": 2,
"meta": [],
"created_at": "2025-03-31T00:19:06.000000Z",
"updated_at": "2025-03-31T08:27:32.000000Z",
"cover": null,
"gallery": []
}
],
"created_at": "2025-03-27T18:25:44.000000Z",
"updated_at": "2025-03-30T22:17:44.000000Z",
"cover": "https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"gallery": [
"https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"https://servicedog.biz/img/9a1a9304-556b-499d-ba59-9e50b92120a8/screenshot-20241216-122351.png?fm=jpg&q=80&fit=max&crop=1843%2C1038%2C65%2C0"
]
}
}
4. Products search
Endpoint
GET /api/v1/shop/products/search?q={searchPhrase}&limit=3&offset=2
Searches by product name or variation. If it finds a variation, the search will include a product with that variation.
Request Headers
{
"X-API-Key": "your_tenant_api_key",
"Content-Type": "application/json"
}
Response Body (200)
{
"products": [
{
"id": 1,
"title": "Main product 1",
"description": "Main Product 1 Description",
"sku": "EH-1",
"price": "33.00",
"stock": 445,
"control_stock": true,
"published": true,
"is_active": 1,
"position": 1,
"meta": [],
"variations": [
{
"id": 1,
"product_id": 1,
"title": "Main product variation 1",
"description": "Main product variation 1 description",
"sku": "EH-1-1",
"price": "67.00",
"stock": 7779,
"control_stock": true,
"published": true,
"position": 1,
"meta": [],
"created_at": "2025-03-27T18:26:18.000000Z",
"updated_at": "2025-03-31T09:38:50.000000Z",
"cover": null,
"gallery": []
}
],
"created_at": "2025-03-27T18:25:44.000000Z",
"updated_at": "2025-03-31T09:38:49.000000Z",
"cover": "https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"gallery": [
"https://servicedog.biz/img/d4abcf7e-1ca7-40e2-9e52-ad5445623141/photo-2024-12-03-10-54-37.jpg?fm=jpg&q=80&fit=max&crop=417%2C235%2C608%2C0",
"https://servicedog.biz/img/9a1a9304-556b-499d-ba59-9e50b92120a8/screenshot-20241216-122351.png?fm=jpg&q=80&fit=max&crop=1843%2C1038%2C65%2C0"
]
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0,
"query": "on 1"
}
}
06 September 2025