Skip to main content
POST
/
portal
/
auth
/
login
Vendor Portal Login
curl --request POST \
  --url https://staging-api.puppetvendors.com/portal/auth/login \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "shopDomain": "<string>"
}
'
import requests

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

payload = {
"email": "<string>",
"password": "<string>",
"shopDomain": "<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>', shopDomain: '<string>'})
};

fetch('https://staging-api.puppetvendors.com/portal/auth/login', 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/login",
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>',
'shopDomain' => '<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/login"

payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"shopDomain\": \"<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/login")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"shopDomain\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"shopDomain\": \"<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

Authenticate a vendor user with email and password. Returns a JWT token that works with all protected V2 endpoints under the vendor scope. Rate limited to 5 requests per 15 minutes per IP.

Use Cases

  • Vendor portal login screen — Exchange credentials for a session token
  • Mobile vendor app — Bootstrap the app after vendor enters credentials

Request Body

email
string
required
Vendor’s email address.
password
string
required
Vendor’s password.
shopDomain
string
Target shop domain — required when a single email is registered across multiple shops.

Response

200
{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expiresIn": 86400,
    "scope": "vendor",
    "shopDomain": "my-store.myshopify.com",
    "user": {
      "id": "507f1f77bcf86cd799439011",
      "email": "vendor@example.com",
      "vendorId": "507f1f77bcf86cd799439012",
      "vendor": "Acme Co"
    }
  }
}

Error Responses

401
{ "success": false, "error": { "message": "Invalid credentials", "code": "INVALID_CREDENTIALS" } }
403
{ "success": false, "error": { "message": "Account not approved", "code": "NOT_APPROVED" } }
429
{ "success": false, "error": { "message": "Too many login attempts", "code": "RATE_LIMITED" } }

Example

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