Skip to content
Progare

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)

  1. Request a code

    POST/storefront/{storeSlug}/auth/signup/request-codePublic
    Body: name, email, password, optional phone. Emails a 6-digit code.
  2. Verify and create the account

    POST/storefront/{storeSlug}/auth/signup/verifyPublic
    Body: the same name, email, password plus code. Returns the login response.

Log in with a password

POST/storefront/{storeSlug}/auth/loginPublic
Body: email, password.

Log in with an email code

Passwordless — also creates the account on first use.

POST/storefront/{storeSlug}/auth/otp/requestPublic
Body: email. The response is the same whether or not the email has an account.
POST/storefront/{storeSlug}/auth/otp/verifyPublic
Body: email, code, optional name for new shoppers.

Profile

GET/storefront/{storeSlug}/auth/meShopper token
PATCH/storefront/{storeSlug}/auth/profileShopper token
POST/storefront/{storeSlug}/auth/change-passwordShopper token

Account area

EndpointReturns
GET /account/dashboardSummary for the account home page.
GET /account/ordersOrder history; /account/orders/{orderId} for one order.
GET /account/orders/{orderId}/invoiceThe GST invoice PDF.
GET · POST · PUT · DELETE /account/addressesAddress book.
GET /wishlist, POST /wishlist/{productId}Wishlist (POST toggles).
GET /account/loyalty, /account/walletPoints and wallet balance.
GET /account/referralThe shopper’s referral code and rewards.
GET · POST /account/subscriptionsSubscriptions, with /pause, /resume, /skip and /cancel actions.
/account/recently-viewed, /account/compareRecently 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