Public Member Functions | |
| getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria) | |
| get ($id) | |
| delete (\Magento\Sales\Api\Data\OrderInterface $entity) | |
| save (\Magento\Sales\Api\Data\OrderInterface $entity) | |
Detailed Description
Order repository 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 17 of file OrderRepositoryInterface.php.
Member Function Documentation
◆ delete()
| delete | ( | \Magento\Sales\Api\Data\OrderInterface | $entity | ) |
Deletes a specified order.
- Parameters
-
\Magento\Sales\Api\Data\OrderInterface $entity The order ID.
- Returns
- bool
◆ get()
| get | ( | $id | ) |
Loads a specified order.
- Parameters
-
int $id The order ID.
- Returns
- \Magento\Sales\Api\Data\OrderInterface Order interface.
◆ getList()
| getList | ( | \Magento\Framework\Api\SearchCriteriaInterface | $searchCriteria | ) |
Lists orders that match specified search criteria.
This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
- Parameters
-
\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
- Returns
- \Magento\Sales\Api\Data\OrderSearchResultInterface Order search result interface.
◆ save()
| save | ( | \Magento\Sales\Api\Data\OrderInterface | $entity | ) |
Performs persist operations for a specified order.
- Parameters
-
\Magento\Sales\Api\Data\OrderInterface $entity The order ID.
- Returns
- \Magento\Sales\Api\Data\OrderInterface Order interface.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/OrderRepositoryInterface.php