The Request Message object represents a message object in the scope of the request. It contains the following properties:
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:
audit
AuditObject
Audit object with entries, including Created and Updated.
Example:
{
"id": "MSG-1212-3434-5656-7878",
"type": "User",
"content": "would agree discount of 5%"
}{
"id": "MSG-1212-3434-5656-7878",
"type": "User",
"content": "would agree discount of 5%",
"request": {
"id": "REQ-1671-0642"
},
"audit": {
"created": {
"at": "2023-12-14T17:28:57.667Z",
"by": {
"id": "USR-1234-1234-1234",
"name": "John Smith"
},
"of": {
"id": "ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}{
"id": "E001234",
"message": "Agreement provisioning failed due to unavailability of the item"
}{
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}Get a single request message.