Error

The Error object represents an error response returned by the Marketplace API when it encounters a non-2xx HTTP response code. This object includes the following fields:

Fields

Field	Type	Description
title	string	A short description of the problem.
type	string	A URI reference that identifies the error type (Problem Details / RFC 7807).
status	number	The HTTP status code returned by the server.
details	string	A detailed description of the error message.
traceId	string	Represents an identifier used to trace a request.
errors	object	A detailed list of errors that can be connected to the request data.

Examples

ERROR OBJECT (WITHOUT PARAMETERS)

{
  "title": "Order update failed",
  "detail": "External ID is too long",
  "status": 400,
  "type": "https://docs.platform.softwareone.com/developer-resources/rest-api/errors/commerce#MPTCOM03-0078",
  "traceId": "00-00000000000000000000000000000000-000000000000000-00"
}

ERROR OBJECT (WITH PARAMETERS)

Detailed Errors

Parameter Errors Fields

Field	Type	Description
message	string	The message text with markdown allowed.
properties	list<string>	List of object properties affected by the error.
id	string	Message identifier used for the localization process.
parameters	object	Parameters that can be used in a message with {{name}} a template.