Skip to main content
All user profile endpoints require authentication with auth:sanctum.

Get Profile Counters

Response

{
  "cart_item_count": 3,
  "wishlist_item_count": 5,
  "order_count": 12
}

Example

curl -X GET https://your-domain.com/api/v2/profile/counters \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Update Profile

Request

name
string
User’s full name
phone
string
Phone number
password
string
New password (if changing password)

Response

{
  "result": true,
  "message": "Profile information updated"
}

Example

curl -X POST https://your-domain.com/api/v2/profile/update \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "phone": "+1234567890"
  }'

Update Device Token

Request

device_token
string
required
FCM device token

Response

{
  "result": true,
  "message": "device token updated"
}

Update Profile Image

Request

image
string
required
Base64 encoded image
filename
string
required
Image filename with extension

Response

result
boolean
Success status
message
string
Success or error message
path
string
URL to uploaded image

Example

curl -X POST https://your-domain.com/api/v2/profile/update-image \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "base64_encoded_image_data",
    "filename": "profile.jpg"
  }'
Supported image formats: jpg, jpeg, png, svg, webp, gif

Upload Generic Image

Request

image
string
required
Base64 encoded image
filename
string
required
Image filename with extension

Response

result
boolean
Success status
message
string
Success or error message
path
string
URL to uploaded image
upload_id
integer
Upload ID for reference

Check Phone and Email Availability

Response

{
  "phone_available": true,
  "email_available": true,
  "phone_available_message": "User phone number found",
  "email_available_message": "User email found"
}

Get Customer Info

Shipping Addresses

Get All Addresses

Create Address

address
string
required
Street address
country_id
integer
required
Country ID
state_id
integer
required
State ID
city_id
integer
required
City ID
postal_code
string
required
Postal/ZIP code
phone
string
required
Contact phone number

Update Address

address_id
integer
required
Address ID to update
address
string
Street address
country_id
integer
Country ID
state_id
integer
State ID
city_id
integer
City ID
postal_code
string
Postal/ZIP code
phone
string
Contact phone number

Update Address Location

address_id
integer
required
Address ID
latitude
number
required
Latitude coordinate
longitude
number
required
Longitude coordinate

Make Default Address

address_id
integer
required
Address ID to make default

Delete Address

Path Parameters

address_id
integer
required
Address ID to delete

Location Data

Get Countries

Get States

Get Cities

Get States by Country

Get Cities by State

Wishlist

Get Wishlist

Check Product in Wishlist

product_id
integer
required
Product ID to check

Add to Wishlist

product_id
integer
required
Product ID to add

Remove from Wishlist

product_id
integer
required
Product ID to remove

Follow Sellers

Get Followed Sellers

Follow Seller

Unfollow Seller

Check Follow Status

Club Points

Get Club Points List

Convert Points to Wallet

points
integer
required
Number of points to convert

File Upload

Image Upload

General File Upload

Get All Files

Build docs developers (and LLMs) love