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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

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"
  }'