Skip to main content
POST
/
portal
/
auth
/
signup
Vendor Portal Signup
curl --request POST \
  --url https://staging-api.puppetvendors.com/portal/auth/signup \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "vendor": "<string>",
  "shopDomain": "<string>",
  "shopId": "<string>",
  "profile": {},
  "termsAccepted": true,
  "emailAddress": "<string>",
  "email_address": "<string>",
  "message": "<string>"
}
'
import requests

url = "https://staging-api.puppetvendors.com/portal/auth/signup"

payload = {
"email": "<string>",
"password": "<string>",
"vendor": "<string>",
"shopDomain": "<string>",
"shopId": "<string>",
"profile": {},
"termsAccepted": True,
"emailAddress": "<string>",
"email_address": "<string>",
"message": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
password: '<string>',
vendor: '<string>',
shopDomain: '<string>',
shopId: '<string>',
profile: {},
termsAccepted: true,
emailAddress: '<string>',
email_address: '<string>',
message: '<string>'
})
};

fetch('https://staging-api.puppetvendors.com/portal/auth/signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/portal/auth/signup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'password' => '<string>',
'vendor' => '<string>',
'shopDomain' => '<string>',
'shopId' => '<string>',
'profile' => [

],
'termsAccepted' => true,
'emailAddress' => '<string>',
'email_address' => '<string>',
'message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://staging-api.puppetvendors.com/portal/auth/signup"

payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"vendor\": \"<string>\",\n \"shopDomain\": \"<string>\",\n \"shopId\": \"<string>\",\n \"profile\": {},\n \"termsAccepted\": true,\n \"emailAddress\": \"<string>\",\n \"email_address\": \"<string>\",\n \"message\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://staging-api.puppetvendors.com/portal/auth/signup")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"vendor\": \"<string>\",\n \"shopDomain\": \"<string>\",\n \"shopId\": \"<string>\",\n \"profile\": {},\n \"termsAccepted\": true,\n \"emailAddress\": \"<string>\",\n \"email_address\": \"<string>\",\n \"message\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/portal/auth/signup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"vendor\": \"<string>\",\n \"shopDomain\": \"<string>\",\n \"shopId\": \"<string>\",\n \"profile\": {},\n \"termsAccepted\": true,\n \"emailAddress\": \"<string>\",\n \"email_address\": \"<string>\",\n \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
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

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

Response

200
{
  "success": true,
  "data": {
    "userId": "507f1f77bcf86cd799439011",
    "email": "vendor@example.com",
    "approved": false,
    "message": "Thank you for submitting your request. We will respond as soon as possible."
  }
}

Example

curl -X POST "https://staging-api.puppetvendors.com/portal/auth/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "vendor@example.com",
    "password": "secret123",
    "shopDomain": "my-store.myshopify.com",
    "vendor": "Acme Co",
    "termsAccepted": true,
    "email_address": ""
  }'

More Examples

Signup with full profile
curl -X POST "https://staging-api.puppetvendors.com/portal/auth/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newvendor@example.com",
    "password": "secure-pass-123",
    "shopDomain": "my-store.myshopify.com",
    "vendor": "Fresh Produce Co",
    "firstName": "Jane",
    "lastName": "Smith",
    "phone": "+1-555-0456",
    "message": "We sell organic farm produce and would love to join your marketplace.",
    "termsAccepted": true
  }'