Inheritance diagram for ShipmentManagementInterface:
Public Member Functions | |
| getLabel ($id) | |
| getCommentsList ($id) | |
| notify ($id) | |
Detailed Description
Shipment management 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 ShipmentManagementInterface.php.
Member Function Documentation
◆ getCommentsList()
| getCommentsList | ( | $id | ) |
Lists comments for a specified shipment.
- Parameters
-
int $id The shipment ID.
- Returns
- \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface Shipment comment search result interface.
Implemented in ShipmentService.
◆ getLabel()
| getLabel | ( | $id | ) |
Gets a specified shipment label.
- Parameters
-
int $id The shipment label ID.
- Returns
- string Shipment label.
Implemented in ShipmentService.
◆ notify()
| notify | ( | $id | ) |
Emails user a specified shipment.
- Parameters
-
int $id The shipment ID.
- Returns
- bool
Implemented in ShipmentService.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/ShipmentManagementInterface.php