Update Seller

POST

admin

sellers

{id}

curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"description": "Handmade goods.", "is_premium": true}'

const { seller } = await client.admin.sellers.$id.mutate({
  $id: "sel_01HXYZABCDEF",
  description: "Handmade goods.",
  is_premium: true,
})

{
  "seller": {
    "id": "sel_01HXYZABCDEF",
    "name": "Acme",
    "handle": "acme",
    "email": "hello@acme.co",
    "description": "Handmade goods.",
    "status": "open",
    "is_premium": true,
    "updated_at": "2026-06-03T14:20:00.000Z"
  }
}

Updates the seller and returns the updated record.

Path parameters

string

required

The seller’s ID.

Query parameters

string

Comma-separated list of fields to include, prefix with +/- to add or remove from defaults.

Body parameters

string

Display name of the seller.

string

Unique URL-safe handle.

string

Contact email of the seller.

string

Contact phone number.

string

Seller description.

string

URL of the seller’s logo.

string

URL of the seller’s banner image.

string

The seller’s website URL.

string

ID of the seller in an external system.

string

One of open, pending_approval, suspended, terminated.

string

Reason recorded with the status.

boolean

Whether the seller is marked as premium.

string

Start of a temporary store closure.

string

End of a temporary store closure.

string

Note shown while the store is closed.

object

Custom key-value data.

object

Extra data passed to workflow hooks.

Response

object

Show properties

string

The seller’s ID.

string

Display name of the seller.

string

Unique URL-safe handle.

string

Contact email of the seller.

string

One of open, pending_approval, suspended, terminated.

boolean

Whether the seller is marked as premium.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"description": "Handmade goods.", "is_premium": true}'

const { seller } = await client.admin.sellers.$id.mutate({
  $id: "sel_01HXYZABCDEF",
  description: "Handmade goods.",
  is_premium: true,
})

{
  "seller": {
    "id": "sel_01HXYZABCDEF",
    "name": "Acme",
    "handle": "acme",
    "email": "hello@acme.co",
    "description": "Handmade goods.",
    "status": "open",
    "is_premium": true,
    "updated_at": "2026-06-03T14:20:00.000Z"
  }
}

curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"description": "Handmade goods.", "is_premium": true}'

const { seller } = await client.admin.sellers.$id.mutate({
  $id: "sel_01HXYZABCDEF",
  description: "Handmade goods.",
  is_premium: true,
})

{
  "seller": {
    "id": "sel_01HXYZABCDEF",
    "name": "Acme",
    "handle": "acme",
    "email": "hello@acme.co",
    "description": "Handmade goods.",
    "status": "open",
    "is_premium": true,
    "updated_at": "2026-06-03T14:20:00.000Z"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Body parameters

Response

​Path parameters

​Query parameters

​Body parameters

​Response

Path parameters

Query parameters

Body parameters

Response