docs.modx.pro
  1. Extras
  2. MiniShop3
  3. Development
  4. Web API
  5. Customer

Customer ​

Customer account and profile. Auth flows: Authorization.

Session ​

MethodPathNotes
GET/customer/meauthenticated, customer, token meta
POST/customer/token/refreshRotation
POST/customer/logoutoptional token
POST/customer/loginno middleware
POST/customer/registerno middleware
POST/customer/forgot-password
POST/customer/reset-password

Profile ​

MethodPathNotes
PUT/customer/profile
POST/customer/addQuick single field
POST/customer/changeAddressAddress into order draft

Profile fields are trimmed by allowlist / validation on the server. Invalid or guest token without a customer → authorization error.

Addresses ​

MethodPath
GET/customer/addresses
GET/customer/addresses/{id}
POST/customer/addresses
PUT/customer/addresses/{id}
DELETE/customer/addresses/{id}
PUT/customer/addresses/{id}/set-default

Account orders ​

MethodPath
GET/customer/orders
GET/customer/orders/{id}
POST/customer/orders/{id}/cancel

Submitted customer orders, not the /order/get draft.

Email ​

MethodPathNotes
GET/customer/email/verifyPublic. Query token, html=1 for page
POST/customer/email/resend-verificationRequires authenticated token

Custom email URL: ms3_email_verification_url. Otherwise the link points to api.php?route=…/email/verify.