Skip to main content
POST
Vendor Portal Login
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

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

Response

200

Error Responses

401
403
429

Example