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/loyalty/{id}/configuration	GET	400 => Loyalty API is not reachable 400 => Unexpected error occurred 404 => Resource not found 400 => Bad Request
/api/v2/loyalty/{customerId}/benefits	GET	400 => Loyalty API is not reachable 400 => Unexpected error occurred 404 => Resource not found
/api/v2/loyalty/customers	POST	400 => Unexpected error occurred 400 => Bad request 400 => Invalid input email => Invalid format phone => Invalid format. => The phone number must be a valid mobile number. optinSms => This value should be a boolean. optinEmail => This value should be a boolean. loyalty_customer => An email address or phone number is required.
/api/v2/loyalty/customers/search	POST	400 => Loyalty API is not reachable 400 => Unexpected error occurred 404 => Loyalty customer not found 400 => Bad request 400 => Invalid input email => Invalid format phone => Invalid format. => The phone number must be a valid mobile number. loyalty_customer => An email address or phone number is required.
/api/v2/loyalty/customers/{customerId}	PATCH	400 => Invalid input loyalty_customer => An optin sms or email is required.

Documentation

Carte en cours du clonage...

API ERRORS RESPONSES

API errors responses