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/option_variants
POST
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
  • 422
    => Unprocessable entity
/api/v2/option_variants/{id}
GET
  • 404
    => Resource not found
/api/v2/option_variants/{id}
PUT
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/option_variants/{id}
DELETE
  • 403
    => Not allowed
  • 404
    => Resource not found
/api/v2/option_variants/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
Loading…
Loading the web debug toolbar…
Attempt #