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

Profile

PreviousMy WishlistNextSupport

Last updated 3 months ago

Get Customer Profile

get

This endpoint retrieves the customer's profile information.

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 retrieved customer profile
400
Bad Request
500
Internal Server Error
get
GET /backend/api/customer/get-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get the Profile.</message>
</object>

Get Account Profile Settings

post
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 got settings
400
Bad request
500
Internal server error
post
POST /backend/api/my-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Get Customer Address

get
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
Successful response
400
Bad request
500
Internal server error
get
GET /backend/api/customer-address HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get the customer Address</message>
</object>

Get Customer Address Detail

get
Path parameters
idintegerRequired
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 retrieved address detail
400
Invalid request
500
Server error
get
GET /backend/api/customer-address/{id} HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get the address detail.</message>
</object>
  • GETGet Customer Profile
  • POSTGet Account Profile Settings
  • GETGet Customer Address
  • POSTAdd New Customer Address
  • POSTEdit Customer Profile
  • PUTUpdate Default Customer Address
  • GETGet Customer Address Detail
  • PUTUpdate Customer Address
  • POSTChange Customer Password

Add New Customer Address

post
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
addressTypeintegerRequired
address1stringRequired
address2stringOptional
citystringRequired
landmarkstringOptional
phoneNumberstringRequired
postcodestringRequired
countryIdintegerRequired
zoneIdintegerRequired
isDefaultintegerOptional
firstNamestringRequired
lastNamestringRequired
Responses
200
Address added successfully
400
Invalid request data
500
Server error
post
POST /backend/api/customer-address HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 200

"addressType=1&address1='text'&address2='text'&city='text'&landmark='text'&phoneNumber='text'&postcode='text'&countryId=1&zoneId=1&isDefault=1&firstName='text'&lastName='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Address added</message>
</object>

Edit Customer Profile

post
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
firstNamestringRequired
lastNamestringRequired
emailIdstringRequired
phoneNumberstringRequired
addressstringRequired
address2stringOptional
landmarkstringOptional
citystringRequired
pincodestringRequired
stateIdintegerRequired
countryIdintegerRequired
Responses
200
Profile updated successfully
400
Bad request
500
Internal server error
post
POST /backend/api/customer/edit-profile HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 186

"firstName='text'&lastName='text'&emailId='text'&phoneNumber='text'&address='text'&address2='text'&landmark='text'&city='text'&pincode='text'&stateId=1&countryId=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>The Customer details have been updated successfully</message>
</object>

Update Default Customer Address

put
Path parameters
idintegerRequired
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
addressTypeintegerRequired
Responses
200
Default address updated successfully
400
Bad request
500
Internal server error
put
PUT /backend/api/customer-address/update-default/{id} HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 17

"addressType=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Default Address updated Successfully</message>
</object>

Update Customer Address

put
Path parameters
idintegerRequired
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
addressTypeintegerRequired
address1stringRequired
address2stringOptional
citystringRequired
landmarkstringOptional
phoneNumberstringRequired
postcodestringRequired
countryIdintegerRequired
zoneIdintegerRequired
statestringOptional
isDefaultintegerOptional
firstNamestringRequired
lastNamestringRequired
Responses
200
Customer address updated successfully
400
Invalid request data
500
Server error
put
PUT /backend/api/customer-address/{id} HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 215

"addressType=1&address1='text'&address2='text'&city='text'&landmark='text'&phoneNumber='text'&postcode='text'&countryId=1&zoneId=1&state='text'&isDefault=1&firstName='text'&lastName='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>The Customer Detail have been updated Successfully</message>
</object>

Change Customer Password

post
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
oldPasswordstringRequired
newPasswordstringRequired
Responses
200
Password changed successfully
400
Invalid password data
500
Server error
post
POST /backend/api/customer/change-password HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"oldPassword='text'&newPassword='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Your password has been change successfully</message>
</object>