ReDoc documentation

orders/{id}/comments

orders/{id}/comments

post/V1/orders/{id}/comments

Adds a comment to a specified order.

Request
path Parameters
id
required
integer

The order ID.

Request Body schema:
required
object (sales-data-order-status-history-interface)

Order status history interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "statusHistory": {
    }
}
Response samples
true

orders/{id}/comments

get/V1/orders/{id}/comments

Lists comments for a specified order.

Request
path Parameters
id
required
integer

The order ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}
➔ Next to orders/{id}/emails