Skip to main content
POST
Vendor Portal Signup
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Create a new vendor portal signup request. The account is created in a pending state (approved: false) and requires manual merchant approval before the vendor can log in. This endpoint is public (no authentication required) and accepts legacy compatibility aliases (shopId, email_address) for backwards compatibility with older clients.

Use Cases

  • Self-service onboarding — Vendors submit a signup request from the vendor portal landing page
  • Multi-shop installations — Vendors specify shopDomain to target a specific merchant
  • Honeypot protectionemailAddress / email_address fields trap automated bots

Request Body

string
required
Vendor’s email address.
string
required
Password, minimum 6 characters.
string
required
Vendor / business name.
string
Preferred shop identifier (e.g. my-store.myshopify.com).
string
Legacy compatibility shop identifier.
object
Optional profile metadata.
boolean
Must be true if terms acceptance is required by the shop.
string
Honeypot field — must be empty.
string
Legacy honeypot alias — must be empty.
string
Optional custom success message.

Response

200

Example

More Examples

Signup with full profile