Fault Document (Data API 17.4)

Document representing a fault message that is returned whenever the HTTP status code is greater than or equal to 400 (which indicates an error).

Property Type Constraints Description
arguments Map[String, Object]   A map that provides fault arguments. Data can be used to provide error messages on the client side.
display_message_pattern String   The localized display message pattern, if the request parameter display_locale was given
message String   The message text of the java exception.
type String   The name of the java exception.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.