Query Items

Retrieves a list of items given the provided paging, filtering, and sorting. Up to 500 items can be returned per request.

To learn how to query items, see API Query Language.

Property	Filters	Sort
id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
image.id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
businessLocationIds	$eq, $ne, $exists, $in, $hasSome, $hasAll	Sort: ASC, DESC
name	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
description	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
visible	$eq, $ne, $exists, $in, $hasSome	Sort: ASC, DESC
featured	$eq, $ne, $exists, $in, $hasSome	Sort: ASC, DESC
createdDate	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte	Sort: ASC, DESC
updatedDate	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte	Sort: ASC, DESC
priceVariants.variants.price	$in, $nin, $eq, $ne, $exists	Sort: ASC, DESC
orderSettings.inStock	$in, $nin, $eq, $ne, $exists	Sort: ASC, DESC
orderSettings.acceptSpecialRequests	$in, $nin, $eq, $ne, $exists	Sort: ASC, DESC
labels.id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	None
modifierGroups.id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	None
priceVariants.variants.variantId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	None
externalReferenceInfo.externalAppId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	None
externalReferenceInfo.externalEntityId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	None
externalReferenceInfo.connected	$eq, $ne, $exists, $in, $hasSome	None