Requests Messages

Request Message object

The Request Message represents a message object in the scope of the request.

Field	Type	Description
id	string	Primary message identifier Example: "MSG-1212-3434-5656-7878"
href	string	Relative reference to object on API (always /v1/somewhere/items/{id}) Example: "/v1/commerce/requests/REQ-1671-0642/messages/MSG-1212-3434-5656-7878"
type	string	Type of message: User or System. Example: "User"
content	string	Message contents Example: "I would agree discount of 5%".
request	Request	Reference to request, never sent in context of the Request - i.e. not set on subcollection /commerce/request/{id}/messages, but will be sent whithout this context. Example: { "id": "E001234", "message": "Agreement provisioning failed due to unavailability of the item" }
audit	AuditObject	Audit object with possible entries: Created. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

SHORT FORM

{
  "id": "MSG-1212-3434-5656-7878",
  "href": "/v1/commerce/requests/REQ-1671-0642/messages/MSG-1212-3434-5656-7878",
  "type": "User",
  "content": "would agree discount of 5%"
}

FULL EXAMPLE

{
  "id": "MSG-1212-3434-5656-7878",
  "href": "/v1/commerce/requests/REQ-1671-0642/messages/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"
      }
    }
  }
}