Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be the users, not API's. Let's look at some status codes and error types you might encounter.

The user can tell their your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, the user can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging.

Before freaking out with an error, please be aware that 72% of all reported errors are, in fact, user errors. Therefore, please carefully check if everything is in order with the request.

Status codes

Here is a list of the different categories of status codes returned by the LetsGo API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a user problem.
Name
5xx
Description
A 5xx status code indicates a server error — the user won't be seeing these hopefully.

Error types

Whenever a request is unsuccessful, the LetsGo API will return an error response. The user can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the LetsGo API — use these to understand what the user has done wrong.

Name
401 Unathorized
Description
This means that the user cannot acces this information, for example: a user cannot acces admin actions.
Name
400 Bad Request
Description
This means that the user has made an error with the request, in this example, the admin did not provide an image for the request resulting in a Zod error.

401 Unathorized

{
  "error": "Access denied, no token given"
}

400 Bad Request

POST

/orders

{
  "name": "Bad request example",
  "price": 400,
  "description": "some description",
  "category": "Star Wars",
}