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 | |
|---|---|---|---|---|---|---|---|
| ALIMENT | |||||||
| /api/v2/aliments |
GET
|
Return aliments list of all aliments |
Authorized
|
Authorized
|
Authorized
|
Unauthorised
|
|
| CATEGORY | |||||||
| /api/v2/categories |
POST
|
Add a new category |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/categories/{id} |
GET
|
Return a category |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/categories/{id} |
PUT
|
Update a category |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/categories/{id} |
DELETE
|
Delete a category |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/categories/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/categories |
GET
|
Return the list of categories of a given menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| CLOSING DAYS | |||||||
| /api/v2/closing_days/sync |
GET
|
Return the synchronized list of closing days of a given shop |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| CONTACT | |||||||
| /api/v2/contacts |
POST
|
Send a contact request to the shop email |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| 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
|
|
| DELIVERY ADDRESS | |||||||
| /api/v2/customers/{id}/delivery_addresses |
GET
|
Return the list of delivey addresses of the connected customer |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/delivery_addresses |
POST
|
Add a new delivery address |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/delivery_addresses/{id} |
GET
|
Return a delivery address |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/delivery_addresses/{id} |
PUT
|
Update a delivery update |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/delivery_addresses/{id} |
DELETE
|
Delete a delivery address |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/delivery_addresses/{id}/set-default |
PATCH
|
Set a delivery address as default |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| DEVICE | |||||||
| /api/v2/devices |
GET
|
Return devices list of current Manager/ShopManager or franchiseToken/shopToken or API role |
Authorized
|
Authorized
|
Authorized
|
Unauthorised
|
|
| /api/v2/devices/pair |
POST
|
Pairing a device |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/devices/{id}/paired |
GET
|
Check if device is paired |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/devices/{id} |
GET
|
Return a device |
Unauthorised
|
Authorized
|
Authorized
|
Unauthorised
|
|
| /api/v2/devices/{token}/enable |
PATCH
|
Enable device by token |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/devices/{token}/disable |
PATCH
|
Disable device by token |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| FRANCHISE | |||||||
| /api/v2/franchises/domain |
GET
|
Search for a franchise by a given domain |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| LOCALE | |||||||
| /api/v2/locales |
GET
|
Retrieves the collection of Locale resources. |
Authorized
|
Authorized
|
Authorized
|
Authorized
|
|
| LOYALTY | |||||||
| /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
|
|
| MENU | |||||||
| /api/v2/menus |
GET
|
Retrieves the collection of Menu resources |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus |
POST
|
Add a new menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/create |
POST
|
Create a menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id} |
GET
|
Return a menu |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id} |
PUT
|
Update a menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id} |
DELETE
|
Delete a menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/categories |
GET
|
Return the list of categories of a given menu |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/cross-selling-products |
GET
|
Get menu cross selling products |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/enable |
PATCH
|
Enable a given menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/products |
GET
|
Return the list of products of a given menu |
Authorized
|
Authorized
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/promotional-offers |
GET
|
Get menu's promotional offers list |
Authorized
|
Authorized
|
Authorized
|
Unauthorised
|
|
| /api/v2/menus/{id}/update |
POST
|
Update a menu |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| OPENING HOURS | |||||||
| /api/v2/opening_hours/sync |
GET
|
Return the synchronized list of opening hours of a given shop |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| OPTION | |||||||
| /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
|
|
| OPTION VARIANT | |||||||
| /api/v2/option_variants |
POST
|
Add a new option variant |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/option_variants/{id} |
GET
|
Return an option variant |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/option_variants/{id} |
PUT
|
Update an option variant |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/option_variants/{id} |
DELETE
|
Delete an option variant |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/option_variants/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| ORDER | |||||||
| /api/v2/customers/{id}/orders |
GET
|
Return the list of orders of the connected customer |
Unauthorised
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/orders |
GET
|
Return the list of orders of the connected customer |
Unauthorised
|
Unauthorised
|
Authorized
|
Authorized
|
|
| /api/v2/orders |
POST
|
Add a new order |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/orders/{id} |
GET
|
Return an order |
Authorized
|
Unauthorised
|
Authorized
|
Authorized
|
|
| /api/v2/orders/{id} |
PUT
|
Update an order |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/orders/{id}/accept |
PATCH
|
Set the status of a given order to "Accepted" |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/{id}/cancel |
PATCH
|
Cancel an order |
Unauthorised
|
Unauthorised
|
Authorized
|
Authorized
|
|
| /api/v2/orders/{id}/delay |
PATCH
|
Delay an order |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/{id}/deliver |
PATCH
|
Set the status of a given order to "Delivered" |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/{id}/pay |
PATCH
|
Set the status of a given order to "Paid" |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/{id}/ready |
PATCH
|
Set the status of a given order to "Ready" |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/{id}/reject |
PATCH
|
Set the status of a given order to "Rejected" |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/orders/cancel-payments |
POST
|
Cancel payments |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| ORDERING HOURS | |||||||
| /api/v2/ordering_hours/time_slots |
GET
|
Return an array of available slots of shop |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| PAYMENT | |||||||
| /api/v2/payments/create |
POST
|
Create a payment |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/payments/result |
POST
|
Handle payment result |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/payments/{external_id}/status |
GET
|
Get payment status by external id |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| /api/v2/payments/{id}/payplug-apple-pay/complete |
PATCH
|
Complete Apple Pay payment |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| PAYMENT METHOD | |||||||
| /api/v2/payment_methods |
GET
|
Return the list of all payment methods |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/payment_methods/{id} |
GET
|
Return a payment method |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/payment_methods/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| PRODUCT | |||||||
| /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
|
|
| PROMOTION | |||||||
| /api/v2/promotions/check |
POST
|
Check if promotion is valid |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/promotions/{id} |
GET
|
Return a promotion |
Authorized
|
Unauthorised
|
Unauthorised
|
Unauthorised
|
|
| /api/v2/promotions/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| PROMOTIONAL OFFER | |||||||
| /api/v2/promotional_offers/{id} |
GET
|
Return a promotional offer |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/promotional_offers/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| RESOURCES | |||||||
| /api/v2/* |
*
|
All access resources |
Authorized
|
Authorized
|
Authorized
|
Authorized
|
|
| SHOP | |||||||
| /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
|
|
| SHOP MANAGER | |||||||
| /api/v2/shop_managers |
GET
|
Retrieves the collection of ShopManager resources. |
Unauthorised
|
Authorized
|
Authorized
|
Unauthorised
|
|
| /api/v2/shop_managers/{id} |
GET
|
Retrieves a ShopManager resource. |
Unauthorised
|
Authorized
|
Authorized
|
Unauthorised
|
|
| SHOP MODE | |||||||
| /api/v2/shop_modes/{id} |
GET
|
Return a shop mode |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/shop_modes/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| /api/v2/shops/{id}/shop_modes |
GET
|
Return the list of shop modes of a given shop |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
|
| TAXE | |||||||
| /api/v2/taxes |
GET
|
Retreive the list of taxes |
Authorized
|
Authorized
|
Authorized
|
Authorized
|
|
| USER OAUTH | |||||||
| /api/v2/phone/send-verification-code |
POST
|
Send a verification code to a phone number. |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| /api/v2/phone/verify |
POST
|
Verify phone with code if correct. |
Authorized
|
Unauthorised
|
Unauthorised
|
Authorized
|
|
| WEBHOOK | |||||||
| /api/v2/webhooks/{id} |
PATCH
|
Update endpoint of webhook kezia only |
Unauthorised
|
Authorized
|
Authorized
|
Unauthorised
|
|