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/customers	POST	400 => Invalid input 422 => Unprocessable entity 400 => Invalid input phone => Invalid format. => already used => This value should not be blank. email => already used => Invalid format password => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters locale => The selected locale (eg. es_ES) is invalid. franchise => Unauthorized locale (eg. de_DE). proof_token => The value is not valid.
/api/v2/customers/authenticate/google	POST	400 => Google authentication Failed 400 => Invalid input apiCode => This field is required. redirectUri => This field is required. => The URL "{{ value }}" is not a valid URL qoodosSubscription => This value should be a boolean. qoodosEmailNotification => This value should be a boolean. qoodosPhoneNotification => This value should be a boolean.
/api/v2/customers/authenticate/apple	POST	400 => Apple authentication Failed 400 => Invalid input apiCode => This field is required. redirectUri => This field is required. => The URL "{{ value }}" is not a valid URL qoodosSubscription => This value should be a boolean. qoodosEmailNotification => This value should be a boolean. qoodosPhoneNotification => This value should be a boolean.
/api/v2/customers/password-reset	PATCH	400 => Bad Request 400 => Invalid input 404 => Not Found 422 => Unprocessable entity
/api/v2/customers/password-reset/check-token	GET	400 => Bad Request 404 => Not Found
/api/v2/customers/password-reset/request	POST	400 => Bad Request 400 => Missing parameters 400 => Invalid URL 400 => Email send failed 400 => Customer not found 422 => Unprocessable entity
/api/v2/customers/qoodos-subscription	POST	400 => Bad Request 422 => Unprocessable entity
/api/v2/customers/qoodos-unsubscription	DELETE	400 => Bad Request
/api/v2/customers/search	POST	400 => Invalid input email => This field is required. => Invalid format phone => Invalid format. franchise => This field is required. => The franchise ID is invalid.
/api/v2/customers/subscribe-existing	PATCH	400 => Bad Request 404 => Not Found 422 => Unprocessable entity
/api/v2/customers/{id}	GET	404 => Resource not found
/api/v2/customers/{id}	PUT	400 => Bad Request 404 => Resource not found 422 => Unprocessable entity 400 => Invalid input phone => Invalid format. => already used => This value should not be blank. email => already used => Invalid format password => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters locale => The selected locale (eg. es_ES) is invalid. franchise => Unauthorized locale (eg. de_DE). proof_token => The value is not valid.
/api/v2/customers/{id}/attach-image	POST	401 => Access Denied 400 => Image file is required 400 => Invalid input 404 => Resource not found 422 => Unprocessable entity
/api/v2/customers/{id}/set-default-language	PATCH	400 => Bad Request 404 => Not Found 422 => Unprocessable entity 422 => defaultLanguage: Invalid locale code
/api/v2/customers/{id}/update-password	PATCH	404 => Not Found 400 => Bad Request 400 => The given password is wrong 400 => Invalid input 404 => Resource not found 422 => Unprocessable entity 400 => Invalid input password => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters

Documentation

Carte en cours du clonage...

API ERRORS RESPONSES

API errors responses