OrderReferenceInterface.php 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Api\Data\Order;
  6. /**
  7. * Temando Order Reference Interface.
  8. *
  9. * An order reference represents the link between local quote/order address and
  10. * an order entity at the Temando platform. Creating an order at the Temando
  11. * platform results in a set of shipping experiences (shipping rates) applicable
  12. * to the given order data.
  13. *
  14. * @api
  15. * @package Temando\Shipping\Api
  16. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  17. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  18. * @link http://www.temando.com/
  19. */
  20. interface OrderReferenceInterface
  21. {
  22. const ENTITY_ID = 'entity_id';
  23. const ORDER_ID = 'order_id';
  24. const EXT_ORDER_ID = 'ext_order_id';
  25. const COLLECTION_POINT_ID = 'collection_point_id';
  26. const SHIPPING_EXPERIENCES = 'shipping_experiences';
  27. /**
  28. * @return int
  29. */
  30. public function getEntityId();
  31. /**
  32. * @param int $entityId
  33. * @return void
  34. */
  35. public function setEntityId($entityId);
  36. /**
  37. * @return int
  38. */
  39. public function getOrderId();
  40. /**
  41. * @param int $orderId
  42. * @return void
  43. */
  44. public function setOrderId($orderId);
  45. /**
  46. * @return string
  47. */
  48. public function getExtOrderId();
  49. /**
  50. * @param string $extOrderId
  51. * @return void
  52. */
  53. public function setExtOrderId($extOrderId);
  54. /**
  55. * @deprecated since 1.2.0 | never populated, never used.
  56. * @return \Temando\Shipping\Api\Data\Order\ShippingExperienceInterface[]
  57. */
  58. public function getShippingExperiences();
  59. /**
  60. * @deprecated since 1.2.0 | never populated, never used.
  61. * @param \Temando\Shipping\Api\Data\Order\ShippingExperienceInterface[] $shippingExperiences
  62. * @return void
  63. */
  64. public function setShippingExperiences(array $shippingExperiences);
  65. }