Carts | Other

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

Sample request for adding a public comment with email notification:

POST /api/Cart/AddComment
{
   "CartId": "CART-12345",
   "CommentType": "Public",
   "CommentText": "Hi! This is just a sample text. Fun fact: Bananas are technically berries, but strawberries are not.",
   "SendEmail": true,
   "EmailSubject": "Something cart related",
   "EmailTo": "customer@example.com",
   "EmailFrom": "carts@yourcompany.com",
   "SenderName": "Cartman"
}

Sample request for adding a public comment with SMS notification:

POST /api/Cart/AddComment
{
   "CartId": "CART-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/Cart/AddComment
{
   "CartId": "CART-12345",
   "CommentType": "Internal",
   "CommentText": "Customer called about cart contents.",
   "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 cart's customer email. SmsPhoneNumber falls back to the cart's customer phone.
post/api/Cart/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/Cart/AddComment
  • Auth: API key in header Authorization

Request body

cartIdstring nullable

Cart 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 cart's market if not specified)

sendEmailboolean

Send email notification to customer

emailSubjectstring nullable

Email subject line

emailTostring nullable

Email recipient address. Falls back to cart'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 cart's customer phone if not specified.

Response

Comment added successfully

Changes

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