Orders | Others

Add a comment to an order, with the option to send SMS, email or both

Sample request for adding a public comment with email notification:

POST /api/Orders/AddComment
{
   "OrderId": "ORD-12345",
   "CommentType": "Public",
   "CommentText": "Hi! This is just a sample text.",
   "SendEmail": true,
   "EmailSubject": "Something order related",
   "EmailTo": "customer@example.com",
   "EmailFrom": "orders@yourcompany.com",
   "SenderName": "Order Team"
}

Sample request for adding a public comment with SMS notification:

POST /api/Orders/AddComment
{
   "OrderId": "ORD-12345",
   "CommentType": "Public",
   "CommentText": "Hi there! This is an SMS  message for you ❤️",
   "SendSms": true,
   "SmsPhoneNumber": "+4712345678"
}

Sample request for adding an internal comment (staff only):

POST /api/Orders/AddComment
{
   "OrderId": "ORD-12345",
   "CommentType": "Internal",
   "CommentText": "Customer called about delivery delay.",
   "CreatedBy": "Support Team"
}

Notes:

  • CommentType defaults to "Public" if not specified. CreatedBy defaults to the current API user's username if not specified.
  • EmailTo, EmailFrom, SenderName, and SmsPhoneNumber will fall back to the store's (or global) default settings in Omnium if not specified.
  • EmailTo falls back to the order's customer email. SmsPhoneNumber falls back to the order's customer phone.
post/api/Orders/AddComment

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Orders/AddComment
  • Auth: API key in header Authorization

Request body

orderIdstring nullable

Order ID

commentType'Public' | 'Internal'

Type of comment

commentTextstring nullable

The comment text/message content

createdBystring nullable

The sender/creator of the comment (e.g., external user, system or sales channel). Defaults to the current's API user's username

tagsstring[] nullable

Tags for categorizing/filtering comments

marketIdstring nullable

Market ID (optional, uses order's market if not specified)

sendEmailboolean

Send email notification to customer

emailSubjectstring nullable

Email subject line

emailTostring nullable

Email recipient address. Falls back to order's customer email if not specified.

emailCcstring nullable

Email CC recipients (semicolon separated)

emailBccstring nullable

Email BCC recipients (semicolon separated)

emailFromstring nullable

Email from address. Falls back to store's default email if not specified.

senderNamestring nullable

Sender display name for email and SMS notifications. Falls back to store's default sender name if not specified.

sendSmsboolean

Send SMS notification to customer

smsPhoneNumberstring nullable

Phone number for SMS. Falls back to order's customer phone if not specified.

Response

Comment added successfully

Changes

No recorded changes to this operation across all 1 revision of this API.