Retrieve Seller

GET

store

sellers

{id}

curl 'http://localhost:9000/store/sellers/sel_01JB2K8A1B' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { seller } = await client.store.sellers.$id.query({ $id: "sel_01JB2K8A1B" })

{
  "seller": {
    "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
  }
}

Returns a single seller; sellers that are not open or are inside a scheduled closure window return a 404.

Path parameters

string

required

The seller’s ID.

Query parameters

string

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

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.

curl 'http://localhost:9000/store/sellers/sel_01JB2K8A1B' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { seller } = await client.store.sellers.$id.query({ $id: "sel_01JB2K8A1B" })

{
  "seller": {
    "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
  }
}

curl 'http://localhost:9000/store/sellers/sel_01JB2K8A1B' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { seller } = await client.store.sellers.$id.query({ $id: "sel_01JB2K8A1B" })

{
  "seller": {
    "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
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response