Errors

Evy uses conventional HTTP response codes to indicate the success or failure of an API request.

In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, product creation failed etc.). Codes in the 5xx range indicate an error with Evy's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., resource already exists) include an error code that briefly explains the error reported.

Attributes

codestringFor some errors that could be handled programmatically, a short string indicating the error code reported.
messagestringA human-readable message providing more details about the error.

HTTP Status Code Summary

200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
409 - ConflictThe request conflicts with the current state of the target resource.
422 - Unprocessable EntityThe server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.