ErrorMessage

An object that contains information about one or more errors that the Toast platform encountered when processing your API request. For more information, see API responses and errors in the Toast Developer Guide.

canRetry
boolean

Indicates whether you can retry the operation that caused the error.

code
integer <int32>

A numeric identifier for the error condition.

developerMessage
string

Additional detail about the error condition, if it is available.

errors
Array of objects (ErrorMessage)

A JSON array of ErrorMessage objects.

fieldName
string

Reserved for future use.

link
string

Reserved for future use.

message
string

A description of the error condition.

messageKey
string

Reserved for future use.

requestId
string

The unique identifier of the HTTP request that your client sent to the Toast API.

status
integer <int32>

The HTTP status code of the response.

{
  • "status": 0,
  • "code": 0,
  • "message": "string",
  • "messageKey": "string",
  • "fieldName": "string",
  • "link": "string",
  • "requestId": "string",
  • "developerMessage": "string",
  • "errors": [
    ],
  • "canRetry": true
}