Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Store API
  3. Account Settings

Customer

PreviousAccount SettingsNextMy Order

Last updated 4 months ago

Logout from the system

post

Logs the user out of the system.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully logged out
500
Internal server error
post
POST /backend/api/customer/logout HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<message>Successfully Logout</message>
	<status>1</status>
</object>
  • POSTCustomer Login
  • GETRequest a password reset link
  • POSTSend OTP to the user's email
  • POSTLogout from the system
  • POSTRegister a new customer

Request a password reset link

get

Send a password reset link to the user's registered email address.

Query parameters
emailstringRequired

The email address of the user who needs to reset their password.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Password reset link sent successfully
400
Bad request, invalid email format
404
User not found with the provided email
500
Internal server error
get
GET /backend/api/customer/forgot-password-link HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Thank you! A link to reset your password will be sent to your registered email shortly</message>
</object>

Customer Login

post

This endpoint allows customers to log in using their email, password, and other login information.

Header parameters
keystringOptional

The unique key for the request.

Default: 8097571064818418
Body
emailIdstringOptional

The email address of the customer.

passwordstringOptional

The password associated with the customer's account.

typestringOptional

The type of login (e.g., 'normal', 'social').

tokenstringOptional

An optional token for additional authentication.

Responses
200
Successfully logged in.
400
Bad Request - Invalid input
401
Unauthorized - Invalid credentials
500
Internal Server Error
post
POST /backend/api/customer/login HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 65

"emailId='text'&password='text'&type='text'&token='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Logged in Successfully</message>
</object>

Send OTP to the user's email

post

Send a One-Time Password (OTP) to the provided email address for verification purposes.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Body
emailIdstringOptionalExample: test@gmail.com
Responses
200
OTP sent successfully
400
Bad request, invalid email format
404
User not found with the provided email
500
Internal server error
post
POST /backend/api/customer/send-otp HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 28

"emailId='test@gmail.com'"
<?xml version="1.0"?>
<object>
	<status>0</status>
	<message>OTP sent successfully to the provided email.</message>
</object>

Register a new customer

post

Registers a new customer by providing necessary details like name, email, password, etc.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Body
firstNamestring · max: 32Optional

Customer's first name

lastNamestring · max: 32Optional

Customer's last name

passwordstring · min: 8 · max: 128Optional

Password for the customer account

confirmPasswordstringOptional

Password confirmation

emailIdstring · max: 96Optional

Customer's email address

phoneNumberstring · max: 15Optional

Customer's phone number

Responses
200
Customer successfully registered
500
Internal server error
post
POST /backend/api/customer/register HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 154

"firstName='John'&lastName='Doe'&password='Password123'&confirmPassword='Password123'&emailId='john.doe@example.com'&phoneNumber='1234567890'"
<?xml version="1.0"?>
<object>
	<message>Thank you for registering with us and please check your email</message>
	<status>1</status>
</object>