Skip to content
  1. Extras
  2. MiniShop3
  3. Development
  4. Web API
  5. Endpoint map

Endpoint map

Full path table. Source: core/components/minishop3/config/routes/web.php. Path prefix: /api/v1. Call via api.php?route=/api/v1/....

Token column:

ValueMeaning
noneNo TokenMiddleware on the route
auto-mintMiddleware present: without a valid token the server creates a guest token
optionalMiddleware present, path in publicRoutes: no mint and no 401 without a token

Request and response bodies: auth, catalog, cart, checkout, customer.

Cart

MethodPathTokenPurpose
POST/cart/addauto-mintAdd product
POST/cart/removeauto-mintRemove line
POST/cart/changeauto-mintChange quantity
POST/cart/change-optionauto-mintChange line options
GET/cart/getauto-mintCart contents
POST/cart/cleanauto-mintClear

Order

MethodPathTokenPurpose
GET/order/getauto-mintOrder draft
POST/order/addauto-mintOne draft field
POST/order/setauto-mintMultiple fields
POST/order/removeauto-mintRemove field
POST/order/submitauto-mintSubmit
POST/order/cleanauto-mintClear draft
GET/order/costauto-mintFull cost
GET/order/cost/cartauto-mintCart cost
GET/order/cost/deliveryauto-mintDelivery cost
GET/order/cost/paymentauto-mintPayment fee
POST/order/address/setauto-mintAddress from saved
POST/order/address/cleanauto-mintClear draft address
GET/order/delivery/validation-rulesauto-mintDelivery field rules
GET/order/delivery/required-fieldsauto-mintRequired fields

Customer

MethodPathTokenPurpose
POST/customer/loginnoneLogin
POST/customer/registernoneRegister
GET/customer/meauto-mintSession / token profile
POST/customer/logoutoptionalLogout
POST/customer/forgot-passwordnoneRequest reset
POST/customer/reset-passwordnoneReset via email token
POST/customer/addauto-mintQuick profile field
GET/customer/token/getnoneGuest / current API token
POST/customer/token/refreshauto-mintToken rotation
GET/customer/addressesauto-mintAddress list
GET/customer/addresses/{id}auto-mintSingle address
POST/customer/addressesauto-mintCreate
PUT/customer/addresses/{id}auto-mintUpdate
DELETE/customer/addresses/{id}auto-mintDelete
PUT/customer/addresses/{id}/set-defaultauto-mintDefault address
PUT/customer/profileauto-mintProfile
POST/customer/changeAddressauto-mintAddress into order draft
POST/customer/email/resend-verificationauto-mintResend email
GET/customer/email/verifynoneEmail verification
GET/customer/ordersauto-mintAccount orders
GET/customer/orders/{id}auto-mintOrder detail
POST/customer/orders/{id}/cancelauto-mintCancel

Account endpoints with auto-mint need a customer on the token: otherwise the controller returns unauthorized / business error. See Customer.

Product (public)

MethodPathTokenPurpose
GET/product/getnoneResolve by alias / uri
GET/product/get/{id}noneProduct by ID
GET/product/listnoneList / PLP
GET/product/filtersnoneFacets
GET/product/{id}/imagesnoneGallery

Category (public)

MethodPathTokenPurpose
GET/category/getnoneResolve by alias / uri
GET/category/get/{id}noneCategory by ID
GET/category/listnoneList
GET/category/treenoneTree

Delivery / Payment (public)

MethodPathTokenPurpose
GET/delivery/get/{id}noneDelivery method
GET/delivery/listnoneActive deliveries
POST/delivery/webhook/{delivery_id}noneProvider webhook (signature, not customer token)
GET/payment/get/{id}nonePayment method
GET/payment/listnoneActive payments

Health

MethodPathTokenPurpose
GET/healthnoneAPI status

Programmatic order creation from PHP (cron/extra) is not Web HTTP: ProgrammaticOrderService.