Requests Messages

The Request Message object represents a message object in the scope of the request. It contains the following properties:

Field
Type
Description

id

string

Primary identifier for the message.

Example: MSG-1212-3434-5656-7878

href

string

Relative reference to the object in the API.

Example: /v1/commerce/requests/REQ-1671-0642/messages/MSG-1212-3434-5656-7878

type

string

Type of message, such as User or System.

Example: User

content

string

Content of the message.

Example: I would like a discount of 5%.

request

Reference to the Request object.

Example:

{
     "id": "E001234",
     "message": "Agreement provisioning failed due to unavailability of the item"
}

audit

AuditObject

Audit object with entries, including Created and Updated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

Example

{
  "id": "MSG-1212-3434-5656-7878",
  "type": "User",
  "content": "would agree discount of 5%"
}

Last updated

Was this helpful?