SoraiDocs
GuidesAPI reference

sorai orders list

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

Every filter is optional.

sorai orders list [flags]

Flags

  • --store <id|slug>: A store id or slug. Defaults to SORAI_STORE, the saved login's store, or the only store.
  • --status <pending|awaiting_payment|paid|fulfilled|expired|cancelled|refunded>
  • --currency <string>: An ISO 4217 code, such as USD or IDR.
  • --from <string>: Orders created at or after this time. An RFC 3339 date-time (2026-08-29T00:00:00Z), a bare YYYY-MM-DD date, or a date-time with no seconds.
  • --until <string>: Orders created before this time. An RFC 3339 date-time (2026-08-29T00:00:00Z), a bare YYYY-MM-DD date, or a date-time with no seconds.
  • --q <string>: Matches part of an order number or buyer email.
  • --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 orders:read permission.

On this page