Create Seller

POST

vendor

sellers

curl -X POST 'http://localhost:9000/vendor/sellers' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Store",
    "email": "store@acme.com",
    "currency_code": "usd",
    "member_email": "owner@acme.com",
    "first_name": "Jane",
    "last_name": "Doe"
  }'

const { seller } = await client.vendor.sellers.mutate({
  name: "Acme Store",
  email: "store@acme.com",
  currency_code: "usd",
  member_email: "owner@acme.com",
  first_name: "Jane",
  last_name: "Doe",
})

{
  "seller": {
    "id": "sel_01HXYZ",
    "name": "Acme Store",
    "handle": "acme-store",
    "email": "store@acme.com",
    "status": "pending_approval",
    "currency_code": "usd"
  }
}

Creates a seller account, optionally with an initial address, professional details, and payment details.

This is a public route: no Authorization or x-seller-id header is required. When called without an authenticated member, member_email is required so the owner member can be created.

Body parameters

string

required

The seller’s display name.

string

required

The seller’s contact email.

string

required

The seller’s default currency code (e.g. usd).

string

Unique handle for the seller’s storefront URL.

string

The seller’s contact phone number.

string

Email for the owner member, required when there is no authenticated member.

string

First name of the owner member.

string

Last name of the owner member.

string

Description of the seller’s store.

object

The seller’s address.

Show properties

string

Address label.

string

Company name.

string

Contact first name.

string

Contact last name.

string

Street address.

string

Apartment, suite, etc.

string

City.

string

Two-letter country code.

string

Province or state.

string

Postal code.

string

Phone number.

object

The seller’s business registration details.

Show properties

string

Registered corporate name.

string

Business registration number.

string

Tax identification number.

object

The seller’s bank account details.

Show properties

string

Bank country code.

string

Account holder name.

string

Bank name.

string

IBAN.

string

BIC / SWIFT code.

string

Routing number.

string

Account number.

object

Custom key-value pairs.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The seller’s ID.

string

The seller’s name.

string

The seller’s handle.

string

The seller’s email.

enum

One of open, pending_approval, suspended, terminated.

string

The seller’s default currency.

curl -X POST 'http://localhost:9000/vendor/sellers' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Store",
    "email": "store@acme.com",
    "currency_code": "usd",
    "member_email": "owner@acme.com",
    "first_name": "Jane",
    "last_name": "Doe"
  }'

const { seller } = await client.vendor.sellers.mutate({
  name: "Acme Store",
  email: "store@acme.com",
  currency_code: "usd",
  member_email: "owner@acme.com",
  first_name: "Jane",
  last_name: "Doe",
})

{
  "seller": {
    "id": "sel_01HXYZ",
    "name": "Acme Store",
    "handle": "acme-store",
    "email": "store@acme.com",
    "status": "pending_approval",
    "currency_code": "usd"
  }
}

curl -X POST 'http://localhost:9000/vendor/sellers' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Store",
    "email": "store@acme.com",
    "currency_code": "usd",
    "member_email": "owner@acme.com",
    "first_name": "Jane",
    "last_name": "Doe"
  }'

const { seller } = await client.vendor.sellers.mutate({
  name: "Acme Store",
  email: "store@acme.com",
  currency_code: "usd",
  member_email: "owner@acme.com",
  first_name: "Jane",
  last_name: "Doe",
})

{
  "seller": {
    "id": "sel_01HXYZ",
    "name": "Acme Store",
    "handle": "acme-store",
    "email": "store@acme.com",
    "status": "pending_approval",
    "currency_code": "usd"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Body parameters

Response

​Body parameters

​Response

Body parameters

Response