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/shops/sync	GET	Return the synchronized list of shops	Authorized	Unauthorised	Unauthorised	Unauthorised
/api/v2/shops/{id}	GET	Return a shop	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/close	PATCH	Close Shop	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/open	PATCH	Open Shop	Unauthorised	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/options	GET	Return the list of options of a shop	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/shop_modes	GET	Return the list of shop modes of a shop	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/shops/{id}/legal_terms	GET	Retrieve shop’s legal terms	Authorized	Unauthorised	Authorized	Unauthorised