List store products

Returns a paginated list of active store products for the API-key's community, with optional sorting, field projection, search, filtering, translation language, and user visibility filtering.

Use this when a partner integration needs to render a storefront product grid, rewards catalog, or inventory list for the authenticated community.

Authentication:

Bearer API key in Authorization header

API key must have the store permission

Community is resolved from the API key token — do not pass communityID

Returns 401 if the key is missing, invalid, or expired

Returns 403 if the key does not include the store permission

Rate limits:

Standard API rate limits apply

Constraints:

skip defaults to 0 and must be at least 0

limit defaults to 20 and is capped at 100

Lists return active products; archived-product listing is not exposed through this partner endpoint

sort accepts field:asc or field:desc using sortable product fields such as displayOrder

fields is a comma-separated projection using partner-safe selectable product fields; productPermission and __v are not public fields

search accepts keyword:<value> or an allowed searchable field

filter accepts field:value; partner filters are limited to categoryID and type

lang selects translated product fields when localized content is configured

userID is only forwarded to the source service as a visibility filter; it does not affect partner authorization

Invalid query syntax or unsupported fields return 400

Upstream store-service failures return 502

Example — list:

{ "query": "?skip=0&limit=20&sort=displayOrder:asc&fields=name,price,type&search=keyword:premium&filter=type:voucher&lang=th" }

Related endpoints:

GET /stores — read store configuration

GET /categories — list store categories

GET /categories/{categoryID} — read a single store category

GET /products/{productID} — read a single store product

curl --location --request GET 'https://api.returning.ai/v1/products?skip&limit=20&sort=displayOrder:asc&fields=name,price,type,categoryID&search=keyword:premium&filter=type:voucher&lang=th&userID=507f1f77bcf86cd799439011' \ --header 'Authorization: Bearer XXXXXX'

{ "meta": { "status": "success", "statusCode": 200, "skip": 0, "limit": 20, "total": 12 }, "message": "Read products success.", "data": [ { "_id": "507f1f77bcf86cd799439031", "communityID": "6502c9e514a3e564c5c09c0a", "name": "Premium Voucher", "description": "<p>Redeem for premium access.</p>", "image": "https://example.com/product.png", "price": 100, "type": "voucher", "categoryID": "650906d314a3e564c56f3450", "stocks": 45, "discountPrice": 90, "isDiscountEnabled": false, "discountStartDate": "2026-04-28T00:00:00.000Z", "discountEndDate": "2026-05-28T00:00:00.000Z", "userInformation": { "isEnabled": false }, "shouldPrioritiesExpiringVouchers": false, "shouldDisplayRemainingQuantity": true, "expiringVoucherHighlight": { "isEnabled": false }, "isArchived": false, "totalOrders": 12, "displayOrder": 0, "redemptionInstructions": "<p>Show this voucher at checkout.</p>", "i18n": { "nameTranslations": [] }, "customOptions": { "isEnabled": false }, "isProductAccessEnabled": false, "purchaseStatusOverride": { "isEnabled": false, "statusID": null }, "createdAt": "2026-04-28T00:00:00.000Z", "updatedAt": "2026-04-28T00:00:00.000Z" } ] }

Request

Responses