ChannelEngine: order comments
About this article
This article describes how order comments work on ChannelEngine.
Table of contents
Order comments via ChannelEngine
Order comments
Order data fetched by ChannelEngine is determined by the specific marketplace, except in case of test orders. This data typically includes buyer and payment information, the ordered product(s) and their quantities, pricing, etc.
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 its status on ChannelEngine, and check if the order must be removed from the picking line to make a correction or if the address data is incomplete.
Order comments on ChannelEngine
You can create, edit, and remove order comments via the ChannelEngine web interface or via the Merchant 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 (🗨), it indicates that a comment is applied to the order. If the icon is empty (💬), then no comment has been made.
- Go to the order overview.
- Click the 🗨 icon to open the pop-up window where you can enter, edit, or remove a comment.
- Order comments appear in the Order details.
- Click the pencil icon next to the order comment in the order details view to add and modify comments. Click Update to save your changes.
- To remove an existing comment, empty the comment field and click Save.
Order comments in the Merchant API
The field MerchantComment is included in the response of any GET /v2/orders call you make using ChannelEngine's Merchant API.
To create, update, or remove an order comment, make a PUT call to the endpoint /v2/orders/comment and pass the arguments listed below:
| Key | Type | Required | Description |
MerchantOrderNo |
string
|
yes* | Your own order reference for the order you would like to update the comment for. (Maximum character length: 50). * Either this field or the OrderId is required. |
OrderId |
integer ($int32) |
yes* | The ChannelEngine order ID of the order you want to update the comment for. * Either this field or MerchantOrderNo is required |
MerchantComment |
string
|
no | The merchant comment you want to add/update. The minimum character length is 1. |
Comments
0 comments
Article is closed for comments.