REST API: Order Comments
URI: /orders/:orderid/comments
Allows you to retrieve information about comments of the required order.
URL Structure: http://magentohost/api/rest/orders/:orderid/comments
Version: 1
HTTP Method: GET
Description: Allows you to retrieve information about comments of the required order.
Authentication: Admin
Default Format: XML
Parameters:
No Parameters
Example:
| GET http://magentohost/api/rest/orders/33/comments |
Response Body:
<?xml version="1.0"?>
<magento_api>
<data_item>
<created_at>2012-03-09 11:20:49</created_at>
<comment></comment>
<is_customer_notified>1</is_customer_notified>
<is_visible_on_front>0</is_visible_on_front>
<status>pending</status>
</data_item>
<data_item>
<created_at>2012-03-09 11:21:32</created_at>
<comment>This is a new order for John Doe.</comment>
<is_customer_notified>1</is_customer_notified>
<is_visible_on_front>1</is_visible_on_front>
<status>pending</status>
</data_item>
</magento_api>
Authentication: Customer
Default Format: XML
Parameters:
No Parameters
Example:
| GET http://magentohost/api/rest/orders/33/comments |
Response Body:
<?xml version="1.0"?>
<magento_api>
<data_item>
<created_at>2012-03-09 11:21:32</created_at>
<comment>This is a new order for John Doe.</comment>
</data_item>
</magento_api>
HTTP Method: POST
Description: Not allowed.
HTTP Method: PUT
Description: Not allowed.
HTTP Method: DELETE
Description: Not allowed.
Order Comments Attributes
| Attribute Name | Attribute Description | Notes |
|---|---|---|
| Comment Date | Date when the comment was added | Admin and Customer |
| Comment Text | Comment text | Admin and Customer |
| Is Customer Notified | Defines whether the customer is notified about the comment. Can have the following values: 0 - Customer is not notified, 1 - Customer is notified. | Admin only |
| Is Comment Visible on Frontend | Defines whether the comment is visible on the frontend. Can have the following values: 0 - Comment is not visible, 1 - Comment is visible. | Admin only |
| Comment Status | Comment status. | Admin only |