Retrieves a list of up to 100 products, given the provided filtering, search expression, sorting, and cursor paging.
Pass supported values to the fields array in the request to include those fields in the response.
To learn about working with Search endpoints, see API Query Language, and Sorting and Paging.
Notes:
variantsInfo. To retrieve product variants, use the Get Product method.visible: false), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.| Property | Capabilities | Filters |
|---|---|---|
allCategoriesInfo.categories | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
directCategoriesInfo.categories | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
variantsInfo.variants | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
infoSections.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
infoSections.uniqueName | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
modifiers.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
modifiers.choicesSettings.choices.choiceId | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
modifiers.choicesSettings.choices.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
modifiers.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
options.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
options.choicesSettings.choices.choiceId | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
options.choicesSettings.choices.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
options.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
brand.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
brand.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
handle | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
inventory.availabilityStatus | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
inventory.preorderAvailability | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
inventory.preorderStatus | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
physicalProperties.deliveryProfileId | Search: ✓ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
physicalProperties.fulfillerId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
productType | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
ribbon.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
ribbon.name | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
slug | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
subscriptionDetails.allowOneTimePurchases | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
taxGroupId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
visible | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
visibleInPos | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
actualPriceRange.maxValue.amount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
actualPriceRange.minValue.amount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
compareAtPriceRange.maxValue.amount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
compareAtPriceRange.minValue.amount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
minVariantPriceInfo.sku | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
physicalProperties.shippingWeightRange.maxValue | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
physicalProperties.shippingWeightRange.minValue | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
description | Search: ✓ Aggregate: ✗ Sort: ✗ | |
directCategoryIdsInfo.categoryIds | Search: ✓ Aggregate: ✗ Sort: ✗ | |
physicalProperties.shippingGroupId | Search: ✓ Aggregate: ✗ Sort: ✗ | |
variantsInfo.variants.sku | Search: ✓ Aggregate: ✗ Sort: ✗ |
There are 2 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.