Documentation Powered by Redocly

Cashier Message API (1.0.1)

Download OpenAPI specification:Download

It is possible to send messages to the system users. The messages can be time constrained as the >>> information you wish to convey may only be relevant for a certain period of time.

Authentication

ocms

Machine authentication is supported with OCMS.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://auth.retailsvc.com/oauth2/token
Scopes:

    cashier-message

    Create message

    Create message

    Authorizations:
    ocms
      header Parameters
      Correlation-Id
      string [ 1 .. 256 ] characters

      An id used for tracing and verification

      Request Body schema: application/json
      businessUnitGroupId
      required
      string [ 1 .. 50 ] characters

      Identifier for the business unit group that this message applies to.

      deleted
      boolean

      Indicates if message is deleted

      effectiveDate
      string <date>

      The date when the message is valid and can be presented.

      expirationDate
      string <date>

      The date when the message expires and can no longer be presented.

      header
      required
      string [ 1 .. 40 ] characters

      The message header

      messageId
      required
      string [ 1 .. 20 ] characters

      The unique Id of the message

      printable
      boolean

      Indicates if message is printable

      text
      required
      string [ 1 .. 1024 ] characters

      The message body

      type
      required
      string
      Enum: "cashier" "broadcast"

      The message type. Broadcast - presented immediately. Cashier - presented as a 'new message' icon.

      Responses

      Request samples

      Content type
      application/json
      {
      • "messageId": "msg-1",
      • "businessUnitGroupId": "store-1",
      • "header": "Attention",
      • "text": "thieves spotted in the store",
      • "type": "cashier"
      }