Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yorlet.com/llms.txt

Use this file to discover all available pages before exploring further.

{
  "error": {
    "message": "The supplied customer was not found.",
    "param": "customer",
    "type": "invalid_request"
  },
  "status": 404
}
Yorlet uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with Yorlet’s servers.

​
Attributes

  • errorobject
    The error object.
    error.messagestring
    A human-readable message providing more details about the error.
    error.paramstring
    If the error is parameter-specific, the parameter related to the error.
    error.typestring
    The type of error returned.
  • statusinteger
    The status code.
Error codeMeaning
400 Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 UnauthorizedNo valid API key was provided.
403 ForbiddenThe API key doesn’t have permissions to perform the request.
404 Not FoundThe requested resource doesn’t exist.
429 Too Many RequestsToo many requests hit the API too quickly.
5XX Server ErrorWe had a problem with our server. Try again later.