RECIPE: Business Recipe – Query Products from a Wix Store

Download skill
Copy

Retrieve products from a Wix store using the Catalog V3 Query Products API.

Article: How to Query Products

STEP 1: Call Query Products endpoint

Use the POST Query Products endpoint to query products. The endpoint returns up to 100 products per request.

Endpoint: POST https://www.wixapis.com/stores/v3/products/query

Basic query (all products, default fields):

Copy

This returns all products with their default fields (id, name, slug, visible, productType, priceData, stock, media, etc.).

STEP 2: Understanding the fields parameter

The fields array requests additional fields beyond the defaults. It does NOT accept property names like "name" or "id".

⚠️ CRITICAL: Valid fields enum values:

Enum ValueDescription
URLProduct page URL
CURRENCYCurrency information
INFO_SECTIONInfo sections (rich content)
MERCHANT_DATAMerchant-specific data
PLAIN_DESCRIPTIONPlain text description
INFO_SECTION_PLAIN_DESCRIPTIONInfo section plain text
SUBSCRIPTION_PRICES_INFOSubscription pricing
BREADCRUMBS_INFOCategory breadcrumbs
WEIGHT_MEASUREMENT_UNIT_INFOWeight unit info
VARIANT_OPTION_CHOICE_NAMESVariant option choice names
MEDIA_ITEMS_INFOAdditional media items
DESCRIPTIONRich text description
DIRECT_CATEGORIES_INFODirect category info
ALL_CATEGORIES_INFOAll category info
MIN_VARIANT_PRICE_INFOMinimum variant price
INFO_SECTION_DESCRIPTIONInfo section rich content
THUMBNAILThumbnail image
DIRECT_CATEGORY_IDSDirect category IDs
PRODUCT_CHOICES_MEDIA_REFERENCESChoice-specific media

WRONG – these are NOT valid field values:

Copy

CORRECT – use enum constants or leave empty for defaults:

Copy

CORRECT – requesting additional fields:

Copy

STEP 3: Filtering and sorting

Query with filter and sort:

Copy

Filter by product IDs:

Copy

STEP 4: Handling pagination

When there are more products than the page limit, use cursor-based or offset-based paging:

Copy

Check the response pagingMetadata to determine if more pages exist.


Important Notes

  • Variant data is NOT returned by Query Products. To get variant details, use Get Product for individual products.
  • Non-visible products require the SCOPE.STORES.PRODUCT_READ_ADMIN permission.
  • Default fields include: id, name, slug, visible, productType, priceData, stock, media, createdDate, updatedDate.
  • The fields parameter adds fields on top of the defaults — you never need to request id or name explicitly.

Conclusion

To query products, use POST https://www.wixapis.com/stores/v3/products/query with an empty query object for all products. Use fields: [] for defaults, or pass valid enum values like DESCRIPTION, URL, ALL_CATEGORIES_INFO for additional data. Never pass property names as field values.

Did this help?