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/{id}/products	GET	Return the list of products of a given menu	Authorized	Authorized	Authorized	Unauthorised
/api/v2/products/menu	POST	Create a new menu with steps	Unauthorised	Authorized	Authorized	Unauthorised
/api/v2/products/simple	POST	Create a new simple product	Unauthorised	Authorized	Authorized	Unauthorised
/api/v2/products/{id}	GET	Return a product	Authorized	Authorized	Authorized	Unauthorised
/api/v2/products/{id}	DELETE	Delete a product	Unauthorised	Authorized	Authorized	Unauthorised
/api/v2/products/{id}/attach-image	POST	Change image	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/products/{id}/simple	PUT	Update a simple product	Unauthorised	Authorized	Authorized	Unauthorised
/api/v2/products/{id}/options	GET	Return the list of options of a given product	Authorized	Authorized	Authorized	Unauthorised
/api/v2/products/{id}/menu	PUT	Update a Menu	Unauthorised	Authorized	Authorized	Unauthorised