Documentation

API Access per scope

Foxorder's API contains diffrents roles. Each endpoint is restricted for one or multiple roles depending on its need.

If you would like to test these endpoints in our Swagger UI docs, you need to retrieve a JWT token first.

Here are the roles available in our API:

SCOPE MANAGERThe manager of the franchise

SCOPE SHOP_OWNERThe manager of the shop

SCOPE FRONTFranchise's online shop

SCOPE CUSTOMERThe customer

Endpoint	Method	Description	FRONT	MANAGER	SHOP_OWNER	CUSTOMER
/api/v2/menus	GET	Retrieves the collection of Menu resources	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/menus	POST	Add a new menu	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/menus/create	POST	Create a menu	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}	GET	Return a menu	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}	PUT	Update a menu	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}	DELETE	Delete a menu	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}/categories	GET	Return the list of categories of a given menu	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}/cross-selling-products	GET	Get menu cross selling products	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}/enable	PATCH	Enable a given menu	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/menus/{id}/products	GET	Return the list of products of a given menu	Authorized	Authorized	Authorized	Unauthorised
/api/v2/menus/{id}/promotional-offers	GET	Get menu's promotional offers list	Authorized	Authorized	Authorized	Unauthorised
/api/v2/menus/{id}/update	POST	Update a menu	Unauthorised	Unauthorised	Authorized	Unauthorised