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/customers |
GET
|
Return the list of customers of the connected show owner's shop |
Unauthorised
|
Authorized
|
Authorized
|
Unauthorised
|
| /api/v2/customers |
POST
|
Add a new customer |
Authorized
|
Unauthorised
|
Authorized
|
Authorized
|
| /api/v2/customers/authenticate/google |
POST
|
Authenticate a customer using Google Service |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/authenticate/apple |
POST
|
Authenticate a customer using Apple Service |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/password-reset |
PATCH
|
Update a password |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/password-reset/check-token |
GET
|
Check the validity of the requested password token |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/password-reset/request |
POST
|
Send and email with a reset password link |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/qoodos-subscription |
POST
|
Subscribe to Qoodos Fid |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/qoodos-unsubscription |
DELETE
|
Unsubscribe from Qoodos Fid |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/search |
POST
|
Search for a user with his email and a franchise id |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/subscribe-existing |
PATCH
|
Add an existing customer to another franchise |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
| /api/v2/customers/{id} |
GET
|
Return the connected customer |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/{id} |
PUT
|
Update the connected customer |
Unauthorised
|
Unauthorised
|
Authorized
|
Authorized
|
| /api/v2/customers/{id}/attach-image |
POST
|
Change image |
Authorized
|
Unauthorised
|
Authorized
|
Authorized
|
| /api/v2/customers/{id}/delivery_addresses |
GET
|
Return the list of delivery addresses of the connected customer |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/{id}/orders |
GET
|
Return the list of orders of the connected customer |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/{id}/set-default-language |
PATCH
|
Set default language |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
| /api/v2/customers/{id}/update-password |
PATCH
|
Updated the connected customer's password |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|