SoraiDocs
GuidesAPI reference

sorai products list

List a store's products, newest first, with the total for paging.

Pass q to find a product by part of its name or slug.

sorai products list [flags]

Flags

  • --store <id|slug>: A store id or slug. Defaults to SORAI_STORE, the saved login's store, or the only store.
  • --q <string>: Matches part of a product's name or slug, ignoring case.
  • --status <draft|active|archived>
  • --limit <int>: How many rows to return, up to 200.
  • --offset <int>: How many rows to skip, for the next page.

Permissions

Needs a key with the catalog:read permission.

On this page