ChannelEngine: order comments
About this guide
This is a guide on how order comments work in ChannelEngine.
Table of contents
Order comments via ChannelEngine
The order data which is fetched into ChannelEngine is determined by the specific channel (except in the case of test orders). The type of data that is typically fetched includes customer and payment information, the ordered product/s and in what quantities, and pricing.
In some cases, you may also want to fetch order comments which apply to a specific order. For example, if you need to do a manual check on an order, change the status in ChannelEngine, if it must be removed from the picking line in order to make a correction, or if address data is incomplete.
Create order comments via ChannelEngine
You can create, edit, and remove order comments via your ChannelEngine environment or with the API.
From the order overview, the comment option is visible in the Actions tab, marked by a speech bubble icon 🗨. If the icon is solid (🗨), this indicates that a comment is applied to the order. If the icon is empty (💬), then no comment has been left.
- Go to the order overview.
- Select the 🗨 icon to open the popup window where you can enter, edit, or remove a comment.
- Order comments will appear in the order details view.
- Clicking the stylus icon next to the order comment in the order details view also allows you to add and modify comments. Click + Update to save your changes.
- To remove an existing comment, empty the comment field and click Save.
Create order comments via the API
In any GET /v2/orders call, the field MerchantComment will be included in the response.
Creating, updating, and removing comments
To create, update, or remove an order comment, create a PUT request to the endpoint /v2/orders/comment and pass the arguments listed below:
|Yes*||Your own order reference for the order you would like to update the comment for. (Maximum character length: 50). *Either this field or OrderId is required.|
|Yes*||The ChannelEngine order ID of the order you would like to update the comment for. *Either this field or MerchantOrderNo is required|
|No||Description: The merchant comment you would like to add/update for the order. (Minimum character length: 1).|
Article is closed for comments.