List Sellers

GET

store

sellers

curl 'http://localhost:9000/store/sellers?limit=20' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { sellers, count } = await client.store.sellers.query({ limit: 20 })

{
  "sellers": [
    {
      "id": "sel_01JB2K8A1B",
      "name": "Nordic Textiles",
      "handle": "nordic-textiles",
      "description": "Scandinavian linen and wool.",
      "logo": "https://cdn.example.com/nordic-logo.png",
      "banner": null,
      "is_premium": false,
      "metadata": null
    }
  ],
  "count": 12,
  "offset": 0,
  "limit": 20
}

Returns a paginated list of sellers; only sellers with status open that are outside any scheduled closure window (closed_from / closed_to) are included.

Query parameters

number

default:"50"

Maximum number of sellers to return.

number

default:"0"

Number of sellers to skip before collecting results.

string

Field to sort by, prefixed with - for descending order.

string

Comma-separated fields and relations to include; prefix with +/- to add to or remove from the defaults.

string

Free-text search term applied to seller fields.

string | string[]

Filter by one or more seller IDs.

string | string[]

Filter by one or more seller names.

string

Filter by seller handle.

boolean

Filter premium sellers.

object

Filter by creation date using operators like $gt, $gte, $lt, $lte.

object

Filter by update date using operators like $gt, $gte, $lt, $lte.

Response

object[]

Show properties

string

The seller’s ID.

string

The seller’s display name.

string

URL-safe handle.

string | null

The seller’s storefront description.

string | null

Logo URL.

string | null

Banner image URL.

boolean

Whether the seller has premium status.

object | null

Custom key-value data.

number

Total number of matching sellers.

number

Number of skipped sellers.

number

Maximum number of returned sellers.

curl 'http://localhost:9000/store/sellers?limit=20' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { sellers, count } = await client.store.sellers.query({ limit: 20 })

{
  "sellers": [
    {
      "id": "sel_01JB2K8A1B",
      "name": "Nordic Textiles",
      "handle": "nordic-textiles",
      "description": "Scandinavian linen and wool.",
      "logo": "https://cdn.example.com/nordic-logo.png",
      "banner": null,
      "is_premium": false,
      "metadata": null
    }
  ],
  "count": 12,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/store/sellers?limit=20' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { sellers, count } = await client.store.sellers.query({ limit: 20 })

{
  "sellers": [
    {
      "id": "sel_01JB2K8A1B",
      "name": "Nordic Textiles",
      "handle": "nordic-textiles",
      "description": "Scandinavian linen and wool.",
      "logo": "https://cdn.example.com/nordic-logo.png",
      "banner": null,
      "is_premium": false,
      "metadata": null
    }
  ],
  "count": 12,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response