Public Member Functions | |
| getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria) | |
| get ($id) | |
| delete (\Magento\Sales\Api\Data\ShipmentInterface $entity) | |
| save (\Magento\Sales\Api\Data\ShipmentInterface $entity) | |
| create () | |
Detailed Description
Shipment repository interface.
A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. @api
- Since
- 100.0.2
Definition at line 16 of file ShipmentRepositoryInterface.php.
Member Function Documentation
◆ create()
| create | ( | ) |
Creates new shipment instance.
- Returns
- \Magento\Sales\Api\Data\ShipmentInterface Shipment interface.
Implemented in ShipmentRepository.
◆ delete()
| delete | ( | \Magento\Sales\Api\Data\ShipmentInterface | $entity | ) |
Deletes a specified shipment.
- Parameters
-
\Magento\Sales\Api\Data\ShipmentInterface $entity The shipment.
- Returns
- bool
◆ get()
| get | ( | $id | ) |
Loads a specified shipment.
- Parameters
-
int $id The shipment ID.
- Returns
- \Magento\Sales\Api\Data\ShipmentInterface
◆ getList()
| getList | ( | \Magento\Framework\Api\SearchCriteriaInterface | $searchCriteria | ) |
Lists shipments 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#ShipmentRepositoryInterface 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\ShipmentSearchResultInterface Shipment search results interface.
◆ save()
| save | ( | \Magento\Sales\Api\Data\ShipmentInterface | $entity | ) |
Performs persist operations for a specified shipment.
- Parameters
-
\Magento\Sales\Api\Data\ShipmentInterface $entity The shipment.
- Returns
- \Magento\Sales\Api\Data\ShipmentInterface Shipment interface.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/ShipmentRepositoryInterface.php