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/options	POST	Add a new option	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/options/{id}	GET	Return an option	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/options/{id}	PUT	Update an option	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/options/{id}	DELETE	Delete an option	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/options/{id}/attach-image	POST	Change image	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/products/{id}/options	GET	Return the liste of options of a given product	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/options	GET	Return the liste of options of the connected shop owner's shop	Authorized	Unauthorised	Authorized	Unauthorised