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/devices
GET
  • 403
    => Access Denied
  • 400
    => Franchise's token or shop's token is required
  • 400
    => Invalid token
  • 400
    => Invalid device's token
  • 401
    => Unrecognized device
/api/v2/devices/pair
POST
  • 403
    => Access Denied
  • 400
    => Missing parameters
  • 400
    => Invalid PIN Code
  • 400
    => Already paired
  • 401
    => Paired with other device
/api/v2/devices/{id}/paired
GET
  • 403
    => Access Denied
/api/v2/devices/{id}
GET
  • 403
    => Access Denied
  • 404
    => Device not found
/api/v2/devices/{token}/enable
PATCH
  • 401
    => Access Denied
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
  • 406
    => Not Acceptable
  • 404
    => Device not found
/api/v2/devices/{token}/disable
PATCH
  • 401
    => Access Denied
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
  • 406
    => Not Acceptable
  • 404
    => Device not found
Loading…
Loading the web debug toolbar…
Attempt #