Query parameters

Most list and analytics endpoints share the same query parameter rules.

Pagination

Use limit and cursor on paginated endpoints.

limit=25
cursor=7c27f7e2-8d34-4d3b-87e9-70f2c1b0b6b0

Rules:

• Default limit is 25 for resource lists and 100 for product analytics.
• Maximum limit is 100.
• On resource lists, cursor must be the UUID returned as pagination.nextCursor.
• On /analytics/products, cursor is an opaque string. Send it back unchanged and keep the date, store, and groupBy filters the same.
• If pagination.nextCursor is absent, there is no next page.

Store filtering

Use storeIds to limit a request to one or more branches:

storeIds=store-uuid-1,store-uuid-2

Repeated params are also accepted:

storeIds=store-uuid-1&storeIds=store-uuid-2

If omitted, the request reads all branches in the key organization. If a requested store is outside the organization, the API returns 403.

Date ranges

Sales, promotions, inventory logs, and analytics endpoints accept ISO date strings:

from=2026-06-01T00:00:00.000Z
to=2026-06-24T23:59:59.999Z

For sales, inventory logs, and analytics, the API uses the last 30 days through the end of the current UTC day when the range is omitted. Promotion dates instead filter configured schedules by overlap and have no default range.

Sales, inventory-log, and analytics responses include their resolved range in meta.dateRange:

{
  "meta": {
    "dateRange": {
      "from": "2026-06-01T00:00:00.000Z",
      "to": "2026-06-24T23:59:59.999Z"
    }
  }
}

Search and filters

Supported filters depend on the endpoint:

• Products: storeIds, categoryIds, search
• Promotions: storeIds, categoryIds, productIds, active, triggers, from, to, search
• Inventory: storeIds, categoryIds, productIds, lowStock, search
• Inventory logs: storeIds, categoryIds, productIds, types, from, to, search
• Sales: storeIds, from, to, status, paymentMethods, search
• Analytics: storeIds, from, to
• Product analytics additionally accepts groupBy=product (default) or groupBy=store.

Array filters can be comma-separated or repeated.

Related

• Errors and limits
• Products
• Promotions
• Inventory logs
• Sales
• Revenue analytics