ShipmentManagementInterface.php 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Api;
  7. /**
  8. * Shipment management interface.
  9. *
  10. * A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This
  11. * document lists the products and their quantities in the delivery package.
  12. * @api
  13. * @since 100.0.2
  14. */
  15. interface ShipmentManagementInterface
  16. {
  17. /**
  18. * Gets a specified shipment label.
  19. *
  20. * @param int $id The shipment label ID.
  21. * @return string Shipment label.
  22. */
  23. public function getLabel($id);
  24. /**
  25. * Lists comments for a specified shipment.
  26. *
  27. * @param int $id The shipment ID.
  28. * @return \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface Shipment comment search result interface.
  29. */
  30. public function getCommentsList($id);
  31. /**
  32. * Emails user a specified shipment.
  33. *
  34. * @param int $id The shipment ID.
  35. * @return bool
  36. */
  37. public function notify($id);
  38. }