Skip to main content

Sign In

Authenticates an existing customer using username and password credentials.

HTTP Request

POST/api/shop/customers/auth/pwd/signin

Authorization

Authorization

  • Required: No
  • Permission: None (public access)
  • Authentication: None

Request Body

FieldTypeRequiredDescription
usernameStringYesUnique username for the customer (max 150 chars)
passwordStringYesCustomer's password (max 150 chars)

Example Requests

1import requests
2
3# Sign in customer
4response = requests.post('http://www.example.com/api/shop/customers/auth/pwd/signin', 
5  json={
6      'username': 'john_doe_customer',
7      'password': 'secure_password123'
8  }
9)
10print(response.json())

Status Codes

CodeDescription
200Customer authenticated successfully
400Bad request — validation errors
500Internal server error

Response Fields

FieldTypeDescription
tokenStringAuthentication token for API access

Example Respones

{
"token": "sometokenisreturnedhere"
}

Notes

    • Returns a unique authentication token upon successful login
    • Token can be used for subsequent authenticated API requests
    • If multiple sessions are disabled, existing tokens will be regenerated
    • Account must be active to authenticate successfully