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/loyalty/{id}/configuration	GET	Retrieves the Loyalty configuration for a shop.	Authorized	Unauthorised	Authorized	Unauthorised
/api/v2/loyalty/{customerId}/benefits	GET	List benefits for a customer.	Authorized	Unauthorised	Unauthorised	Authorized
/api/v2/loyalty/customers	POST	Create new loyalty customer.	Authorized	Unauthorised	Unauthorised	Authorized
/api/v2/loyalty/customers/search	POST	Search for a loyalty customer by phone or email.	Authorized	Unauthorised	Unauthorised	Authorized
/api/v2/loyalty/customers/{customerId}	PATCH	Updates the Optins of a loyalty customer	Authorized	Unauthorised	Unauthorised	Authorized