v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBProducts
Get Products
get/Sites/{siteId}/Products
Path parameters
siteIdinteger required
The site identifier
Query parameters
availability'Undefined' | 'InStock' | 'OutOfStock' | 'Preorder'
The product availability
minPricenumber float
The minimum product price
maxPricenumber float
The maximum product price
addToScheduledOrderboolean
Products that can be added to scheduled orders
processScheduledOrderboolean
Products that can be processed within a scheduled order
searchstring
Search criteria
groupIdsinteger[]
Group identifiers that the product may belong to
productIdsstring[]
Only get products where the product identifier is contained on the specified product identifiers
metadataKeystring[]
A metadata keys array. See Querying by metadata
metadataValuestring[]
A metadata values array. See Querying by metadata
activeboolean
Product is active
validboolean
Product is valid
pageinteger
The one-based page number
pageSizeinteger
The page size
orderBystring
Order by field
orderstring
Order asc or desc
Response
Success