Documentation

API errors responses

Foxorder's API includes an error management system, this system allows users to have assistance in case of error.

Depending on the type of errors, the error message is often explicit (typing, null, format, etc.) otherwise, it indicates the source of the error and possibly the solution.

Endpoint	Method	Error code => message
/api/v2/menus	GET	403 => Not allowed 400 => Shop id is missing 404 => Shop not found
/api/v2/menus	POST	403 => Not allowed 400 => Invalid input 400 => Invalid User 404 => Shop not found 422 => Unprocessable entity
/api/v2/menus/create	POST	403 => Not allowed 400 => Invalid json 400 => Invalid menu json 400 => Missing category fields 400 => Category fields are empty 400 => Category's image invalid 400 => Category already exist 400 => Products mismatch between menu and provided product list 400 => Categories mismatch between categories and provided categories inside products 400 => Missing product fields 400 => Product fields are empty 400 => Product's image invalid 400 => Product already exist 400 => Invalid product component 400 => Missing option fields 400 => Option fields are empty 400 => Invalid option type 400 => Option's image invalid 400 => Missing option variant fields 400 => Option variant fields are empty 400 => Option variant's image invalid 400 => Option already exist 400 => Invalid map products fields id 400 => Invalid map product field cross selling 400 => Invalid map product field up selling 400 => Missing categories in products
/api/v2/menus/{id}	GET	403 => Not allowed 404 => Menu not found 404 => Resource not found
/api/v2/menus/{id}	PUT	403 => Not allowed 400 => Invalid input 400 => Invalid User 404 => Shop not found 404 => Resource not found 422 => Unprocessable entity
/api/v2/menus/{id}	DELETE	403 => Not allowed 400 => Invalid input 400 => Invalid User 400 => Invalid Shop 404 => Resource not found
/api/v2/menus/{id}/categories	GET	403 => Not allowed 404 => Resource not found
/api/v2/menus/{id}/cross-selling-products	GET	403 => Not allowed 404 => Menu not found
/api/v2/menus/{id}/enable	PATCH	403 => Not allowed 404 => Menu not found
/api/v2/menus/{id}/products	GET	403 => Not allowed 404 => Resource not found
/api/v2/menus/{id}/promotional-offers	GET	400 => Only category or product should be given 404 => Menu not found 401 => Unauthorized 404 => Resource not found
/api/v2/menus/{id}/update	POST	403 => Not allowed 404 => Menu not found 400 => Invalid json 400 => Invalid menu json 400 => Missing category fields 400 => Category fields are empty 400 => Category already exist 400 => Products mismatch between menu and provided product list 400 => Categories mismatch between categories and provided categories inside products 400 => Missing product fields 400 => Product fields are empty 400 => Product already exist 400 => Invalid product component 400 => Missing option fields 400 => Option fields are empty 400 => Invalid option type 400 => Option's image invalid 400 => Option variant fields are empty 400 => Option already exist 400 => Invalid map products fields id 400 => Invalid map product field cross selling 400 => Invalid map product field up selling 400 => Missing categories in products

Documentation

Carte en cours du clonage...

API ERRORS RESPONSES

API errors responses