Search / list products
GET
header
x-api-key<token>Organization-scoped API key with scope metadata.
query?stringcategoryId?stringsortField?stringsortDirection?stringValue in
"asc""desc"page?integerRange
0 < value <= 9007199254740991perPage?integerRange
0 < value <= 100Success
application/json- response
products*facets*array<>suggestions*array<string>|nullcurl -X GET 'https://api-prood.vercel.app/v1/products'Example Response
{ "products": { "items": [ { "id": "string", "sku": "string", "name": { "property1": "string", "property2": "string" }, "slug": "string", "description": { "property1": "string", "property2": "string" }, "shortDescription": { "property1": "string", "property2": "string" }, "price": { "amount": 0, "currency": "string", "formatted": "string", "originalAmount": 0, "discountPercent": 0 }, "primaryImage": { "url": "string", "alt": "string", "width": 0, "height": 0 }, "gallery": [ { "url": "string", "alt": "string", "width": 0, "height": 0 } ], "rating": { "average": 0, "count": 0 }, "variants": [ { "id": "string", "sku": "string", "name": { "property1": "string", "property2": "string" }, "price": { "amount": 0, "currency": "string", "formatted": "string", "originalAmount": 0, "discountPercent": 0 }, "inStock": true, "inventoryQuantity": 0 } ], "attributes": [ { "code": "string", "name": { "property1": "string", "property2": "string" }, "value": { "property1": "string", "property2": "string" } } ], "quantityLimit": 0, "categories": [ { "id": "string", "name": { "property1": "string", "property2": "string" }, "slug": "string", "description": { "property1": "string", "property2": "string" }, "image": { "url": "string", "alt": "string", "width": 0, "height": 0 }, "parentId": "string", "productCount": 0 } ], "inStock": true, "vatIncluded": true, "vatRate": 0, "tags": [ "string" ], "createdAt": "string", "updatedAt": "string", "productType": "physical", "requiresShipping": true, "isDropshipped": true, "status": "string" } ], "total": 0, "page": 0, "perPage": 0, "hasMore": true }, "facets": [ { "name": { "property1": "string", "property2": "string" }, "code": "string", "values": [ { "label": { "property1": "string", "property2": "string" }, "value": "string", "count": 0, "selected": true } ] } ], "suggestions": [ "string" ]}