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/options	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. type => Invalid option type. product => The provided product with id (eg. 1010) does not belong to this shop. menu => At least one menu is required. => The menu with id (identifier) does not belong to this shop. 422 => Unprocessable entity
/api/v2/options/{id}	GET	401 => Resource not found 403 => Not allowed 404 => Option not found
/api/v2/options/{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. type => Invalid option type. product => The provided product with id (eg. 1010) does not belong to this shop. menu => At least one menu is required. => The menu with id (identifier) does not belong to this shop. 404 => Resource not found 422 => Unprocessable entity
/api/v2/options/{id}	DELETE	400 => Invalid User 400 => Invalid Shop 404 => Resource not found
/api/v2/options/{id}/attach-image	POST	401 => Access Denied 400 => Image file is required 400 => Invalid input 404 => Resource not found 422 => Unprocessable entity

Documentation

Carte en cours du clonage...

API ERRORS RESPONSES

API errors responses