Skip to main content

ErrorResponse

Detailed error information

codestring

Error code

Example: ERR_GENERAL_0004
messagestring

Human-readable error message

Example: The requested resource was not found
details object[]

List of error details

  • Array [
    • codestring

    Specific error code

    Example: ER4001
    messagestring

    What went wrong

    Example: Invalid input
    targetstring

    Field that caused the issue

    Example: productCode
  • ]
    • suggestionsstring[]

    Suggested actions to resolve the error

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Additional metadata about the error

    property name*string
    ErrorResponse
    {
      "code": "ERR_GENERAL_0004",
      "message": "The requested resource was not found",
      "details": [
        {
          "code": "ER4001",
          "message": "Invalid input",
          "target": "productCode"
        }
      ],
      "suggestions": [
        "Check the resource ID",
        "Ensure the resource exists"
      ],
      "metaData": {}
    }