Documentation

Carte en cours du clonage...

Merci d'attendre la fin du clonage avant de modifier quoi que ce soit.

API ERRORS RESPONSES

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.

Logo
Endpoint Method Error code => message
/api/v2/categories
POST
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 404
    => Menu not found
  • 400
    => Category's depth limit reached
  • 400
    => Parent category invalid
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
/api/v2/categories/{id}
GET
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 404
    => Category not found
/api/v2/categories/{id}
PUT
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 404
    => Menu not found
  • 400
    => Category's depth limit reached
  • 400
    => Parent category invalid
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/categories/{id}
DELETE
  • 400
    => Invalid User
  • 400
    => Invalid Shop
  • 404
    => Resource not found
/api/v2/categories/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/menus/{id}/categories
GET
  • 403
    => Not allowed
  • 404
    => Menu not found
Loading…
Loading the web debug toolbar…
Attempt #