Storefront API
Shopper accounts
Shoppers have an account per store. All login methods return the same thing — an accessToken and the user.
Login response
{
"accessToken": "eyJhbGciOi…",
"user": { "id": "…", "name": "Asha Rao", "email": "asha@example.com", "phone": null, "emailVerified": true }
}Sign up (verified email)
Request a code
POST/storefront/{storeSlug}/auth/signup/request-codePublicBody:name,email,password, optionalphone. Emails a 6-digit code.Verify and create the account
POST/storefront/{storeSlug}/auth/signup/verifyPublicBody: the samename,email,passwordpluscode. Returns the login response.
Log in with a password
POST
/storefront/{storeSlug}/auth/loginPublicBody:
email, password.Log in with an email code
Passwordless — also creates the account on first use.
POST
/storefront/{storeSlug}/auth/otp/requestPublicBody:
email. The response is the same whether or not the email has an account.POST
/storefront/{storeSlug}/auth/otp/verifyPublicBody:
email, code, optional name for new shoppers.Profile
GET
/storefront/{storeSlug}/auth/meShopper tokenPATCH
/storefront/{storeSlug}/auth/profileShopper tokenPOST
/storefront/{storeSlug}/auth/change-passwordShopper tokenAccount area
| Endpoint | Returns |
|---|---|
GET /account/dashboard | Summary for the account home page. |
GET /account/orders | Order history; /account/orders/{orderId} for one order. |
GET /account/orders/{orderId}/invoice | The GST invoice PDF. |
GET · POST · PUT · DELETE /account/addresses | Address book. |
GET /wishlist, POST /wishlist/{productId} | Wishlist (POST toggles). |
GET /account/loyalty, /account/wallet | Points and wallet balance. |
GET /account/referral | The shopper’s referral code and rewards. |
GET · POST /account/subscriptions | Subscriptions, with /pause, /resume, /skip and /cancel actions. |
/account/recently-viewed, /account/compare | Recently viewed and compare lists. |
All are under /storefront/{storeSlug} and need the shopper token. Remember to merge the guest cart after login.
Something unclear or out of date? Tell us