header

Magento 1.x Software Support Notice

For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

Order Comments

Edit this page on GitHub

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