OrderInterface.php 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Model;
  6. /**
  7. * Temando Order Interface
  8. *
  9. * An order entity at the Temando platform.
  10. *
  11. * @package Temando\Shipping\Model
  12. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  13. * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  14. * @link https://www.temando.com/
  15. */
  16. interface OrderInterface
  17. {
  18. const ORDER_ID = 'order_id';
  19. const CREATED_AT = 'created_at';
  20. const LAST_MODIFIED_AT = 'last_modified_at';
  21. const ORDERED_AT = 'ordered_at';
  22. const STATUS = 'status';
  23. const STATUS_AWAITING_PAYMENT = 'awaiting payment';
  24. const STATUS_CONFIRMED = 'confirmed';
  25. const STATUS_PROCESSING = 'processing';
  26. const STATUS_FULFILLED = 'fulfilled';
  27. const STATUS_CANCELLED = 'cancelled';
  28. const STATUS_ARCHIVED = 'archived';
  29. const STATUS_REFUNDED = 'refunded';
  30. const STATUS_CLOSED = 'closed';
  31. const BILLING = 'billing';
  32. const RECIPIENT = 'recipient';
  33. const ORDER_ITEMS = 'order_items';
  34. const CURRENCY = 'currency';
  35. const AMOUNT = 'amount';
  36. const SOURCE_REFERENCE = 'source_reference';
  37. const SOURCE_ID = 'source_id';
  38. const SOURCE_INCREMENT_ID = 'source_increment_id';
  39. const CHECKOUT_FIELDS = 'checkout_fields';
  40. const COLLECTION_POINT = 'collection_point';
  41. const COLLECTION_POINT_SEARCH_REQUEST = 'collection_point_search_request';
  42. const PICKUP_LOCATION = 'pickup_location';
  43. const PICKUP_LOCATION_SEARCH_REQUEST = 'pickup_location_search_request';
  44. const SELECTED_EXPERIENCE_CODE = 'experience_code';
  45. const SELECTED_EXPERIENCE_CURRENCY = 'experience_currency';
  46. const SELECTED_EXPERIENCE_AMOUNT = 'experience_amount';
  47. const SELECTED_EXPERIENCE_LANGUAGE = 'experience_language';
  48. const SELECTED_EXPERIENCE_DESCRIPTION = 'experience_description';
  49. /**
  50. * @return string
  51. */
  52. public function getOrderId();
  53. /**
  54. * @return string
  55. */
  56. public function getCreatedAt();
  57. /**
  58. * @return string
  59. */
  60. public function getLastModifiedAt();
  61. /**
  62. * @return string
  63. */
  64. public function getOrderedAt();
  65. /**
  66. * @return string
  67. */
  68. public function getStatus();
  69. /**
  70. * @return \Temando\Shipping\Model\Order\OrderBillingInterface
  71. */
  72. public function getBilling();
  73. /**
  74. * @return \Temando\Shipping\Model\Order\OrderRecipientInterface
  75. */
  76. public function getRecipient();
  77. /**
  78. * @return \Temando\Shipping\Model\Order\OrderItemInterface[]
  79. */
  80. public function getOrderItems();
  81. /**
  82. * @return string
  83. */
  84. public function getCurrency();
  85. /**
  86. * @return float
  87. */
  88. public function getAmount();
  89. /**
  90. * @return int
  91. */
  92. public function getSourceReference();
  93. /**
  94. * @return string
  95. */
  96. public function getSourceId();
  97. /**
  98. * @return string
  99. */
  100. public function getSourceIncrementId();
  101. /**
  102. * @return \Temando\Shipping\Model\Checkout\Attribute\CheckoutFieldInterface[]
  103. */
  104. public function getCheckoutFields();
  105. /**
  106. * @return \Temando\Shipping\Api\Data\Delivery\CollectionPointSearchRequestInterface|null
  107. */
  108. public function getCollectionPointSearchRequest();
  109. /**
  110. * @return \Temando\Shipping\Api\Data\Delivery\QuoteCollectionPointInterface|null
  111. */
  112. public function getCollectionPoint();
  113. /**
  114. * @return \Temando\Shipping\Api\Data\Delivery\PickupLocationSearchRequestInterface|null
  115. */
  116. public function getPickupLocationSearchRequest();
  117. /**
  118. * @return \Temando\Shipping\Api\Data\Delivery\QuotePickupLocationInterface|null
  119. */
  120. public function getPickupLocation();
  121. /**
  122. * @return string
  123. */
  124. public function getExperienceCode();
  125. /**
  126. * @return string
  127. */
  128. public function getExperienceCurrency();
  129. /**
  130. * @return float
  131. */
  132. public function getExperienceAmount();
  133. /**
  134. * @return string
  135. */
  136. public function getExperienceLanguage();
  137. /**
  138. * @return string
  139. */
  140. public function getExperienceDescription();
  141. }