Inheritance diagram for OrderManagementInterface:
Public Member Functions | |
| cancel ($id) | |
| getCommentsList ($id) | |
| addComment ($id, \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory) | |
| notify ($id) | |
| getStatus ($id) | |
| hold ($id) | |
| unHold ($id) | |
| place (\Magento\Sales\Api\Data\OrderInterface $order) | |
Detailed Description
Order management 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. @api
- Since
- 100.0.2
Definition at line 18 of file OrderManagementInterface.php.
Member Function Documentation
◆ addComment()
| addComment | ( | $id, | |
| \Magento\Sales\Api\Data\OrderStatusHistoryInterface | $statusHistory | ||
| ) |
Adds a comment to a specified order.
- Parameters
-
int $id The order ID. \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory Status history comment.
- Returns
- bool
Implemented in OrderService.
◆ cancel()
| cancel | ( | $id | ) |
◆ getCommentsList()
| getCommentsList | ( | $id | ) |
Lists comments for a specified order.
- Parameters
-
int $id The order ID.
- Returns
- \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface Order status history search results interface.
Implemented in OrderService.
◆ getStatus()
| getStatus | ( | $id | ) |
Gets the status for a specified order.
- Parameters
-
int $id The order ID.
- Returns
- string Order status.
Implemented in OrderService.
◆ hold()
| hold | ( | $id | ) |
◆ notify()
| notify | ( | $id | ) |
Emails a user a specified order.
- Parameters
-
int $id The order ID.
- Returns
- bool
Implemented in OrderService.
◆ place()
| place | ( | \Magento\Sales\Api\Data\OrderInterface | $order | ) |
- Parameters
-
\Magento\Sales\Api\Data\OrderInterface $order
- Returns
- \Magento\Sales\Api\Data\OrderInterface
◆ unHold()
| unHold | ( | $id | ) |
Releases a specified order from hold status.
- Parameters
-
int $id The order ID.
- Returns
- bool
Implemented in OrderService.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/OrderManagementInterface.php