From f6b3aafbcef42cef84cacb75afef4e5d63e6c1b9 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Mon, 15 Dec 2014 12:47:55 -0600 Subject: [PATCH] MAGEDOC-1720: [DOC] [PAR] Sales module API --- .../CreditmemoCommentRepositoryInterface.php | 31 +- .../Api/CreditmemoItemRepositoryInterface.php | 29 +- .../Api/CreditmemoManagementInterface.php | 21 +- .../Api/CreditmemoRepositoryInterface.php | 28 +- .../Api/Data/CreditmemoCommentInterface.php | 51 +- ...CreditmemoCommentSearchResultInterface.php | 11 +- .../Sales/Api/Data/CreditmemoInterface.php | 358 +++++-- .../Api/Data/CreditmemoItemInterface.php | 232 ++-- .../CreditmemoItemSearchResultInterface.php | 11 +- .../Data/CreditmemoSearchResultInterface.php | 10 +- .../Api/Data/InvoiceCommentInterface.php | 49 +- .../InvoiceCommentSearchResultInterface.php | 10 +- .../Sales/Api/Data/InvoiceInterface.php | 326 ++++-- .../Sales/Api/Data/InvoiceItemInterface.php | 174 ++- .../Data/InvoiceItemSearchResultInterface.php | 9 +- .../Api/Data/InvoiceSearchResultInterface.php | 9 +- .../Sales/Api/Data/OrderAddressInterface.php | 190 +++- .../OrderAddressSearchResultInterface.php | 11 +- .../Magento/Sales/Api/Data/OrderInterface.php | 991 +++++++++++++----- .../Sales/Api/Data/OrderItemInterface.php | 664 ++++++++---- .../Data/OrderItemSearchResultInterface.php | 11 +- .../Sales/Api/Data/OrderPaymentInterface.php | 386 +++++-- .../OrderPaymentSearchResultInterface.php | 11 +- .../Api/Data/OrderSearchResultInterface.php | 11 +- .../Api/Data/OrderStatusHistoryInterface.php | 64 +- ...rderStatusHistorySearchResultInterface.php | 11 +- .../Api/Data/ShipmentCommentInterface.php | 49 +- .../ShipmentCommentSearchResultInterface.php | 9 +- .../Sales/Api/Data/ShipmentInterface.php | 131 ++- .../Sales/Api/Data/ShipmentItemInterface.php | 89 +- .../ShipmentItemSearchResultInterface.php | 10 +- .../Api/Data/ShipmentPackageInterface.php | 5 +- .../Data/ShipmentSearchResultInterface.php | 10 +- .../Sales/Api/Data/ShipmentTrackInterface.php | 83 +- .../ShipmentTrackSearchResultInterface.php | 10 +- .../Sales/Api/Data/TransactionInterface.php | 89 +- .../Data/TransactionSearchResultInterface.php | 9 +- .../Api/InvoiceCommentRepositoryInterface.php | 27 +- .../Api/InvoiceItemRepositoryInterface.php | 22 +- .../Sales/Api/InvoiceManagementInterface.php | 21 +- .../Sales/Api/InvoiceRepositoryInterface.php | 26 +- .../Api/OrderAddressRepositoryInterface.php | 28 +- .../Api/OrderItemRepositoryInterface.php | 28 +- .../Sales/Api/OrderManagementInterface.php | 40 +- .../Api/OrderPaymentRepositoryInterface.php | 28 +- .../Sales/Api/OrderRepositoryInterface.php | 28 +- .../OrderStatusHistoryRepositoryInterface.php | 28 +- .../ShipmentCommentRepositoryInterface.php | 27 +- .../Api/ShipmentItemRepositoryInterface.php | 24 +- .../Sales/Api/ShipmentManagementInterface.php | 22 +- .../Sales/Api/ShipmentRepositoryInterface.php | 26 +- .../Api/ShipmentTrackRepositoryInterface.php | 33 +- .../Api/TransactionRepositoryInterface.php | 26 +- 53 files changed, 3250 insertions(+), 1387 deletions(-) diff --git a/app/code/Magento/Sales/Api/CreditmemoCommentRepositoryInterface.php b/app/code/Magento/Sales/Api/CreditmemoCommentRepositoryInterface.php index 89de16b5acd01..767f850e2ec15 100644 --- a/app/code/Magento/Sales/Api/CreditmemoCommentRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/CreditmemoCommentRepositoryInterface.php @@ -5,37 +5,46 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Credit memo comment repository interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo usually includes comments that detail + * why the credit memo amount was credited to the customer. */ interface CreditmemoCommentRepositoryInterface { /** - * Load entity + * Loads a specified credit memo comment. * - * @param int $id - * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface + * @param int $id The credit memo comment ID. + * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface Credit memo comment interface. */ public function get($id); /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface + * Lists credit memo comments that match specified search criteria. + * + * Returns a credit memo comment search results interface. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface Credit memo comment search results interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Delete entity + * Deletes a specified credit memo comment. * - * @param \Magento\Sales\Api\Data\CreditmemoCommentInterface $entity + * @param \Magento\Sales\Api\Data\CreditmemoCommentInterface $entity The credit memo comment. * @return bool */ public function delete(\Magento\Sales\Api\Data\CreditmemoCommentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified entity. * - * @param \Magento\Sales\Api\Data\CreditmemoCommentInterface $entity - * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface + * @param \Magento\Sales\Api\Data\CreditmemoCommentInterface $entity The credit memo comment. + * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface Credit memo comment interface. */ public function save(\Magento\Sales\Api\Data\CreditmemoCommentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/CreditmemoItemRepositoryInterface.php b/app/code/Magento/Sales/Api/CreditmemoItemRepositoryInterface.php index 77daa7cd93e32..f442873f61dc7 100644 --- a/app/code/Magento/Sales/Api/CreditmemoItemRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/CreditmemoItemRepositoryInterface.php @@ -5,37 +5,44 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Credit memo item repository interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which + * a merchant creates a credit memo. */ interface CreditmemoItemRepositoryInterface { /** - * Load entity + * Loads a specified credit memo item. * - * @param int $id - * @return \Magento\Sales\Api\Data\CreditmemoItemInterface + * @param int $id The credit memo item ID. + * @return \Magento\Sales\Api\Data\CreditmemoItemInterface Credit memo item interface. */ public function get($id); /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\CreditmemoItemSearchResultInterface + * Lists credit memo items that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\CreditmemoItemSearchResultInterface Credit memo item search results interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Delete entity + * Deletes a specified credit memo item. * - * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity + * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo item. * @return bool */ public function delete(\Magento\Sales\Api\Data\CreditmemoInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified credit memo item. * - * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity - * @return \Magento\Sales\Api\Data\CreditmemoInterface + * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo item. + * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface. */ public function save(\Magento\Sales\Api\Data\CreditmemoInterface $entity); } diff --git a/app/code/Magento/Sales/Api/CreditmemoManagementInterface.php b/app/code/Magento/Sales/Api/CreditmemoManagementInterface.php index a1bfd98fa6a48..5b647f2886cb4 100644 --- a/app/code/Magento/Sales/Api/CreditmemoManagementInterface.php +++ b/app/code/Magento/Sales/Api/CreditmemoManagementInterface.php @@ -5,29 +5,34 @@ namespace Magento\Sales\Api; /** - * Interface CreditmemoAddCommentInterface + * Credit memo add comment interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. */ interface CreditmemoManagementInterface { /** - * Cancel an existing creditimemo + * Cancels a specified credit memo. * - * @param int $id + * @param int $id The credit memo ID. * @return bool */ public function cancel($id); /** - * Returns list of comments attached to creditmemo - * @param int $id - * @return \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface + * Lists comments for a specified credit memo. + * + * @param int $id The credit memo ID. + * @return \Magento\Sales\Api\Data\CreditmemoCommentSearchResultInterface Credit memo comment search results interface. */ public function getCommentsList($id); /** - * Notify user + * Emails a user a specified credit memo. * - * @param int $id + * @param int $id The credit memo ID. * @return bool */ public function notify($id); diff --git a/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php b/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php index a2cd4db79866a..a3cc19e811486 100644 --- a/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Credit memo repository interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. */ interface CreditmemoRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface + * Lists credit memos that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface Credit memo search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified credit memo. * - * @param int $id - * @return \Magento\Sales\Api\Data\CreditmemoInterface + * @param int $id The credit memo ID. + * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface. */ public function get($id); /** - * Delete entity + * Deletes a specified credit memo. * - * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity + * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo. * @return bool */ public function delete(\Magento\Sales\Api\Data\CreditmemoInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified credit memo. * - * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity - * @return \Magento\Sales\Api\Data\CreditmemoInterface + * @param \Magento\Sales\Api\Data\CreditmemoInterface $entity The credit memo. + * @return \Magento\Sales\Api\Data\CreditmemoInterface Credit memo interface. */ public function save(\Magento\Sales\Api\Data\CreditmemoInterface $entity); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoCommentInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoCommentInterface.php index 56e375eee5dda..66eaabc4d6856 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoCommentInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoCommentInterface.php @@ -5,59 +5,82 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoCommentInterface + * Credit memo comment interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo usually includes comments that detail + * why the credit memo amount was credited to the customer. */ interface CreditmemoCommentInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Is-customer-notified flag. + */ const IS_CUSTOMER_NOTIFIED = 'is_customer_notified'; + /* + * Is-visible-on-storefront flag. + */ const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'; + /* + * Comment. + */ const COMMENT = 'comment'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; /** - * Returns comment + * Gets the credit memo comment. * - * @return string + * @return string Comment. */ public function getComment(); /** - * Returns created_at + * Gets the credit memo created-at timestamp. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns entity_id + * Gets the credit memo ID. * - * @return int + * @return int Credit memo ID. */ public function getEntityId(); /** - * Returns is_customer_notified + * Gets the is-customer-notified flag value for the credit memo. * - * @return int + * @return int Is-customer-notified flag value. */ public function getIsCustomerNotified(); /** - * Returns is_visible_on_front + * Gets the is-visible-on-storefront flag value for the credit memo. * - * @return int + * @return int Is-visible-on-storefront flag value. */ public function getIsVisibleOnFront(); /** - * Returns parent_id + * Gets the parent ID for the credit memo. * - * @return int + * @return int Parent ID. */ public function getParentId(); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoCommentSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoCommentSearchResultInterface.php index 7c4a72f28e1be..8304c70c182fa 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoCommentSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoCommentSearchResultInterface.php @@ -5,14 +5,19 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoCommentSearchResultInterface + * Credit memo comment search result interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo usually includes comments that detail + * why the credit memo amount was credited to the customer. */ interface CreditmemoCommentSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface[] + * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoInterface.php index 5e8c9a4acba7f..b2b02ee6b001a 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoInterface.php @@ -5,408 +5,562 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoInterface + * Credit memo interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. */ interface CreditmemoInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Store ID. + */ const STORE_ID = 'store_id'; + /* + * Positive adjustment. + */ const ADJUSTMENT_POSITIVE = 'adjustment_positive'; + /* + * Base shipping tax amount. + */ const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'; + /* + * Store-to-order rate. + */ const STORE_TO_ORDER_RATE = 'store_to_order_rate'; + /* + * Base discount rate. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Base-to-order rate. + */ const BASE_TO_ORDER_RATE = 'base_to_order_rate'; + /* + * Grand total. + */ const GRAND_TOTAL = 'grand_total'; + /* + * Negative base adjustment. + */ const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'; + /* + * Base subtotal including tax. + */ const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'; + /* + * Shipping amount. + */ const SHIPPING_AMOUNT = 'shipping_amount'; + /* + * Subtotal including tax. + */ const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'; + /* + * Negative adjustment. + */ const ADJUSTMENT_NEGATIVE = 'adjustment_negative'; + /* + * Base shipping amount. + */ const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'; + /* + * Store-to-base rate. + */ const STORE_TO_BASE_RATE = 'store_to_base_rate'; + /* + * Base-to-global rate. + */ const BASE_TO_GLOBAL_RATE = 'base_to_global_rate'; + /* + * Base adjustment. + */ const BASE_ADJUSTMENT = 'base_adjustment'; + /* + * Base subtotal. + */ const BASE_SUBTOTAL = 'base_subtotal'; + /* + * Discount amount. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Subtotal. + */ const SUBTOTAL = 'subtotal'; + /* + * Subtotal. + */ const ADJUSTMENT = 'adjustment'; + /* + * Base grand total. + */ const BASE_GRAND_TOTAL = 'base_grand_total'; + /* + * Positive base adjustment. + */ const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Shipping tax amount. + */ const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Email sent flag. + */ const EMAIL_SENT = 'email_sent'; + /* + * Credit memo status. + */ const CREDITMEMO_STATUS = 'creditmemo_status'; + /* + * Credit memo state. + */ const STATE = 'state'; + /* + * Shipping address ID. + */ const SHIPPING_ADDRESS_ID = 'shipping_address_id'; + /* + * Billing address ID. + */ const BILLING_ADDRESS_ID = 'billing_address_id'; + /* + * Invoice ID. + */ const INVOICE_ID = 'invoice_id'; + /* + * Store currency code. + */ const STORE_CURRENCY_CODE = 'store_currency_code'; + /* + * Order currency code. + */ const ORDER_CURRENCY_CODE = 'order_currency_code'; + /* + * Base currency code. + */ const BASE_CURRENCY_CODE = 'base_currency_code'; + /* + * Global currency code. + */ const GLOBAL_CURRENCY_CODE = 'global_currency_code'; + /* + * Transaction ID. + */ const TRANSACTION_ID = 'transaction_id'; + /* + * Increment ID. + */ const INCREMENT_ID = 'increment_id'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; + /* + * Shipping hidden tax amount. + */ const SHIPPING_HIDDEN_TAX_AMOUNT = 'shipping_hidden_tax_amount'; + /* + * Base shipping hidden tax amount. + */ const BASE_SHIPPING_HIDDEN_TAX_AMNT = 'base_shipping_hidden_tax_amnt'; + /* + * Shipping including tax. + */ const SHIPPING_INCL_TAX = 'shipping_incl_tax'; + /* + * Base shipping including tax. + */ const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'; + /* + * Discount description. + */ const DISCOUNT_DESCRIPTION = 'discount_description'; + /* + * Credit memo items. + */ const ITEMS = 'items'; + /* + * Credit memo comments. + */ const COMMENTS = 'comments'; /** - * Returns adjustment + * Gets the credit memo adjustment. * - * @return float + * @return float Credit memo adjustment. */ public function getAdjustment(); /** - * Returns adjustment_negative + * Gets the credit memo negative adjustment. * - * @return float + * @return float Credit memo negative adjustment. */ public function getAdjustmentNegative(); /** - * Returns adjustment_positive + * Gets the credit memo positive adjustment. * - * @return float + * @return float Credit memo positive adjustment. */ public function getAdjustmentPositive(); /** - * Returns base_adjustment + * Gets the credit memo base adjustment. * - * @return float + * @return float Credit memo base adjustment. */ public function getBaseAdjustment(); /** - * Returns base_adjustment_negative + * Gets the credit memo negative base adjustment. * - * @return float + * @return float Credit memo negative base adjustment. */ public function getBaseAdjustmentNegative(); /** - * Returns base_adjustment_positive + * Gets the credit memo positive base adjustment. * - * @return float + * @return float Credit memo positive base adjustment. */ public function getBaseAdjustmentPositive(); /** - * Returns base_currency_code + * Gets the credit memo base currency code. * - * @return string + * @return string Credit memo base currency code. */ public function getBaseCurrencyCode(); /** - * Returns base_discount_amount + * Gets the credit memo base discount amount. * - * @return float + * @return float Credit memo base discount amount. */ public function getBaseDiscountAmount(); /** - * Returns base_grand_total + * Gets the credit memo base grand total. * - * @return float + * @return float Credit memo base grand total. */ public function getBaseGrandTotal(); /** - * Returns base_hidden_tax_amount + * Gets the credit memo base hidden tax amount. * - * @return float + * @return float Credit memo base hidden tax amount. */ public function getBaseHiddenTaxAmount(); /** - * Returns base_shipping_amount + * Gets the credit memo base shipping amount. * - * @return float + * @return float Credit memo base shipping amount. */ public function getBaseShippingAmount(); /** - * Returns base_shipping_hidden_tax_amnt + * Gets the credit memo base shipping hidden tax amount. * - * @return float + * @return float Credit memo base shipping hidden tax amount. */ public function getBaseShippingHiddenTaxAmnt(); /** - * Returns base_shipping_incl_tax + * Gets the credit memo base shipping including tax. * - * @return float + * @return float Credit memo base shipping including tax. */ public function getBaseShippingInclTax(); /** - * Returns base_shipping_tax_amount + * Gets the credit memo base shipping tax amount. * - * @return float + * @return float Credit memo base shipping tax amount. */ public function getBaseShippingTaxAmount(); /** - * Returns base_subtotal + * Gets the credit memo base subtotal. * - * @return float + * @return float Credit memo base subtotal. */ public function getBaseSubtotal(); /** - * Returns base_subtotal_incl_tax + * Gets the credit memo base subtotal including tax. * - * @return float + * @return float Credit memo base subtotal including tax. */ public function getBaseSubtotalInclTax(); /** - * Returns base_tax_amount + * Gets the credit memo base tax amount. * - * @return float + * @return float Credit memo base tax amount. */ public function getBaseTaxAmount(); /** - * Returns base_to_global_rate + * Gets the credit memo base-to-global rate. * - * @return float + * @return float Credit memo base-to-global rate. */ public function getBaseToGlobalRate(); /** - * Returns base_to_order_rate + * Gets the credit memo base-to-order rate. * - * @return float + * @return float Credit memo base-to-order rate. */ public function getBaseToOrderRate(); /** - * Returns billing_address_id + * Gets the credit memo billing address ID. * - * @return int + * @return int Credit memo billing address ID. */ public function getBillingAddressId(); /** - * Returns created_at + * Gets the credit memo created-at timestamp. * - * @return string + * @return string Credit memo created-at timestamp. */ public function getCreatedAt(); /** - * Returns creditmemo_status + * Gets the credit memo status. * - * @return int + * @return int Credit memo status. */ public function getCreditmemoStatus(); /** - * Returns discount_amount + * Gets the credit memo discount amount. * - * @return float + * @return float Credit memo discount amount. */ public function getDiscountAmount(); /** - * Returns discount_description + * Gets the credit memo discount description. * - * @return string + * @return string Credit memo discount description. */ public function getDiscountDescription(); /** - * Returns email_sent + * Gets the credit memo email sent flag value. * - * @return int + * @return int Credit memo email sent flag value. */ public function getEmailSent(); /** - * Returns entity_id + * Gets the credit memo ID. * - * @return int + * @return int Credit memo ID. */ public function getEntityId(); /** - * Returns global_currency_code + * Gets the credit memo global currency code. * - * @return string + * @return string Credit memo global currency code. */ public function getGlobalCurrencyCode(); /** - * Returns grand_total + * Gets the credit memo grand total. * - * @return float + * @return float Credit memo grand total. */ public function getGrandTotal(); /** - * Returns hidden_tax_amount + * Gets the credit memo hidden tax amount. * - * @return float + * @return float Credit memo hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns increment_id + * Gets the credit memo increment ID. * - * @return string + * @return string Credit memo increment ID. */ public function getIncrementId(); /** - * Returns invoice_id + * Gets the credit memo invoice ID. * - * @return int + * @return int Credit memo invoice ID. */ public function getInvoiceId(); /** - * Returns order_currency_code + * Gets the credit memo order currency code. * - * @return string + * @return string Credit memo order currency code. */ public function getOrderCurrencyCode(); /** - * Returns order_id + * Gets the credit memo order ID. * - * @return int + * @return int Credit memo order ID. */ public function getOrderId(); /** - * Returns shipping_address_id + * Gets the credit memo shipping address ID. * - * @return int + * @return int Credit memo shipping address ID. */ public function getShippingAddressId(); /** - * Returns shipping_amount + * Gets the credit memo shipping amount. * - * @return float + * @return float Credit memo shipping amount. */ public function getShippingAmount(); /** - * Returns shipping_hidden_tax_amount + * Gets the credit memo shipping hidden tax amount. * - * @return float + * @return float Credit memo shipping hidden tax amount. */ public function getShippingHiddenTaxAmount(); /** - * Returns shipping_incl_tax + * Gets the credit memo shipping including tax. * - * @return float + * @return float Credit memo shipping including tax. */ public function getShippingInclTax(); /** - * Returns shipping_tax_amount + * Gets the credit memo shipping tax amount. * - * @return float + * @return float Credit memo shipping tax amount. */ public function getShippingTaxAmount(); /** - * Returns state + * Gets the credit memo state. * - * @return int + * @return int Credit memo state. */ public function getState(); /** - * Returns store_currency_code + * Gets the credit memo store currency code. * - * @return string + * @return string Credit memo store currency code. */ public function getStoreCurrencyCode(); /** - * Returns store_id + * Gets the credit memo store ID. * - * @return int + * @return int Credit memo store ID. */ public function getStoreId(); /** - * Returns store_to_base_rate + * Gets the credit memo store-to-base rate. * - * @return float + * @return float Credit memo store-to-base rate. */ public function getStoreToBaseRate(); /** - * Returns store_to_order_rate + * Gets the credit memo store-to-order rate. * - * @return float + * @return float Credit memo store-to-order rate. */ public function getStoreToOrderRate(); /** - * Returns subtotal + * Gets the credit memo subtotal. * - * @return float + * @return float Credit memo subtotal. */ public function getSubtotal(); /** - * Returns subtotal_incl_tax + * Gets the credit memo subtotal including tax. * - * @return float + * @return float Credit memo subtotal including tax. */ public function getSubtotalInclTax(); /** - * Returns tax_amount + * Gets the credit memo tax amount. * - * @return float + * @return float Credit memo tax amount. */ public function getTaxAmount(); /** - * Returns transaction_id + * Gets the credit memo transaction ID. * - * @return string + * @return string Credit memo transaction ID. */ public function getTransactionId(); /** - * Returns updated_at + * Gets the credit memo updated-at timestamp. * - * @return string + * @return string Credit memo updated-at timestamp. */ public function getUpdatedAt(); /** - * Return creditmemo items + * Gets credit memo items. * - * @return \Magento\Sales\Api\Data\CreditmemoItemInterface[] + * @return \Magento\Sales\Api\Data\CreditmemoItemInterface[] Array of credit memo items. */ public function getItems(); /** - * Return creditmemo comments + * Gets credit memo comments. * - * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface[]|null + * @return \Magento\Sales\Api\Data\CreditmemoCommentInterface[]|null Array of any credit memo comments. Otherwise, null. */ public function getComments(); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoItemInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoItemInterface.php index 7caafa8ee44c2..aa506840c147d 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoItemInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoItemInterface.php @@ -5,275 +5,379 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoItemInterface + * Credit memo item interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which + * a merchant creates a credit memo. */ interface CreditmemoItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Credit memo item ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Base price. + */ const BASE_PRICE = 'base_price'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Base row total. + */ const BASE_ROW_TOTAL = 'base_row_total'; + /* + * Base row total. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Row total. + */ const ROW_TOTAL = 'row_total'; + /* + * Base discount amount. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Price including tax. + */ const PRICE_INCL_TAX = 'price_incl_tax'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Base price including tax. + */ const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'; + /* + * Quantity. + */ const QTY = 'qty'; + /* + * Base cost. + */ const BASE_COST = 'base_cost'; + /* + * Price. + */ const PRICE = 'price'; + /* + * Base row total including tax. + */ const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'; + /* + * Row total including tax. + */ const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'; + /* + * Product ID. + */ const PRODUCT_ID = 'product_id'; + /* + * Order item ID. + */ const ORDER_ITEM_ID = 'order_item_id'; + /* + * Additional data. + */ const ADDITIONAL_DATA = 'additional_data'; + /* + * Description. + */ const DESCRIPTION = 'description'; + /* + * SKU. + */ const SKU = 'sku'; + /* + * Name. + */ const NAME = 'name'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; + /* + * WEEE tax disposition. + */ const WEEE_TAX_DISPOSITION = 'weee_tax_disposition'; + /* + * WEEE tax row disposition. + */ const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition'; + /* + * Base WEEE tax disposition. + */ const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition'; + /* + * Base WEEE tax row disposition. + */ const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition'; + /* + * WEEE tax applied. + */ const WEEE_TAX_APPLIED = 'weee_tax_applied'; + /* + * Base WEEE tax applied amount. + */ const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount'; + /* + * Base WEEE tax applied row amount. + */ const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt'; + /* + * WEEE tax applied amount. + */ const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'; + /* + * WEEE tax applied row amount. + */ const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount'; /** - * Returns additional_data + * Gets the additional data for a credit memo item. * - * @return string + * @return string Additional data. */ public function getAdditionalData(); /** - * Returns base_cost + * Gets the base cost for a credit memo item. * * @return float */ public function getBaseCost(); /** - * Returns base_discount_amount + * Gets the base discount amount for a credit memo item. * * @return float */ public function getBaseDiscountAmount(); /** - * Returns base_hidden_tax_amount + * Gets the base hidden tax amount for a credit memo item. * * @return float */ public function getBaseHiddenTaxAmount(); /** - * Returns base_price + * Gets the base price for a credit memo item. * * @return float */ public function getBasePrice(); /** - * Returns base_price_incl_tax + * Gets the base price including tax for a credit memo item. * - * @return float + * @return float Base price including tax. */ public function getBasePriceInclTax(); /** - * Returns base_row_total + * Gets the base row total for a credit memo item. * - * @return float + * @return float Base row total. */ public function getBaseRowTotal(); /** - * Returns base_row_total_incl_tax + * Gets the base row total including tax for a credit memo item. * - * @return float + * @return float Base row total including tax. */ public function getBaseRowTotalInclTax(); /** - * Returns base_tax_amount + * Gets the base tax amount for a credit memo item. * - * @return float + * @return float Base tax amount. */ public function getBaseTaxAmount(); /** - * Returns base_weee_tax_applied_amount + * Gets the base WEEE tax applied amount for a credit memo item. * - * @return float + * @return float Base WEEE tax applied amount. */ public function getBaseWeeeTaxAppliedAmount(); /** - * Returns base_weee_tax_applied_row_amnt + * Gets the base WEEE tax applied row amount for a credit memo item. * - * @return float + * @return float Base WEEE tax applied row amount. */ public function getBaseWeeeTaxAppliedRowAmnt(); /** - * Returns base_weee_tax_disposition + * Gets the base WEEE tax disposition for a credit memo item. * - * @return float + * @return float Base WEEE tax disposition. */ public function getBaseWeeeTaxDisposition(); /** - * Returns base_weee_tax_row_disposition + * Gets the base WEEE tax row disposition for a credit memo item. * - * @return float + * @return float Base WEEE tax row disposition. */ public function getBaseWeeeTaxRowDisposition(); /** - * Returns description + * Gets the description for a credit memo item. * - * @return string + * @return string Description. */ public function getDescription(); /** - * Returns discount_amount + * Gets the discount amount for a credit memo item. * - * @return float + * @return float Discount amount. */ public function getDiscountAmount(); /** - * Returns entity_id + * Gets the ID for a credit memo item. * - * @return int + * @return int Credit memo item ID. */ public function getEntityId(); /** - * Returns hidden_tax_amount + * Gets the hidden tax amount for a credit memo item. * - * @return float + * @return float Hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns name + * Gets the name for a credit memo item. * - * @return string + * @return string Name. */ public function getName(); /** - * Returns order_item_id + * Gets the order item ID for a credit memo item. * - * @return int + * @return int Order item ID. */ public function getOrderItemId(); /** - * Returns parent_id + * Gets the parent ID for a credit memo item. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns price + * Gets the price for a credit memo item. * - * @return float + * @return float Price. */ public function getPrice(); /** - * Returns price_incl_tax + * Gets the price including tax for a credit memo item. * - * @return float + * @return float Price including tax. */ public function getPriceInclTax(); /** - * Returns product_id + * Gets the product ID for a credit memo item. * - * @return int + * @return int Product ID. */ public function getProductId(); /** - * Returns qty + * Gets the quantity for a credit memo item. * - * @return float + * @return float Quantity. */ public function getQty(); /** - * Returns row_total + * Gets the row total for a credit memo item. * - * @return float + * @return float Row total. */ public function getRowTotal(); /** - * Returns row_total_incl_tax + * Gets the row total including tax for a credit memo item. * - * @return float + * @return float Row total including tax. */ public function getRowTotalInclTax(); /** - * Returns sku + * Gets the SKU for a credit memo item. * - * @return string + * @return string SKU. */ public function getSku(); /** - * Returns tax_amount + * Gets the tax amount for a credit memo item. * - * @return float + * @return float Tax amount. */ public function getTaxAmount(); /** - * Returns weee_tax_applied + * Gets the WEEE tax applied for a credit memo item. * - * @return string + * @return string WEEE tax applied. */ public function getWeeeTaxApplied(); /** - * Returns weee_tax_applied_amount + * Gets the WEEE tax applied amount for a credit memo item. * - * @return float + * @return float WEEE tax applied amount. */ public function getWeeeTaxAppliedAmount(); /** - * Returns weee_tax_applied_row_amount + * Gets the WEEE tax applied row amount for a credit memo item. * - * @return float + * @return float WEEE tax applied row amount. */ public function getWeeeTaxAppliedRowAmount(); /** - * Returns weee_tax_disposition + * Gets the WEEE tax disposition for a credit memo item. * - * @return float + * @return float WEEE tax disposition. */ public function getWeeeTaxDisposition(); /** - * Returns weee_tax_row_disposition + * Gets the WEEE tax row disposition for a credit memo item. * - * @return float + * @return float WEEE tax row disposition. */ public function getWeeeTaxRowDisposition(); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoItemSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoItemSearchResultInterface.php index c9bc2c2ce8d00..c24a507fff83c 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoItemSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoItemSearchResultInterface.php @@ -5,14 +5,19 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoItemSearchResultInterface + * Credit memo item search result interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which + * a merchant creates a credit memo. */ interface CreditmemoItemSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\CreditmemoItemInterface[] + * @return \Magento\Sales\Api\Data\CreditmemoItemInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/CreditmemoSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/CreditmemoSearchResultInterface.php index 983456a8b4d14..b559e8c74fc94 100644 --- a/app/code/Magento/Sales/Api/Data/CreditmemoSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/CreditmemoSearchResultInterface.php @@ -5,14 +5,18 @@ namespace Magento\Sales\Api\Data; /** - * Interface CreditmemoSearchResultInterface + * Credit memo search result interface. + * + * After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo + * to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the + * customer account so that the customer can make future purchases. */ interface CreditmemoSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\CreditmemoInterface[] + * @return \Magento\Sales\Api\Data\CreditmemoInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php index 2104f80f68293..67a6a12939c89 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php @@ -5,59 +5,80 @@ namespace Magento\Sales\Api\Data; /** - * Interface InvoiceCommentInterface + * Invoice comment interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the + * invoice history. */ interface InvoiceCommentInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Is-customer-notified flag. + */ const IS_CUSTOMER_NOTIFIED = 'is_customer_notified'; + /* + * Is-visible-on-storefront flag. + */ const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'; + /* + * Comment. + */ const COMMENT = 'comment'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; /** - * Returns comment + * Gets the comment for the invoice. * - * @return string + * @return string Comment. */ public function getComment(); /** - * Returns created_at + * Gets the created-at timestamp for the invoice. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns entity_id + * Gets the ID for the invoice. * - * @return int + * @return int Invoice ID. */ public function getEntityId(); /** - * Returns is_customer_notified + * Gets the is-customer-notified flag value for the invoice. * - * @return int + * @return int Is-customer-notified flag value. */ public function getIsCustomerNotified(); /** - * Returns is_visible_on_front + * Gets the is-visible-on-storefront flag value for the invoice. * - * @return int + * @return int Is-visible-on-storefront flag value. */ public function getIsVisibleOnFront(); /** - * Returns parent_id + * Gets the parent ID for the invoice. * - * @return int + * @return int Parent ID. */ public function getParentId(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceCommentSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceCommentSearchResultInterface.php index 919df9d24cc60..7a194a2351361 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceCommentSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceCommentSearchResultInterface.php @@ -2,18 +2,20 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface InvoiceCommentSearchResultInterface + * Invoice comment search result interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the + * invoice history. */ interface InvoiceCommentSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\InvoiceCommentInterface[] + * @return \Magento\Sales\Api\Data\InvoiceCommentInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceInterface.php index 7ee4f92e16df4..dc203724850ca 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceInterface.php @@ -5,379 +5,519 @@ namespace Magento\Sales\Api\Data; /** - * Interface InvoiceInterface + * Invoice interface. + * + * An invoice is a record of the receipt of payment for an order. */ interface InvoiceInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ * Constants for keys of data array. Identical to the name of the getter in snake case */ + /* + * Entity ID. + */ const ENTITY_ID = 'entity_id'; + /* + * Store ID. + */ const STORE_ID = 'store_id'; + /* + * Base grand total. + */ const BASE_GRAND_TOTAL = 'base_grand_total'; + /* + * Shipping tax amount. + */ const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Store-to-order rate. + */ const STORE_TO_ORDER_RATE = 'store_to_order_rate'; + /* + * Base shipping tax amount. + */ const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'; + /* + * Base discount amount. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Base-to-order rate. + */ const BASE_TO_ORDER_RATE = 'base_to_order_rate'; + /* + * Grand total. + */ const GRAND_TOTAL = 'grand_total'; + /* + * Shipping amount. + */ const SHIPPING_AMOUNT = 'shipping_amount'; + /* + * Subtotal including tax. + */ const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'; + /* + * Base subtotal including tax. + */ const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'; + /* + * Store-to-base rate. + */ const STORE_TO_BASE_RATE = 'store_to_base_rate'; + /* + * Base shipping amount. + */ const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'; + /* + * Total quantity. + */ const TOTAL_QTY = 'total_qty'; + /* + * Base-to-global rate. + */ const BASE_TO_GLOBAL_RATE = 'base_to_global_rate'; + /* + * Subtotal. + */ const SUBTOTAL = 'subtotal'; + /* + * Base subtotal. + */ const BASE_SUBTOTAL = 'base_subtotal'; + /* + * Discount amount. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Billing address ID. + */ const BILLING_ADDRESS_ID = 'billing_address_id'; + /* + * Is used for refund. + */ const IS_USED_FOR_REFUND = 'is_used_for_refund'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Email sent flag. + */ const EMAIL_SENT = 'email_sent'; + /* + * Can void flag. + */ const CAN_VOID_FLAG = 'can_void_flag'; + /* + * State. + */ const STATE = 'state'; + /* + * Shipping address ID. + */ const SHIPPING_ADDRESS_ID = 'shipping_address_id'; + /* + * Store currency code. + */ const STORE_CURRENCY_CODE = 'store_currency_code'; + /* + * Transaction ID. + */ const TRANSACTION_ID = 'transaction_id'; + /* + * Order currency code. + */ const ORDER_CURRENCY_CODE = 'order_currency_code'; + /* + * Base currency code. + */ const BASE_CURRENCY_CODE = 'base_currency_code'; + /* + * Global currency code. + */ const GLOBAL_CURRENCY_CODE = 'global_currency_code'; + /* + * Increment ID. + */ const INCREMENT_ID = 'increment_id'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; + /* + * Shipping hidden tax amount. + */ const SHIPPING_HIDDEN_TAX_AMOUNT = 'shipping_hidden_tax_amount'; + /* + * Base shipping hidden tax amount. + */ const BASE_SHIPPING_HIDDEN_TAX_AMNT = 'base_shipping_hidden_tax_amnt'; + /* + * Shipping including tax. + */ const SHIPPING_INCL_TAX = 'shipping_incl_tax'; + /* + * Base shipping including tax. + */ const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'; + /* + * Base total refunded. + */ const BASE_TOTAL_REFUNDED = 'base_total_refunded'; + /* + * Discount description. + */ const DISCOUNT_DESCRIPTION = 'discount_description'; + /* + * Items. + */ const ITEMS = 'items'; + /* + * Comments. + */ const COMMENTS = 'comments'; /** - * Returns base_currency_code + * Gets the base currency code for the invoice. * - * @return string + * @return string Base currency code. */ public function getBaseCurrencyCode(); /** - * Returns base_discount_amount + * Gets the base discount amount for the invoice. * - * @return float + * @return float Base discount amount. */ public function getBaseDiscountAmount(); /** - * Returns base_grand_total + * Gets the base grand total for the invoice. * - * @return float + * @return float Base grand total. */ public function getBaseGrandTotal(); /** - * Returns base_hidden_tax_amount + * Gets the base hidden tax amount for the invoice. * - * @return float + * @return float Base hidden tax amount. */ public function getBaseHiddenTaxAmount(); /** - * Returns base_shipping_amount + * Gets the base shipping amount for the invoice. * - * @return float + * @return float Base shipping amount. */ public function getBaseShippingAmount(); /** - * Returns base_shipping_hidden_tax_amnt + * Gets the base shipping hidden tax amount for the invoice. * - * @return float + * @return float Base shipping hidden tax amount. */ public function getBaseShippingHiddenTaxAmnt(); /** - * Returns base_shipping_incl_tax + * Gets the base shipping including tax for the invoice. * - * @return float + * @return float Base shipping including tax. */ public function getBaseShippingInclTax(); /** - * Returns base_shipping_tax_amount + * Gets the base shipping tax amount for the invoice. * - * @return float + * @return float Base shipping tax amount. */ public function getBaseShippingTaxAmount(); /** - * Returns base_subtotal + * Gets the base subtotal for the invoice. * - * @return float + * @return float Base subtotal. */ public function getBaseSubtotal(); /** - * Returns base_subtotal_incl_tax + * Gets the base subtotal including tax for the invoice. * - * @return float + * @return float Base subtotal including tax. */ public function getBaseSubtotalInclTax(); /** - * Returns base_tax_amount + * Gets the base tax amount for the invoice. * - * @return float + * @return float Base tax amount. */ public function getBaseTaxAmount(); /** - * Returns base_total_refunded + * Gets the base total refunded for the invoice. * - * @return float + * @return float Base total refunded. */ public function getBaseTotalRefunded(); /** - * Returns base_to_global_rate + * Gets the base-to-global rate for the invoice. * - * @return float + * @return float Base-to-global rate. */ public function getBaseToGlobalRate(); /** - * Returns base_to_order_rate + * Gets the base-to-order rate for the invoice. * - * @return float + * @return float Base-to-order rate. */ public function getBaseToOrderRate(); /** - * Returns billing_address_id + * Gets the billing address ID for the invoice. * - * @return int + * @return int Billing address ID. */ public function getBillingAddressId(); /** - * Returns can_void_flag + * Gets the can void flag value for the invoice. * - * @return int + * @return int Can void flag value. */ public function getCanVoidFlag(); /** - * Returns created_at + * Gets the created-at timestamp for the invoice. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns discount_amount + * Gets the discount amount for the invoice. * - * @return float + * @return float Discount amount. */ public function getDiscountAmount(); /** - * Returns discount_description + * Gets the discount description for the invoice. * - * @return string + * @return string Discount description. */ public function getDiscountDescription(); /** - * Returns email_sent + * Gets the email-sent flag value for the invoice. * - * @return int + * @return int Email-sent flag value. */ public function getEmailSent(); /** - * Returns entity_id + * Gets the ID for the invoice. * - * @return int + * @return int Invoice ID. */ public function getEntityId(); /** - * Returns global_currency_code + * Gets the global currency code for the invoice. * - * @return string + * @return string Global currency code. */ public function getGlobalCurrencyCode(); /** - * Returns grand_total + * Gets the grand total for the invoice. * - * @return float + * @return float Grand total. */ public function getGrandTotal(); /** - * Returns hidden_tax_amount + * Gets the hidden tax amount for the invoice. * - * @return float + * @return float Hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns increment_id + * Gets the increment ID for the invoice. * - * @return string + * @return string Increment ID. */ public function getIncrementId(); /** - * Returns is_used_for_refund + * Gets the is-used-for-refund flag value for the invoice. * - * @return int + * @return int Is-used-for-refund flag value. */ public function getIsUsedForRefund(); /** - * Returns order_currency_code + * Gets the order currency code for the invoice. * - * @return string + * @return string Order currency code. */ public function getOrderCurrencyCode(); /** - * Returns order_id + * Gets the order ID for the invoice. * - * @return int + * @return int Order ID. */ public function getOrderId(); /** - * Returns shipping_address_id + * Gets the shipping address ID for the invoice. * - * @return int + * @return int Shipping address ID. */ public function getShippingAddressId(); /** - * Returns shipping_amount + * Gets the shipping amount for the invoice. * - * @return float + * @return float Shipping amount. */ public function getShippingAmount(); /** - * Returns shipping_hidden_tax_amount + * Gets the shipping hidden tax amount for the invoice. * - * @return float + * @return float Shipping hidden tax amount. */ public function getShippingHiddenTaxAmount(); /** - * Returns shipping_incl_tax + * Gets the shipping including tax for the invoice. * - * @return float + * @return float Shipping including tax. */ public function getShippingInclTax(); /** - * Returns shipping_tax_amount + * Gets the shipping tax amount for the invoice. * - * @return float + * @return float Shipping tax amount. */ public function getShippingTaxAmount(); /** - * Returns state + * Gets the state for the invoice. * - * @return int + * @return int State. */ public function getState(); /** - * Returns store_currency_code + * Gets the store currency code for the invoice. * - * @return string + * @return string Store currency code. */ public function getStoreCurrencyCode(); /** - * Returns store_id + * Gets the store ID for the invoice. * - * @return int + * @return int Store ID. */ public function getStoreId(); /** - * Returns store_to_base_rate + * Gets the store-to-base rate for the invoice. * - * @return float + * @return float Store-to-base rate. */ public function getStoreToBaseRate(); /** - * Returns store_to_order_rate + * Gets the store-to-order rate for the invoice. * - * @return float + * @return float Store-to-order rate. */ public function getStoreToOrderRate(); /** - * Returns subtotal + * Gets the subtotal for the invoice. * - * @return float + * @return float Subtotal. */ public function getSubtotal(); /** - * Returns subtotal_incl_tax + * Gets the subtotal including tax for the invoice. * - * @return float + * @return float Subtotal including tax. */ public function getSubtotalInclTax(); /** - * Returns tax_amount + * Gets the tax amount for the invoice. * - * @return float + * @return float Tax amount. */ public function getTaxAmount(); /** - * Returns total_qty + * Gets the total quantity for the invoice. * - * @return float + * @return float Total quantity. */ public function getTotalQty(); /** - * Returns transaction_id + * Gets the transaction ID for the invoice. * - * @return string + * @return string Transaction ID. */ public function getTransactionId(); /** - * Returns updated_at + * Gets the updated-at timestamp for the invoice. * - * @return string + * @return string Updated-at timestamp. */ public function getUpdatedAt(); /** - * Returns invoice items + * Gets the items in the invoice. * - * @return \Magento\Sales\Api\Data\InvoiceItemInterface[] + * @return \Magento\Sales\Api\Data\InvoiceItemInterface[] Array of invoice items. */ public function getItems(); /** - * Return invoice comments + * Gets the comments, if any, for the invoice. * - * @return \Magento\Sales\Api\Data\InvoiceCommentInterface[]|null + * @return \Magento\Sales\Api\Data\InvoiceCommentInterface[]|null Array of any invoice comments. Otherwise, null. */ public function getComments(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php index 3b8a0e054e172..74364347d4393 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php @@ -5,203 +5,277 @@ namespace Magento\Sales\Api\Data; /** - * Interface InvoiceItemInterface + * Invoice item interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice. */ interface InvoiceItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Base price. + */ const BASE_PRICE = 'base_price'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Base row total. + */ const BASE_ROW_TOTAL = 'base_row_total'; + /* + * Discount amount. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Row total. + */ const ROW_TOTAL = 'row_total'; + /* + * Base discount amount. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Price including tax. + */ const PRICE_INCL_TAX = 'price_incl_tax'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Base price including tax. + */ const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'; + /* + * Quantity. + */ const QTY = 'qty'; + /* + * Base cost. + */ const BASE_COST = 'base_cost'; + /* + * Price. + */ const PRICE = 'price'; + /* + * Base row total including tax. + */ const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'; + /* + * Row total including tax. + */ const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'; + /* + * Product ID. + */ const PRODUCT_ID = 'product_id'; + /* + * Order item ID. + */ const ORDER_ITEM_ID = 'order_item_id'; + /* + * Additional data. + */ const ADDITIONAL_DATA = 'additional_data'; + /* + * Description. + */ const DESCRIPTION = 'description'; + /* + * SKU. + */ const SKU = 'sku'; + /* + * Name. + */ const NAME = 'name'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; /** - * Returns additional_data + * Gets the additional data for the invoice item. * - * @return string + * @return string Additional data. */ public function getAdditionalData(); /** - * Returns base_cost + * Gets the base cost for the invoice item. * - * @return float + * @return float Base cost. */ public function getBaseCost(); /** - * Returns base_discount_amount + * Gets the base discount amount for the invoice item. * - * @return float + * @return float Base discount amount. */ public function getBaseDiscountAmount(); /** - * Returns base_hidden_tax_amount + * Gets the base hidden tax amount for the invoice item. * - * @return float + * @return float Base hidden tax amount. */ public function getBaseHiddenTaxAmount(); /** - * Returns base_price + * Gets the base price for the invoice item. * - * @return float + * @return float Base price. */ public function getBasePrice(); /** - * Returns base_price_incl_tax + * Gets the base price including tax for the invoice item. * - * @return float + * @return float Base price including tax. */ public function getBasePriceInclTax(); /** - * Returns base_row_total + * Gets the base row total for the invoice item. * - * @return float + * @return float Base row total. */ public function getBaseRowTotal(); /** - * Returns base_row_total_incl_tax + * Gets the base row total including tax for the invoice item. * - * @return float + * @return float Base row total including tax. */ public function getBaseRowTotalInclTax(); /** - * Returns base_tax_amount + * Gets the base tax amount for the invoice item. * - * @return float + * @return float Base tax amount. */ public function getBaseTaxAmount(); /** - * Returns description + * Gets the description for the invoice item. * - * @return string + * @return string Description. */ public function getDescription(); /** - * Returns discount_amount + * Gets the discount amount for the invoice item. * - * @return float + * @return float Discount amount. */ public function getDiscountAmount(); /** - * Returns entity_id + * Gets the ID for the invoice item. * - * @return int + * @return int Invoice item ID. */ public function getEntityId(); /** - * Returns hidden_tax_amount + * Gets the hidden tax amount for the invoice item. * - * @return float + * @return float Hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns name + * Gets the name for the invoice item. * - * @return string + * @return string Name. */ public function getName(); /** - * Returns order_item_id + * Gets the order item ID for the invoice item. * - * @return int + * @return int Order item ID. */ public function getOrderItemId(); /** - * Returns parent_id + * Gets the parent ID for the invoice item. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns price + * Gets the price for the invoice item. * - * @return float + * @return float Price. */ public function getPrice(); /** - * Returns price_incl_tax + * Gets the price including tax for the invoice item. * - * @return float + * @return float Price including tax. */ public function getPriceInclTax(); /** - * Returns product_id + * Gets the product ID for the invoice item. * - * @return int + * @return int Product ID. */ public function getProductId(); /** - * Returns qty + * Gets the quantity for the invoice item. * - * @return float + * @return float Quantity. */ public function getQty(); /** - * Returns row_total + * Gets the row total for the invoice item. * - * @return float + * @return float Row total. */ public function getRowTotal(); /** - * Returns row_total_incl_tax + * Gets the row total including tax for the invoice item. * - * @return float + * @return float Row total including tax. */ public function getRowTotalInclTax(); /** - * Returns sku + * Gets the SKU for the invoice item. * - * @return string + * @return string SKU. */ public function getSku(); /** - * Returns tax_amount + * Gets the tax amount for the invoice item. * - * @return float + * @return float Tax amount. */ public function getTaxAmount(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceItemSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceItemSearchResultInterface.php index 6b0acc35a51a5..1d5e7a845f395 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceItemSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceItemSearchResultInterface.php @@ -2,18 +2,19 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface InvoiceItemSearchResultInterface + * Invoice item search result interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice. */ interface InvoiceItemSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\InvoiceItemInterface[] + * @return \Magento\Sales\Api\Data\InvoiceItemInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/InvoiceSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceSearchResultInterface.php index 6f7763ac68ca7..7001bd9a435cd 100644 --- a/app/code/Magento/Sales/Api/Data/InvoiceSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/InvoiceSearchResultInterface.php @@ -2,18 +2,19 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface InvoiceSearchResultInterface + * Invoice search result interface. + * + * An invoice is a record of the receipt of payment for an order. */ interface InvoiceSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\InvoiceInterface[] + * @return \Magento\Sales\Api\Data\InvoiceInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderAddressInterface.php b/app/code/Magento/Sales/Api/Data/OrderAddressInterface.php index d4f61da3b0000..9507863be9b45 100644 --- a/app/code/Magento/Sales/Api/Data/OrderAddressInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderAddressInterface.php @@ -5,216 +5,298 @@ namespace Magento\Sales\Api\Data; /** - * Interface OrderAddressInterface + * Order address interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderAddressInterface extends \Magento\Framework\Api\ExtensibleDataInterface { + /* + * Entity ID. + */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Customer address ID. + */ const CUSTOMER_ADDRESS_ID = 'customer_address_id'; + /* + * Quote address ID. + */ const QUOTE_ADDRESS_ID = 'quote_address_id'; + /* + * Region ID. + */ const REGION_ID = 'region_id'; - const CUSTOMER_ID = 'customer_id'; + /* + * Customer ID. + */ + const CUSTOMER_ID = 'customer_id'; + /* + * Fax. + */ const FAX = 'fax'; + /* + * Region. + */ const REGION = 'region'; + /* + * Postal code. + */ const POSTCODE = 'postcode'; + /* + * Last name. + */ const LASTNAME = 'lastname'; + /* + * Street. + */ const STREET = 'street'; + /* + * City. + */ const CITY = 'city'; + /* + * Email address. + */ const EMAIL = 'email'; + /* + * Telephone number. + */ const TELEPHONE = 'telephone'; + /* + * Country ID. + */ const COUNTRY_ID = 'country_id'; + /* + * First name. + */ const FIRSTNAME = 'firstname'; + /* + * Address type. + */ const ADDRESS_TYPE = 'address_type'; + /* + * Prefix. + */ const PREFIX = 'prefix'; + /* + * Middle name. + */ const MIDDLENAME = 'middlename'; + /* + * Suffix. + */ const SUFFIX = 'suffix'; + /* + * Company. + */ const COMPANY = 'company'; + /* + * Value-added tax (VAT) ID. + */ const VAT_ID = 'vat_id'; + /* + * VAT-is-valid flag. + */ const VAT_IS_VALID = 'vat_is_valid'; + /* + * VAT request ID. + */ const VAT_REQUEST_ID = 'vat_request_id'; + /* + * VAT request date. + */ const VAT_REQUEST_DATE = 'vat_request_date'; + /* + * VAT-request-success flag. + */ const VAT_REQUEST_SUCCESS = 'vat_request_success'; /** - * Returns address_type + * Gets the address type for the order address. * - * @return string + * @return string Address type. */ public function getAddressType(); /** - * Returns city + * Gets the city for the order address. * - * @return string + * @return string City. */ public function getCity(); /** - * Returns company + * Gets the company for the order address. * - * @return string + * @return string Company. */ public function getCompany(); /** - * Returns country_id + * Gets the country ID for the order address. * - * @return string + * @return string Country ID. */ public function getCountryId(); /** - * Returns customer_address_id + * Gets the country address ID for the order address. * - * @return int + * @return int Country address ID. */ public function getCustomerAddressId(); /** - * Returns customer_id + * Gets the customer ID for the order address. * - * @return int + * @return int Customer ID. */ public function getCustomerId(); /** - * Returns email + * Gets the email address for the order address. * - * @return string + * @return string Email address. */ public function getEmail(); /** - * Returns entity_id + * Gets the ID for the order address. * - * @return int + * @return int Order address ID. */ public function getEntityId(); /** - * Returns fax + * Gets the fax number for the order address. * - * @return string + * @return string Fax number. */ public function getFax(); /** - * Returns firstname + * Gets the first name for the order address. * - * @return string + * @return string First name. */ public function getFirstname(); /** - * Returns lastname + * Gets the last name for the order address. * - * @return string + * @return string Last name. */ public function getLastname(); /** - * Returns middlename + * Gets the middle name for the order address. * - * @return string + * @return string Middle name. */ public function getMiddlename(); /** - * Returns parent_id + * Gets the parent ID for the order address. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns postcode + * Gets the postal code for the order address. * - * @return string + * @return string Postal code. */ public function getPostcode(); /** - * Returns prefix + * Gets the prefix for the order address. * - * @return string + * @return string Prefix. */ public function getPrefix(); /** - * Returns quote_address_id + * Gets the quote address ID for the order address. * - * @return int + * @return int Quote address ID. */ public function getQuoteAddressId(); /** - * Returns region + * Gets the region for the order address. * - * @return string + * @return string Region. */ public function getRegion(); /** - * Returns region_id + * Gets the region ID for the order address. * - * @return int + * @return int Region ID. */ public function getRegionId(); /** - * Get street + * Gets the street values, if any, for the order address. * - * @return string[]|null + * @return string[]|null Array of any street values. Otherwise, null. */ public function getStreet(); /** - * Returns suffix + * Gets the suffix for the order address. * - * @return string + * @return string Suffix. */ public function getSuffix(); /** - * Returns telephone + * Gets the telephone number for the order address. * - * @return string + * @return string Telephone number. */ public function getTelephone(); /** - * Returns vat_id + * Gets the VAT ID for the order address. * - * @return string + * @return string VAT ID. */ public function getVatId(); /** - * Returns vat_is_valid + * Gets the VAT-is-valid flag value for the order address. * - * @return int + * @return int VAT-is-valid flag value. */ public function getVatIsValid(); /** - * Returns vat_request_date + * Gets the VAT request date for the order address. * - * @return string + * @return string VAT request date. */ public function getVatRequestDate(); /** - * Returns vat_request_id + * Gets the VAT request ID for the order address. * - * @return string + * @return string VAT request ID. */ public function getVatRequestId(); /** - * Returns vat_request_success + * Gets the VAT-request-success flag value for the order address. * - * @return int + * @return int VAT-request-success flag value. */ public function getVatRequestSuccess(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderAddressSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/OrderAddressSearchResultInterface.php index 25fb8dfb6f4bf..32cb43e85c4f5 100644 --- a/app/code/Magento/Sales/Api/Data/OrderAddressSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderAddressSearchResultInterface.php @@ -2,18 +2,21 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface OrderAddressSearchResultInterface + * Order address search result interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderAddressSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\OrderAddressInterface[] + * @return \Magento\Sales\Api\Data\OrderAddressInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderInterface.php b/app/code/Magento/Sales/Api/Data/OrderInterface.php index deb99f11b8b6c..2a7204cd1d063 100644 --- a/app/code/Magento/Sales/Api/Data/OrderInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderInterface.php @@ -5,1119 +5,1558 @@ namespace Magento\Sales\Api\Data; /** - * Interface OrderInterface + * Order interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * State. + */ const STATE = 'state'; + /* + * Status. + */ const STATUS = 'status'; + /* + * Coupon code. + */ const COUPON_CODE = 'coupon_code'; + /* + * Protect code. + */ const PROTECT_CODE = 'protect_code'; + /* + * Shipping description. + */ const SHIPPING_DESCRIPTION = 'shipping_description'; + /* + * Is-virtual flag. + */ const IS_VIRTUAL = 'is_virtual'; + /* + * Store ID. + */ const STORE_ID = 'store_id'; + /* + * Customer ID. + */ const CUSTOMER_ID = 'customer_id'; + /* + * Base discount amount. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Base discount canceled. + */ const BASE_DISCOUNT_CANCELED = 'base_discount_canceled'; + /* + * Base discount invoiced. + */ const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'; + /* + * Base discount refunded. + */ const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'; + /* + * Base grand total. + */ const BASE_GRAND_TOTAL = 'base_grand_total'; + /* + * Base shipping amount. + */ const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'; + /* + * Base shipping canceled. + */ const BASE_SHIPPING_CANCELED = 'base_shipping_canceled'; + /* + * Base shipping invoiced. + */ const BASE_SHIPPING_INVOICED = 'base_shipping_invoiced'; + /* + * Base shipping refunded. + */ const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded'; + /* + * Base shipping tax amount. + */ const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'; + /* + * Base shipping tax refunded. + */ const BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded'; + /* + * Base subtotal. + */ const BASE_SUBTOTAL = 'base_subtotal'; + /* + * Base subtotal canceled. + */ const BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled'; + /* + * Base subtotal invoiced. + */ const BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced'; + /* + * Base subtotal refunded. + */ const BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Base tax canceled. + */ const BASE_TAX_CANCELED = 'base_tax_canceled'; + /* + * Base tax invoiced. + */ const BASE_TAX_INVOICED = 'base_tax_invoiced'; + /* + * Base tax refunded. + */ const BASE_TAX_REFUNDED = 'base_tax_refunded'; + /* + * Base-to-global rate. + */ const BASE_TO_GLOBAL_RATE = 'base_to_global_rate'; + /* + * Base-to-order rate. + */ const BASE_TO_ORDER_RATE = 'base_to_order_rate'; + /* + * Base total canceled. + */ const BASE_TOTAL_CANCELED = 'base_total_canceled'; + /* + * Base total invoiced. + */ const BASE_TOTAL_INVOICED = 'base_total_invoiced'; + /* + * Base total invoiced cost. + */ const BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost'; + /* + * Base total offline refunded. + */ const BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded'; + /* + * Base total online refunded. + */ const BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded'; + /* + * Base total paid. + */ const BASE_TOTAL_PAID = 'base_total_paid'; + /* + * Base total quantity ordered. + */ const BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered'; + /* + * Base total refunded. + */ const BASE_TOTAL_REFUNDED = 'base_total_refunded'; + /* + * Discount amount. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Discount canceled. + */ const DISCOUNT_CANCELED = 'discount_canceled'; + /* + * Discount invoiced. + */ const DISCOUNT_INVOICED = 'discount_invoiced'; + /* + * Discount refunded. + */ const DISCOUNT_REFUNDED = 'discount_refunded'; + /* + * Grand total. + */ const GRAND_TOTAL = 'grand_total'; + /* + * Shipping amount. + */ const SHIPPING_AMOUNT = 'shipping_amount'; + /* + * Shipping canceled. + */ const SHIPPING_CANCELED = 'shipping_canceled'; + /* + * Shipping invoiced. + */ const SHIPPING_INVOICED = 'shipping_invoiced'; + /* + * Shipping refunded. + */ const SHIPPING_REFUNDED = 'shipping_refunded'; + /* + * Shipping tax amount. + */ const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'; + /* + * Shipping tax refunded. + */ const SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded'; + /* + * Store-to-base rate. + */ const STORE_TO_BASE_RATE = 'store_to_base_rate'; + /* + * Store-to-order rate. + */ const STORE_TO_ORDER_RATE = 'store_to_order_rate'; + /* + * Subtotal. + */ const SUBTOTAL = 'subtotal'; + /* + * Subtotal canceled. + */ const SUBTOTAL_CANCELED = 'subtotal_canceled'; + /* + * Subtotal invoiced. + */ const SUBTOTAL_INVOICED = 'subtotal_invoiced'; + /* + * Subtotal refunded. + */ const SUBTOTAL_REFUNDED = 'subtotal_refunded'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Tax canceled. + */ const TAX_CANCELED = 'tax_canceled'; + /* + * Tax invoiced. + */ const TAX_INVOICED = 'tax_invoiced'; + /* + * Tax refunded. + */ const TAX_REFUNDED = 'tax_refunded'; + /* + * Total canceled. + */ const TOTAL_CANCELED = 'total_canceled'; + /* + * Total invoiced. + */ const TOTAL_INVOICED = 'total_invoiced'; + /* + * Total refunded offline. + */ const TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded'; + /* + * Total refunded online. + */ const TOTAL_ONLINE_REFUNDED = 'total_online_refunded'; + /* + * Total paid. + */ const TOTAL_PAID = 'total_paid'; + /* + * Total quantity ordered. + */ const TOTAL_QTY_ORDERED = 'total_qty_ordered'; + /* + * Total refunded. + */ const TOTAL_REFUNDED = 'total_refunded'; + /* + * Can-ship-partially flag. + */ const CAN_SHIP_PARTIALLY = 'can_ship_partially'; + /* + * Can-ship-item-partially flag. + */ const CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item'; + /* + * Customer-is-guest flag. + */ const CUSTOMER_IS_GUEST = 'customer_is_guest'; + /* + * Customer-note-notify flag. + */ const CUSTOMER_NOTE_NOTIFY = 'customer_note_notify'; + /* + * Billing address ID. + */ const BILLING_ADDRESS_ID = 'billing_address_id'; + /* + * Customer group ID. + */ const CUSTOMER_GROUP_ID = 'customer_group_id'; + /* + * Edit increment value. + */ const EDIT_INCREMENT = 'edit_increment'; + /* + * Email-sent flag. + */ const EMAIL_SENT = 'email_sent'; + /* + * Forced-shipment-with-invoice flag. + */ const FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice'; + /* + * Payment authorization expiration date. + */ const PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration'; + /* + * Quote address ID. + */ const QUOTE_ADDRESS_ID = 'quote_address_id'; + /* + * Quote ID. + */ const QUOTE_ID = 'quote_id'; + /* + * Shipping address ID. + */ const SHIPPING_ADDRESS_ID = 'shipping_address_id'; + /* + * Negative adjustment. + */ const ADJUSTMENT_NEGATIVE = 'adjustment_negative'; + /* + * Positive adjustment. + */ const ADJUSTMENT_POSITIVE = 'adjustment_positive'; + /* + * Base negative adjustment. + */ const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'; + /* + * Base positive adjustment. + */ const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'; + /* + * Base shipping discount amount. + */ const BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount'; + /* + * Base subtotal including tax. + */ const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'; + /* + * Base total due. + */ const BASE_TOTAL_DUE = 'base_total_due'; + /* + * Payment authorization amount. + */ const PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount'; + /* + * Shipping discount amount. + */ const SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount'; + /* + * Subtotal including tax. + */ const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'; + /* + * Total due. + */ const TOTAL_DUE = 'total_due'; + /* + * Weight. + */ const WEIGHT = 'weight'; + /* + * Customer date-of-birth (DOB). + */ const CUSTOMER_DOB = 'customer_dob'; + /* + * Increment ID. + */ const INCREMENT_ID = 'increment_id'; + /* + * Applied rule IDs. + */ const APPLIED_RULE_IDS = 'applied_rule_ids'; + /* + * Base currency code. + */ const BASE_CURRENCY_CODE = 'base_currency_code'; + /* + * Customer email address. + */ const CUSTOMER_EMAIL = 'customer_email'; + /* + * Customer first name. + */ const CUSTOMER_FIRSTNAME = 'customer_firstname'; + /* + * Customer last name. + */ const CUSTOMER_LASTNAME = 'customer_lastname'; + /* + * Customer middle name. + */ const CUSTOMER_MIDDLENAME = 'customer_middlename'; + /* + * Customer prefix. + */ const CUSTOMER_PREFIX = 'customer_prefix'; + /* + * Customer suffix. + */ const CUSTOMER_SUFFIX = 'customer_suffix'; + /* + * Customer value-added tax (VAT). + */ const CUSTOMER_TAXVAT = 'customer_taxvat'; + /* + * Discount description. + */ const DISCOUNT_DESCRIPTION = 'discount_description'; + /* + * External customer ID. + */ const EXT_CUSTOMER_ID = 'ext_customer_id'; + /* + * External order ID. + */ const EXT_ORDER_ID = 'ext_order_id'; + /* + * Global currency code. + */ const GLOBAL_CURRENCY_CODE = 'global_currency_code'; + /* + * Hold before state. + */ const HOLD_BEFORE_STATE = 'hold_before_state'; + /* + * Hold before status. + */ const HOLD_BEFORE_STATUS = 'hold_before_status'; + /* + * Order currency code. + */ const ORDER_CURRENCY_CODE = 'order_currency_code'; + /* + * Original increment ID. + */ const ORIGINAL_INCREMENT_ID = 'original_increment_id'; + /* + * Relation child ID. + */ const RELATION_CHILD_ID = 'relation_child_id'; + /* + * Relation child real ID. + */ const RELATION_CHILD_REAL_ID = 'relation_child_real_id'; + /* + * Relation parent ID. + */ const RELATION_PARENT_ID = 'relation_parent_id'; + /* + * Relation parent real ID. + */ const RELATION_PARENT_REAL_ID = 'relation_parent_real_id'; + /* + * Remote IP address. + */ const REMOTE_IP = 'remote_ip'; + /* + * Shipping method. + */ const SHIPPING_METHOD = 'shipping_method'; + /* + * Store currency code. + */ const STORE_CURRENCY_CODE = 'store_currency_code'; + /* + * Store name. + */ const STORE_NAME = 'store_name'; + /* + * X-Forwarded-For HTTP header field. + */ const X_FORWARDED_FOR = 'x_forwarded_for'; + /* + * Customer note. + */ const CUSTOMER_NOTE = 'customer_note'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; + /* + * Total item count. + */ const TOTAL_ITEM_COUNT = 'total_item_count'; + /* + * Customer gender. + */ const CUSTOMER_GENDER = 'customer_gender'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; + /* + * Shipping hidden tax amount. + */ const SHIPPING_HIDDEN_TAX_AMOUNT = 'shipping_hidden_tax_amount'; + /* + * Base shipping hidden tax amount. + */ const BASE_SHIPPING_HIDDEN_TAX_AMNT = 'base_shipping_hidden_tax_amnt'; + /* + * Hidden tax invoiced. + */ const HIDDEN_TAX_INVOICED = 'hidden_tax_invoiced'; + /* + * Base hidden tax invoiced. + */ const BASE_HIDDEN_TAX_INVOICED = 'base_hidden_tax_invoiced'; + /* + * Hidden tax refunded. + */ const HIDDEN_TAX_REFUNDED = 'hidden_tax_refunded'; + /* + * Base hidden tax refunded. + */ const BASE_HIDDEN_TAX_REFUNDED = 'base_hidden_tax_refunded'; + /* + * Shipping including tax. + */ const SHIPPING_INCL_TAX = 'shipping_incl_tax'; + /* + * Base shipping including tax. + */ const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'; + /* + * Items. + */ const ITEMS = 'items'; + /* + * Billing address. + */ const BILLING_ADDRESS = 'billing_address'; + /* + * Shipping address. + */ const SHIPPING_ADDRESS = 'shipping_address'; + /* + * Payments. + */ const PAYMENTS = 'payments'; + /* + * Addresses. + */ const ADDRESSES = 'addresses'; + /* + * Status histories. + */ const STATUS_HISTORIES = 'status_histories'; /** - * Returns adjustment_negative + * Gets the negative adjustment value for the order. * - * @return float + * @return float Negative adjustment value. */ public function getAdjustmentNegative(); /** - * Returns adjustment_positive + * Gets the positive adjustment value for the order. * - * @return float + * @return float Positive adjustment value. */ public function getAdjustmentPositive(); /** - * Returns applied_rule_ids + * Gets the applied rule IDs for the order. * - * @return string + * @return string Applied rule IDs. */ public function getAppliedRuleIds(); /** - * Returns base_adjustment_negative + * Gets the base negative adjustment value for the order. * - * @return float + * @return float Base negative adjustment value. */ public function getBaseAdjustmentNegative(); /** - * Returns base_adjustment_positive + * Gets the base positive adjustment value for the order. * - * @return float + * @return float Base positive adjustment value. */ public function getBaseAdjustmentPositive(); /** - * Returns base_currency_code + * Gets the base currency code for the order. * - * @return string + * @return string Base currency code. */ public function getBaseCurrencyCode(); /** - * Returns base_discount_amount + * Gets the base discount amount for the order. * - * @return float + * @return float Base discount amount. */ public function getBaseDiscountAmount(); /** - * Returns base_discount_canceled + * Gets the base discount canceled for the order. * - * @return float + * @return float Base discount canceled. */ public function getBaseDiscountCanceled(); /** - * Returns base_discount_invoiced + * Gets the base discount invoiced amount for the order. * - * @return float + * @return float Base discount invoiced. */ public function getBaseDiscountInvoiced(); /** - * Returns base_discount_refunded + * Gets the base discount refunded amount for the order. * - * @return float + * @return float Base discount refunded. */ public function getBaseDiscountRefunded(); /** - * Returns base_grand_total + * Gets the base grand total for the order. * - * @return float + * @return float Base grand total. */ public function getBaseGrandTotal(); /** - * Returns base_hidden_tax_amount + * Gets the base hidden tax amount for the order. * - * @return float + * @return float Base hidden tax amount. */ public function getBaseHiddenTaxAmount(); /** - * Returns base_hidden_tax_invoiced + * Gets the base hidden tax invoiced amount for the order. * - * @return float + * @return float Base hidden tax invoiced. */ public function getBaseHiddenTaxInvoiced(); /** - * Returns base_hidden_tax_refunded + * Gets the base hidden tax refunded amount for the order. * - * @return float + * @return float Base hidden tax refunded. */ public function getBaseHiddenTaxRefunded(); /** - * Returns base_shipping_amount + * Gets the base shipping amount for the order. * - * @return float + * @return float Base shipping amount. */ public function getBaseShippingAmount(); /** - * Returns base_shipping_canceled + * Gets the base shipping canceled for the order. * - * @return float + * @return float Base shipping canceled. */ public function getBaseShippingCanceled(); /** - * Returns base_shipping_discount_amount + * Gets the base shipping discount amount for the order. * - * @return float + * @return float Base shipping discount amount. */ public function getBaseShippingDiscountAmount(); /** - * Returns base_shipping_hidden_tax_amnt + * Gets the base shipping hidden tax amount for the order. * - * @return float + * @return float Base shipping hidden tax amount. */ public function getBaseShippingHiddenTaxAmnt(); /** - * Returns base_shipping_incl_tax + * Gets the base shipping including tax for the order. * - * @return float + * @return float Base shipping including tax. */ public function getBaseShippingInclTax(); /** - * Returns base_shipping_invoiced + * Gets the base shipping invoiced amount for the order. * - * @return float + * @return float Base shipping invoiced. */ public function getBaseShippingInvoiced(); /** - * Returns base_shipping_refunded + * Gets the base shipping refunded amount for the order. * - * @return float + * @return float Base shipping refunded. */ public function getBaseShippingRefunded(); /** - * Returns base_shipping_tax_amount + * Gets the base shipping tax amount for the order. * - * @return float + * @return float Base shipping tax amount. */ public function getBaseShippingTaxAmount(); /** - * Returns base_shipping_tax_refunded + * Gets the base shipping tax refunded amount for the order. * - * @return float + * @return float Base shipping tax refunded. */ public function getBaseShippingTaxRefunded(); /** - * Returns base_subtotal + * Gets the base subtotal for the order. * - * @return float + * @return float Base subtotal. */ public function getBaseSubtotal(); /** - * Returns base_subtotal_canceled + * Gets the base subtotal canceled for the order. * - * @return float + * @return float Base subtotal canceled. */ public function getBaseSubtotalCanceled(); /** - * Returns base_subtotal_incl_tax + * Gets the base subtotal including tax for the order. * - * @return float + * @return float Base subtotal including tax. */ public function getBaseSubtotalInclTax(); /** - * Returns base_subtotal_invoiced + * Gets the base subtotal invoiced amount for the order. * - * @return float + * @return float Base subtotal invoiced. */ public function getBaseSubtotalInvoiced(); /** - * Returns base_subtotal_refunded + * Gets the base subtotal refunded amount for the order. * - * @return float + * @return float Base subtotal refunded. */ public function getBaseSubtotalRefunded(); /** - * Returns base_tax_amount + * Gets the base tax amount for the order. * - * @return float + * @return float Base tax amount. */ public function getBaseTaxAmount(); /** - * Returns base_tax_canceled + * Gets the base tax canceled for the order. * - * @return float + * @return float Base tax canceled. */ public function getBaseTaxCanceled(); /** - * Returns base_tax_invoiced + * Gets the base tax invoiced amount for the order. * - * @return float + * @return float Base tax invoiced. */ public function getBaseTaxInvoiced(); /** - * Returns base_tax_refunded + * Gets the base tax refunded amount for the order. * - * @return float + * @return float Base tax refunded. */ public function getBaseTaxRefunded(); /** - * Returns base_total_canceled + * Gets the base total canceled for the order. * - * @return float + * @return float Base total canceled. */ public function getBaseTotalCanceled(); /** - * Returns base_total_due + * Gets the base total due for the order. * - * @return float + * @return float Base total due. */ public function getBaseTotalDue(); /** - * Returns base_total_invoiced + * Gets the base total invoiced amount for the order. * - * @return float + * @return float Base total invoiced. */ public function getBaseTotalInvoiced(); /** - * Returns base_total_invoiced_cost + * Gets the base total invoiced cost for the order. * - * @return float + * @return float Base total invoiced cost. */ public function getBaseTotalInvoicedCost(); /** - * Returns base_total_offline_refunded + * Gets the base total offline refunded amount for the order. * - * @return float + * @return float Base total offline refunded. */ public function getBaseTotalOfflineRefunded(); /** - * Returns base_total_online_refunded + * Gets the base total online refunded amount for the order. * - * @return float + * @return float Base total online refunded. */ public function getBaseTotalOnlineRefunded(); /** - * Returns base_total_paid + * Gets the base total paid for the order. * - * @return float + * @return float Base total paid. */ public function getBaseTotalPaid(); /** - * Returns base_total_qty_ordered + * Gets the base total quantity ordered for the order. * - * @return float + * @return float Base total quantity ordered. */ public function getBaseTotalQtyOrdered(); /** - * Returns base_total_refunded + * Gets the base total refunded amount for the order. * - * @return float + * @return float Base total refunded. */ public function getBaseTotalRefunded(); /** - * Returns base_to_global_rate + * Gets the base-to-global rate for the order. * - * @return float + * @return float Base-to-global rate. */ public function getBaseToGlobalRate(); /** - * Returns base_to_order_rate + * Gets the base-to-order rate for the order. * - * @return float + * @return float Base-to-order rate. */ public function getBaseToOrderRate(); /** - * Returns billing_address_id + * Gets the billing address ID for the order. * - * @return int + * @return int Billing address ID. */ public function getBillingAddressId(); /** - * Returns can_ship_partially + * Gets the can-ship-partially flag value for the order. * - * @return int + * @return int Can-ship-partially flag value. */ public function getCanShipPartially(); /** - * Returns can_ship_partially_item + * Gets the can-ship-partially-item flag value for the order. * - * @return int + * @return int Can-ship-partially-item flag value. */ public function getCanShipPartiallyItem(); /** - * Returns coupon_code + * Gets the coupon code for the order. * - * @return string + * @return string Coupon code. */ public function getCouponCode(); /** - * Returns created_at + * Gets the created-at timestamp for the order. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns customer_dob + * Gets the customer date-of-birth (DOB) for the order. * - * @return string + * @return string Customer date-of-birth (DOB). */ public function getCustomerDob(); /** - * Returns customer_email + * Gets the customer email address for the order. * - * @return string + * @return string Customer email address. */ public function getCustomerEmail(); /** - * Returns customer_firstname + * Gets the customer first name for the order. * - * @return string + * @return string Customer first name. */ public function getCustomerFirstname(); /** - * Returns customer_gender + * Gets the customer gender for the order. * - * @return int + * @return int Customer gender. */ public function getCustomerGender(); /** - * Returns customer_group_id + * Gets the customer group ID for the order. * - * @return int + * @return int Customer group ID. */ public function getCustomerGroupId(); /** - * Returns customer_id + * Gets the customer ID for the order. * - * @return int + * @return int Customer ID. */ public function getCustomerId(); /** - * Returns customer_is_guest + * Gets the customer-is-guest flag value for the order. * - * @return int + * @return int Customer-is-guest flag value. */ public function getCustomerIsGuest(); /** - * Returns customer_lastname + * Gets the customer last name for the order. * - * @return string + * @return string Customer last name. */ public function getCustomerLastname(); /** - * Returns customer_middlename + * Gets the customer middle name for the order. * - * @return string + * @return string Customer middle name. */ public function getCustomerMiddlename(); /** - * Returns customer_note + * Gets the customer note for the order. * - * @return string + * @return string Customer note. */ public function getCustomerNote(); /** - * Returns customer_note_notify + * Gets the customer-note-notify flag value for the order. * - * @return int + * @return int Customer-note-notify flag value. */ public function getCustomerNoteNotify(); /** - * Returns customer_prefix + * Gets the customer prefix for the order. * - * @return string + * @return string Customer prefix. */ public function getCustomerPrefix(); /** - * Returns customer_suffix + * Gets the customer suffix for the order. * - * @return string + * @return string Customer suffix. */ public function getCustomerSuffix(); /** - * Returns customer_taxvat + * Gets the customer value-added tax (VAT) for the order. * - * @return string + * @return string Customer value-added tax (VAT). */ public function getCustomerTaxvat(); /** - * Returns discount_amount + * Gets the discount amount for the order. * - * @return float + * @return float Discount amount. */ public function getDiscountAmount(); /** - * Returns discount_canceled + * Gets the discount canceled for the order. * - * @return float + * @return float Discount canceled. */ public function getDiscountCanceled(); /** - * Returns discount_description + * Gets the discount description for the order. * - * @return string + * @return string Discount description. */ public function getDiscountDescription(); /** - * Returns discount_invoiced + * Gets the discount invoiced amount for the order. * - * @return float + * @return float Discount invoiced. */ public function getDiscountInvoiced(); /** - * Returns discount_refunded + * Gets the discount refunded amount for the order. * - * @return float + * @return float Discount refunded amount. */ public function getDiscountRefunded(); /** - * Returns edit_increment + * Gets the edit increment value for the order. * - * @return int + * @return int Edit increment value. */ public function getEditIncrement(); /** - * Returns email_sent + * Gets the email-sent flag value for the order. * - * @return int + * @return int Email-sent flag value. */ public function getEmailSent(); /** - * Returns entity_id + * Gets the ID for the order. * - * @return int + * @return int Order ID. */ public function getEntityId(); /** - * Returns ext_customer_id + * Gets the external customer ID for the order. * - * @return string + * @return string External customer ID. */ public function getExtCustomerId(); /** - * Returns ext_order_id + * Gets the external order ID for the order. * - * @return string + * @return string External order ID. */ public function getExtOrderId(); /** - * Returns forced_shipment_with_invoice + * Gets the forced-shipment-with-invoice flag value for the order. * - * @return int + * @return int Forced-shipment-with-invoice flag value. */ public function getForcedShipmentWithInvoice(); /** - * Returns global_currency_code + * Gets the global currency code for the order. * - * @return string + * @return string Global currency code. */ public function getGlobalCurrencyCode(); /** - * Returns grand_total + * Gets the grand total for the order. * - * @return float + * @return float Grand total. */ public function getGrandTotal(); /** - * Returns hidden_tax_amount + * Gets the hidden tax amount for the order. * - * @return float + * @return float Hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns hidden_tax_invoiced + * Gets the hidden tax invoiced amount for the order. * - * @return float + * @return float Hidden tax invoiced amount. */ public function getHiddenTaxInvoiced(); /** - * Returns hidden_tax_refunded + * Gets the hidden tax refunded amount for the order. * - * @return float + * @return float Hidden tax refunded amount. */ public function getHiddenTaxRefunded(); /** - * Returns hold_before_state + * Gets the hold before state for the order. * - * @return string + * @return string Hold before state. */ public function getHoldBeforeState(); /** - * Returns hold_before_status + * Gets the hold before status for the order. * - * @return string + * @return string Hold before status. */ public function getHoldBeforeStatus(); /** - * Returns increment_id + * Gets the increment ID for the order. * - * @return string + * @return string Increment ID. */ public function getIncrementId(); /** - * Returns is_virtual + * Gets the is-virtual flag value for the order. * - * @return int + * @return int Is-virtual flag value. */ public function getIsVirtual(); /** - * Returns order_currency_code + * Gets the order currency code for the order. * - * @return string + * @return string Order currency code. */ public function getOrderCurrencyCode(); /** - * Returns original_increment_id + * Gets the original increment ID for the order. * - * @return string + * @return string Original increment ID. */ public function getOriginalIncrementId(); /** - * Returns payment_authorization_amount + * Gets the payment authorization amount for the order. * - * @return float + * @return float Payment authorization amount. */ public function getPaymentAuthorizationAmount(); /** - * Returns payment_auth_expiration + * Gets the payment authorization expiration date for the order. * - * @return int + * @return int Payment authorization expiration date. */ public function getPaymentAuthExpiration(); /** - * Returns protect_code + * Gets the protect code for the order. * - * @return string + * @return string Protect code. */ public function getProtectCode(); /** - * Returns quote_address_id + * Gets the quote address ID for the order. * - * @return int + * @return int Quote address ID. */ public function getQuoteAddressId(); /** - * Returns quote_id + * Gets the quote ID for the order. * - * @return int + * @return int Quote ID. */ public function getQuoteId(); /** - * Returns relation_child_id + * Gets the relation child ID for the order. * - * @return string + * @return string Relation child ID. */ public function getRelationChildId(); /** - * Returns relation_child_real_id + * Gets the relation child real ID for the order. * - * @return string + * @return string Relation child real ID. */ public function getRelationChildRealId(); /** - * Returns relation_parent_id + * Gets the relation parent ID for the order. * - * @return string + * @return string Relation parent ID. */ public function getRelationParentId(); /** - * Returns relation_parent_real_id + * Gets the relation parent real ID for the order. * - * @return string + * @return string Relation parent real ID. */ public function getRelationParentRealId(); /** - * Returns remote_ip + * Gets the remote IP address for the order. * - * @return string + * @return string Remote IP address. */ public function getRemoteIp(); /** - * Returns shipping_address_id + * Gets the shipping address ID for the order. * - * @return int + * @return int Shipping address ID. */ public function getShippingAddressId(); /** - * Returns shipping_amount + * Gets the shipping amount for the order. * - * @return float + * @return float Shipping amount. */ public function getShippingAmount(); /** - * Returns shipping_canceled + * Gets the shipping canceled amount for the order. * - * @return float + * @return float Shipping canceled amount. */ public function getShippingCanceled(); /** - * Returns shipping_description + * Gets the shipping description for the order. * - * @return string + * @return string Shipping description. */ public function getShippingDescription(); /** - * Returns shipping_discount_amount + * Gets the shipping discount amount for the order. * - * @return float + * @return float Shipping discount amount. */ public function getShippingDiscountAmount(); /** - * Returns shipping_hidden_tax_amount + * Gets the shipping hidden tax amount for the order. * - * @return float + * @return float Shipping hidden tax amount. */ public function getShippingHiddenTaxAmount(); /** - * Returns shipping_incl_tax + * Gets the shipping including tax amount for the order. * - * @return float + * @return float Shipping including tax amount. */ public function getShippingInclTax(); /** - * Returns shipping_invoiced + * Gets the shipping invoiced amount for the order. * - * @return float + * @return float Shipping invoiced amount. */ public function getShippingInvoiced(); /** - * Returns shipping_method + * Gets the shipping method for the order. * - * @return string + * @return string Shipping method. */ public function getShippingMethod(); /** - * Returns shipping_refunded + * Gets the shipping refunded amount for the order. * - * @return float + * @return float Shipping refunded amount. */ public function getShippingRefunded(); /** - * Returns shipping_tax_amount + * Gets the shipping tax amount for the order. * - * @return float + * @return float Shipping tax amount. */ public function getShippingTaxAmount(); /** - * Returns shipping_tax_refunded + * Gets the shipping tax refunded amount for the order. * - * @return float + * @return float Shipping tax refunded amount. */ public function getShippingTaxRefunded(); /** - * Returns state + * Gets the state for the order. * - * @return string + * @return string State. */ public function getState(); /** - * Returns status + * Gets the status for the order. * - * @return string + * @return string Status. */ public function getStatus(); /** - * Returns store_currency_code + * Gets the store currency code for the order. * - * @return string + * @return string Store currency code. */ public function getStoreCurrencyCode(); /** - * Returns store_id + * Gets the store ID for the order. * - * @return int + * @return int Store ID. */ public function getStoreId(); /** - * Returns store_name + * Gets the store name for the order. * - * @return string + * @return string Store name. */ public function getStoreName(); /** - * Returns store_to_base_rate + * Gets the store-to-base rate for the order. * - * @return float + * @return float Store-to-base rate. */ public function getStoreToBaseRate(); /** - * Returns store_to_order_rate + * Gets the store-to-order rate for the order. * - * @return float + * @return float Store-to-order rate. */ public function getStoreToOrderRate(); /** - * Returns subtotal + * Gets the subtotal for the order. * - * @return float + * @return float Subtotal. */ public function getSubtotal(); /** - * Returns subtotal_canceled + * Gets the subtotal canceled amount for the order. * - * @return float + * @return float Subtotal canceled amount. */ public function getSubtotalCanceled(); /** - * Returns subtotal_incl_tax + * Gets the subtotal including tax amount for the order. * - * @return float + * @return float Subtotal including tax amount. */ public function getSubtotalInclTax(); /** - * Returns subtotal_invoiced + * Gets the subtotal invoiced amount for the order. * - * @return float + * @return float Subtotal invoiced amount. */ public function getSubtotalInvoiced(); /** - * Returns subtotal_refunded + * Gets the subtotal refunded amount for the order. * - * @return float + * @return float Subtotal refunded amount. */ public function getSubtotalRefunded(); /** - * Returns tax_amount + * Gets the tax amount for the order. * - * @return float + * @return float Tax amount. */ public function getTaxAmount(); /** - * Returns tax_canceled + * Gets the tax canceled amount for the order. * - * @return float + * @return float Tax canceled amount. */ public function getTaxCanceled(); /** - * Returns tax_invoiced + * Gets the tax invoiced amount for the order. * - * @return float + * @return float Tax invoiced amount. */ public function getTaxInvoiced(); /** - * Returns tax_refunded + * Gets the tax refunded amount for the order. * - * @return float + * @return float Tax refunded amount. */ public function getTaxRefunded(); /** - * Returns total_canceled + * Gets the total canceled for the order. * - * @return float + * @return float Total canceled. */ public function getTotalCanceled(); /** - * Returns total_due + * Gets the total due for the order. * - * @return float + * @return float Total due. */ public function getTotalDue(); /** - * Returns total_invoiced + * Gets the total invoiced amount for the order. * - * @return float + * @return float Total invoiced amount. */ public function getTotalInvoiced(); /** - * Returns total_item_count + * Gets the total item count for the order. * - * @return int + * @return int Total item count. */ public function getTotalItemCount(); /** - * Returns total_offline_refunded + * Gets the total offline refunded amount for the order. * - * @return float + * @return float Total offline refunded amount. */ public function getTotalOfflineRefunded(); /** - * Returns total_online_refunded + * Gets the total online refunded amount for the order. * - * @return float + * @return float Total online refunded amount. */ public function getTotalOnlineRefunded(); /** - * Returns total_paid + * Gets the total paid for the order. * - * @return float + * @return float Total paid. */ public function getTotalPaid(); /** - * Returns total_qty_ordered + * Gets the total quantity ordered for the order. * - * @return float + * @return float Total quantity ordered. */ public function getTotalQtyOrdered(); /** - * Returns total_refunded + * Gets the total amount refunded amount for the order. * - * @return float + * @return float Total amount refunded. */ public function getTotalRefunded(); /** - * Returns updated_at + * Gets the updated-at timestamp for the order. * - * @return string + * @return string Updated-at timestamp. */ public function getUpdatedAt(); /** - * Returns weight + * Gets the weight for the order. * - * @return float + * @return float Weight. */ public function getWeight(); /** - * Returns x_forwarded_for + * Gets the X-Forwarded-For HTTP header field for the order. + * + * This field identifies the originating IP address of a client + * connecting to a web server through an HTTP proxy or load balancer. * - * @return string + * @return string X-Forwarded-For field value. */ public function getXForwardedFor(); /** - * @return \Magento\Sales\Api\Data\OrderItemInterface[] + * Gets items for the order. + * + * @return \Magento\Sales\Api\Data\OrderItemInterface[] Array of items. */ public function getItems(); /** - * @return \Magento\Sales\Api\Data\OrderAddressInterface|null + * Gets the billing address, if any, for the order. + * + * @return \Magento\Sales\Api\Data\OrderAddressInterface|null Billing address. Otherwise, null. */ public function getBillingAddress(); /** - * @return \Magento\Sales\Api\Data\OrderAddressInterface|null + * Gets the shipping address, if any, for the order. + * + * @return \Magento\Sales\Api\Data\OrderAddressInterface|null Shipping address. Otherwise, null. */ public function getShippingAddress(); /** - * @return \Magento\Sales\Api\Data\OrderPaymentInterface[] + * Gets the payments for the order. + * + * @return \Magento\Sales\Api\Data\OrderPaymentInterface[] Array of payments. */ public function getPayments(); /** - * @return \Magento\Sales\Api\Data\OrderAddressInterface[] + * Gets addresses for the order. + * + * @return \Magento\Sales\Api\Data\OrderAddressInterface[] Array of addresses. */ public function getAddresses(); /** - * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface[] + * Gets status histories for the order. + * + * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface[] Array of status histories. */ public function getStatusHistories(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderItemInterface.php b/app/code/Magento/Sales/Api/Data/OrderItemInterface.php index 30fa2b74033f8..b6885c416c5ee 100644 --- a/app/code/Magento/Sales/Api/Data/OrderItemInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderItemInterface.php @@ -5,763 +5,1049 @@ namespace Magento\Sales\Api\Data; /** - * Interface OrderItemInterface + * Order item interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ * Constants for keys of data array. Identical to the name of the getter in snake case */ + /* + * Item ID. + */ const ITEM_ID = 'item_id'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Parent item ID. + */ const PARENT_ITEM_ID = 'parent_item_id'; + /* + * Quote item ID. + */ const QUOTE_ITEM_ID = 'quote_item_id'; + /* + * Store ID. + */ const STORE_ID = 'store_id'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; + /* + * Product ID. + */ const PRODUCT_ID = 'product_id'; + /* + * Product type. + */ const PRODUCT_TYPE = 'product_type'; + /* + * Product options. + */ const PRODUCT_OPTIONS = 'product_options'; + /* + * Weight. + */ const WEIGHT = 'weight'; + /* + * Is-virtual flag. + */ const IS_VIRTUAL = 'is_virtual'; + /* + * SKU. + */ const SKU = 'sku'; + /* + * Name. + */ const NAME = 'name'; + /* + * Description. + */ const DESCRIPTION = 'description'; + /* + * Applied rule IDs. + */ const APPLIED_RULE_IDS = 'applied_rule_ids'; + /* + * Additional data. + */ const ADDITIONAL_DATA = 'additional_data'; + /* + * Is-quantity-decimal flag. + */ const IS_QTY_DECIMAL = 'is_qty_decimal'; + /* + * No-discount flag. + */ const NO_DISCOUNT = 'no_discount'; + /* + * Quantity backordered. + */ const QTY_BACKORDERED = 'qty_backordered'; + /* + * Quantity canceled. + */ const QTY_CANCELED = 'qty_canceled'; + /* + * Quantity invoiced. + */ const QTY_INVOICED = 'qty_invoiced'; + /* + * Quantity ordered. + */ const QTY_ORDERED = 'qty_ordered'; + /* + * Quantity refunded. + */ const QTY_REFUNDED = 'qty_refunded'; + /* + * Quantity shipped. + */ const QTY_SHIPPED = 'qty_shipped'; + /* + * Base cost. + */ const BASE_COST = 'base_cost'; + /* + * Price. + */ const PRICE = 'price'; + /* + * Base price. + */ const BASE_PRICE = 'base_price'; + /* + * Original price. + */ const ORIGINAL_PRICE = 'original_price'; + /* + * Base original price. + */ const BASE_ORIGINAL_PRICE = 'base_original_price'; + /* + * Tax percent. + */ const TAX_PERCENT = 'tax_percent'; + /* + * Tax amount. + */ const TAX_AMOUNT = 'tax_amount'; + /* + * Base tax amount. + */ const BASE_TAX_AMOUNT = 'base_tax_amount'; + /* + * Tax invoiced. + */ const TAX_INVOICED = 'tax_invoiced'; + /* + * Base tax invoiced. + */ const BASE_TAX_INVOICED = 'base_tax_invoiced'; + /* + * Discount percent. + */ const DISCOUNT_PERCENT = 'discount_percent'; + /* + * Discount amount. + */ const DISCOUNT_AMOUNT = 'discount_amount'; + /* + * Base discount amount. + */ const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'; + /* + * Discount invoiced. + */ const DISCOUNT_INVOICED = 'discount_invoiced'; + /* + * Base discount invoiced. + */ const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'; + /* + * Amount refunded. + */ const AMOUNT_REFUNDED = 'amount_refunded'; + /* + * Base amount refunded. + */ const BASE_AMOUNT_REFUNDED = 'base_amount_refunded'; + /* + * Row total. + */ const ROW_TOTAL = 'row_total'; + /* + * Base row total. + */ const BASE_ROW_TOTAL = 'base_row_total'; + /* + * Row invoiced. + */ const ROW_INVOICED = 'row_invoiced'; + /* + * Base row invoiced. + */ const BASE_ROW_INVOICED = 'base_row_invoiced'; + /* + * Row weight. + */ const ROW_WEIGHT = 'row_weight'; + /* + * Base tax before discount. + */ const BASE_TAX_BEFORE_DISCOUNT = 'base_tax_before_discount'; + /* + * Tax before discount. + */ const TAX_BEFORE_DISCOUNT = 'tax_before_discount'; + /* + * External order item ID. + */ const EXT_ORDER_ITEM_ID = 'ext_order_item_id'; + /* + * Locked DO invoice. + */ const LOCKED_DO_INVOICE = 'locked_do_invoice'; + /* + * Locked DO ship. + */ const LOCKED_DO_SHIP = 'locked_do_ship'; + /* + * Price including tax. + */ const PRICE_INCL_TAX = 'price_incl_tax'; + /* + * Base price including tax. + */ const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'; + /* + * Row total including tax. + */ const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'; + /* + * Base row total including tax. + */ const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'; + /* + * Hidden tax amount. + */ const HIDDEN_TAX_AMOUNT = 'hidden_tax_amount'; + /* + * Base hidden tax amount. + */ const BASE_HIDDEN_TAX_AMOUNT = 'base_hidden_tax_amount'; + /* + * Hidden tax invoiced. + */ const HIDDEN_TAX_INVOICED = 'hidden_tax_invoiced'; + /* + * Base hidden tax invoiced. + */ const BASE_HIDDEN_TAX_INVOICED = 'base_hidden_tax_invoiced'; + /* + * Hidden tax refunded. + */ const HIDDEN_TAX_REFUNDED = 'hidden_tax_refunded'; + /* + * Base hidden tax refunded. + */ const BASE_HIDDEN_TAX_REFUNDED = 'base_hidden_tax_refunded'; + /* + * Is-nominal flag. + */ const IS_NOMINAL = 'is_nominal'; + /* + * Tax-canceled flag. + */ const TAX_CANCELED = 'tax_canceled'; + /* + * Hidden-tax-canceled flag. + */ const HIDDEN_TAX_CANCELED = 'hidden_tax_canceled'; + /* + * Tax refunded. + */ const TAX_REFUNDED = 'tax_refunded'; + /* + * Base tax refunded. + */ const BASE_TAX_REFUNDED = 'base_tax_refunded'; + /* + * Discount refunded. + */ const DISCOUNT_REFUNDED = 'discount_refunded'; + /* + * Base discount refunded. + */ const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'; + /* + * GW ID. + */ const GW_ID = 'gw_id'; + /* + * GW base price. + */ const GW_BASE_PRICE = 'gw_base_price'; + /* + * GW price. + */ const GW_PRICE = 'gw_price'; + /* + * GW base tax amount. + */ const GW_BASE_TAX_AMOUNT = 'gw_base_tax_amount'; + /* + * GW tax amount. + */ const GW_TAX_AMOUNT = 'gw_tax_amount'; + /* + * GW base price invoiced. + */ const GW_BASE_PRICE_INVOICED = 'gw_base_price_invoiced'; + /* + * GW price invoiced. + */ const GW_PRICE_INVOICED = 'gw_price_invoiced'; + /* + * GW base tax amount invoiced. + */ const GW_BASE_TAX_AMOUNT_INVOICED = 'gw_base_tax_amount_invoiced'; + /* + * GW tax amount invoiced. + */ const GW_TAX_AMOUNT_INVOICED = 'gw_tax_amount_invoiced'; + /* + * GW base price refunded. + */ const GW_BASE_PRICE_REFUNDED = 'gw_base_price_refunded'; + /* + * GW price refunded. + */ const GW_PRICE_REFUNDED = 'gw_price_refunded'; + /* + * GW base tax amount refunded. + */ const GW_BASE_TAX_AMOUNT_REFUNDED = 'gw_base_tax_amount_refunded'; + /* + * GW tax amount refunded. + */ const GW_TAX_AMOUNT_REFUNDED = 'gw_tax_amount_refunded'; + /* + * Free shipping. + */ const FREE_SHIPPING = 'free_shipping'; + /* + * Quantity returned. + */ const QTY_RETURNED = 'qty_returned'; + /* + * Event ID. + */ const EVENT_ID = 'event_id'; + /* + * Base WEEE tax applied amount. + */ const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount'; + /* + * Base WEEE tax applied row amount. + */ const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt'; + /* + * WEEE tax applied amount. + */ const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'; + /* + * WEEE tax applied row amount. + */ const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount'; + /* + * WEEE tax applied. + */ const WEEE_TAX_APPLIED = 'weee_tax_applied'; + /* + * WEEE tax disposition. + */ const WEEE_TAX_DISPOSITION = 'weee_tax_disposition'; + /* + * WEEE tax row disposition. + */ const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition'; + /* + * Base WEEE tax disposition. + */ const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition'; + /* + * Base WEEE tax row disposition. + */ const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition'; /** - * Returns additional_data + * Gets the additional data for the order item. * - * @return string + * @return string Additional data. */ public function getAdditionalData(); /** - * Returns amount_refunded + * Gets the amount refunded for the order item. * - * @return float + * @return float Amount refunded. */ public function getAmountRefunded(); /** - * Returns applied_rule_ids + * Gets the applied rule IDs for the order item. * - * @return string + * @return string Applied rule IDs. */ public function getAppliedRuleIds(); /** - * Returns base_amount_refunded + * Gets the base amount refunded for the order item. * - * @return float + * @return float Base amount refunded. */ public function getBaseAmountRefunded(); /** - * Returns base_cost + * Gets the base cost for the order item. * - * @return float + * @return float Base cost. */ public function getBaseCost(); /** - * Returns base_discount_amount + * Gets the base discount amount for the order item. * - * @return float + * @return float Base discount amount. */ public function getBaseDiscountAmount(); /** - * Returns base_discount_invoiced + * Gets the base discount invoiced for the order item. * - * @return float + * @return float Base discount invoiced. */ public function getBaseDiscountInvoiced(); /** - * Returns base_discount_refunded + * Gets the base discount refunded for the order item. * - * @return float + * @return float Base discount refunded. */ public function getBaseDiscountRefunded(); /** - * Returns base_hidden_tax_amount + * Gets the base hidden tax amount for the order item. * - * @return float + * @return float Base hidden tax amount. */ public function getBaseHiddenTaxAmount(); /** - * Returns base_hidden_tax_invoiced + * Gets the base hidden tax invoiced for the order item. * - * @return float + * @return float Base hidden tax invoiced. */ public function getBaseHiddenTaxInvoiced(); /** - * Returns base_hidden_tax_refunded + * Gets the base hidden tax refunded for the order item. * - * @return float + * @return float Base hidden tax refunded. */ public function getBaseHiddenTaxRefunded(); /** - * Returns base_original_price + * Gets the base original price for the order item. * - * @return float + * @return float Base original price. */ public function getBaseOriginalPrice(); /** - * Returns base_price + * Gets the base price for the order item. * - * @return float + * @return float Base price. */ public function getBasePrice(); /** - * Returns base_price_incl_tax + * Gets the base price including tax for the order item. * - * @return float + * @return float Base price including tax. */ public function getBasePriceInclTax(); /** - * Returns base_row_invoiced + * Gets the base row invoiced for the order item. * - * @return float + * @return float Base row invoiced. */ public function getBaseRowInvoiced(); /** - * Returns base_row_total + * Gets the base row total for the order item. * - * @return float + * @return float Base row total. */ public function getBaseRowTotal(); /** - * Returns base_row_total_incl_tax + * Gets the base row total including tax for the order item. * - * @return float + * @return float Base row total including tax. */ public function getBaseRowTotalInclTax(); /** - * Returns base_tax_amount + * Gets the base tax amount for the order item. * - * @return float + * @return float Base tax amount. */ public function getBaseTaxAmount(); /** - * Returns base_tax_before_discount + * Gets the base tax before discount for the order item. * - * @return float + * @return float Base tax before discount. */ public function getBaseTaxBeforeDiscount(); /** - * Returns base_tax_invoiced + * Gets the base tax invoiced for the order item. * - * @return float + * @return float Base tax invoiced. */ public function getBaseTaxInvoiced(); /** - * Returns base_tax_refunded + * Gets the base tax refunded for the order item. * - * @return float + * @return float Base tax refunded. */ public function getBaseTaxRefunded(); /** - * Returns base_weee_tax_applied_amount + * Gets the base WEEE tax applied amount for the order item. * - * @return float + * @return float Base WEEE tax applied amount. */ public function getBaseWeeeTaxAppliedAmount(); /** - * Returns base_weee_tax_applied_row_amnt + * Gets the base WEEE tax applied row amount for the order item. * - * @return float + * @return float Base WEEE tax applied row amount. */ public function getBaseWeeeTaxAppliedRowAmnt(); /** - * Returns base_weee_tax_disposition + * Gets the base WEEE tax disposition for the order item. * - * @return float + * @return float Base WEEE tax disposition. */ public function getBaseWeeeTaxDisposition(); /** - * Returns base_weee_tax_row_disposition + * Gets the base WEEE tax row disposition for the order item. * - * @return float + * @return float Base WEEE tax row disposition. */ public function getBaseWeeeTaxRowDisposition(); /** - * Returns created_at + * Gets the created-at timestamp for the order item. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns description + * Gets the description for the order item. * - * @return string + * @return string Description. */ public function getDescription(); /** - * Returns discount_amount + * Gets the discount amount for the order item. * - * @return float + * @return float Discount amount. */ public function getDiscountAmount(); /** - * Returns discount_invoiced + * Gets the discount invoiced for the order item. * - * @return float + * @return float Discount invoiced. */ public function getDiscountInvoiced(); /** - * Returns discount_percent + * Gets the discount percent for the order item. * - * @return float + * @return float Discount percent. */ public function getDiscountPercent(); /** - * Returns discount_refunded + * Gets the discount refunded for the order item. * - * @return float + * @return float Discount refunded. */ public function getDiscountRefunded(); /** - * Returns event_id + * Gets the event ID for the order item. * - * @return int + * @return int Event ID. */ public function getEventId(); /** - * Returns ext_order_item_id + * Gets the external order item ID for the order item. * - * @return string + * @return string External order item ID. */ public function getExtOrderItemId(); /** - * Returns free_shipping + * Gets the free-shipping flag value for the order item. * - * @return int + * @return int Free-shipping flag value. */ public function getFreeShipping(); /** - * Returns gw_base_price + * Gets the GW base price for the order item. * - * @return float + * @return float GW base price. */ public function getGwBasePrice(); /** - * Returns gw_base_price_invoiced + * Gets the GW base price invoiced for the order item. * - * @return float + * @return float GW base price invoiced. */ public function getGwBasePriceInvoiced(); /** - * Returns gw_base_price_refunded + * Gets the GW base price refunded for the order item. * - * @return float + * @return float GW base price refunded. */ public function getGwBasePriceRefunded(); /** - * Returns gw_base_tax_amount + * Gets the GW base tax amount for the order item. * - * @return float + * @return float GW base tax amount. */ public function getGwBaseTaxAmount(); /** - * Returns gw_base_tax_amount_invoiced + * Gets the GW base tax amount invoiced for the order item. * - * @return float + * @return float GW base tax amount invoiced. */ public function getGwBaseTaxAmountInvoiced(); /** - * Returns gw_base_tax_amount_refunded + * Gets the GW base tax amount refunded for the order item. * - * @return float + * @return float GW base tax amount refunded. */ public function getGwBaseTaxAmountRefunded(); /** - * Returns gw_id + * Gets the GW ID for the order item. * - * @return int + * @return int GW ID. */ public function getGwId(); /** - * Returns gw_price + * Gets the GW price for the order item. * - * @return float + * @return float GW price. */ public function getGwPrice(); /** - * Returns gw_price_invoiced + * Gets the GW price invoiced for the order item. * - * @return float + * @return float GW price invoiced. */ public function getGwPriceInvoiced(); /** - * Returns gw_price_refunded + * Gets the GW price refunded for the order item. * - * @return float + * @return float GW price refunded. */ public function getGwPriceRefunded(); /** - * Returns gw_tax_amount + * Gets the GW tax amount for the order item. * - * @return float + * @return float GW tax amount. */ public function getGwTaxAmount(); /** - * Returns gw_tax_amount_invoiced + * Gets the GW tax amount invoiced for the order item. * - * @return float + * @return float GW tax amount invoiced. */ public function getGwTaxAmountInvoiced(); /** - * Returns gw_tax_amount_refunded + * Gets the GW tax amount refunded for the order item. * - * @return float + * @return float GW tax amount refunded. */ public function getGwTaxAmountRefunded(); /** - * Returns hidden_tax_amount + * Gets the hidden tax amount for the order item. * - * @return float + * @return float Hidden tax amount. */ public function getHiddenTaxAmount(); /** - * Returns hidden_tax_canceled + * Gets the hidden tax canceled for the order item. * - * @return float + * @return float Hidden tax canceled. */ public function getHiddenTaxCanceled(); /** - * Returns hidden_tax_invoiced + * Gets the hidden tax invoiced for the order item. * - * @return float + * @return float Hidden tax invoiced. */ public function getHiddenTaxInvoiced(); /** - * Returns hidden_tax_refunded + * Gets the hidden tax refunded for the order item. * - * @return float + * @return float Hidden tax refunded. */ public function getHiddenTaxRefunded(); /** - * Returns is_nominal + * Gets the is-nominal flag value for the order item. * - * @return int + * @return int Is-nominal flag value. */ public function getIsNominal(); /** - * Returns is_qty_decimal + * Gets the is-quantity-decimal flag value for the order item. * - * @return int + * @return int Is-quantity-decimal flag value. */ public function getIsQtyDecimal(); /** - * Returns is_virtual + * Gets the is-virtual flag value for the order item. * - * @return int + * @return int Is-virtual flag value. */ public function getIsVirtual(); /** - * Returns item_id + * Gets the item ID for the order item. * - * @return int + * @return int Item ID. */ public function getItemId(); /** - * Returns locked_do_invoice + * Gets the locked DO invoice flag value for the order item. * - * @return int + * @return int Locked DO invoice flag value. */ public function getLockedDoInvoice(); /** - * Returns locked_do_ship + * Gets the locked DO ship flag value for the order item. * - * @return int + * @return int Locked DO ship flag value. */ public function getLockedDoShip(); /** - * Returns name + * Gets the name for the order item. * - * @return string + * @return string Name. */ public function getName(); /** - * Returns no_discount + * Gets the no discount flag value for the order item. * - * @return int + * @return int No-discount flag value. */ public function getNoDiscount(); /** - * Returns order_id + * Gets the order ID for the order item. * - * @return int + * @return int Order ID. */ public function getOrderId(); /** - * Returns original_price + * Gets the original price for the order item. * - * @return float + * @return float Original price. */ public function getOriginalPrice(); /** - * Returns parent_item_id + * Gets the parent item ID for the order item. * - * @return int + * @return int Parent item ID. */ public function getParentItemId(); /** - * Returns price + * Gets the price for the order item. * - * @return float + * @return float Price. */ public function getPrice(); /** - * Returns price_incl_tax + * Gets the price including tax for the order item. * - * @return float + * @return float Price including tax. */ public function getPriceInclTax(); /** - * Returns product_id + * Gets the product ID for the order item. * - * @return int + * @return int Product ID. */ public function getProductId(); /** - * Returns product_options + * Gets the product options for the order item. * - * @return string[] + * @return string[] Array of product options. */ public function getProductOptions(); /** - * Returns product_type + * Gets the product type for the order item. * - * @return string + * @return string Product type. */ public function getProductType(); /** - * Returns qty_backordered + * Gets the quantity backordered for the order item. * - * @return float + * @return float Quantity backordered. */ public function getQtyBackordered(); /** - * Returns qty_canceled + * Gets the quantity canceled for the order item. * - * @return float + * @return float Quantity canceled. */ public function getQtyCanceled(); /** - * Returns qty_invoiced + * Gets the quantity invoiced for the order item. * - * @return float + * @return float Quantity invoiced. */ public function getQtyInvoiced(); /** - * Returns qty_ordered + * Gets the quantity ordered for the order item. * - * @return float + * @return float Quantity ordered. */ public function getQtyOrdered(); /** - * Returns qty_refunded + * Gets the quantity refunded for the order item. * - * @return float + * @return float Quantity refunded. */ public function getQtyRefunded(); /** - * Returns qty_returned + * Gets the quantity returned for the order item. * - * @return float + * @return float Quantity returned. */ public function getQtyReturned(); /** - * Returns qty_shipped + * Gets the quantity shipped for the order item. * - * @return float + * @return float Quantity shipped. */ public function getQtyShipped(); /** - * Returns quote_item_id + * Gets the quote item ID for the order item. * - * @return int + * @return int Quote item ID. */ public function getQuoteItemId(); /** - * Returns row_invoiced + * Gets the row invoiced for the order item. * - * @return float + * @return float Row invoiced. */ public function getRowInvoiced(); /** - * Returns row_total + * Gets the row total for the order item. * - * @return float + * @return float Row total. */ public function getRowTotal(); /** - * Returns row_total_incl_tax + * Gets the row total including tax for the order item. * - * @return float + * @return float Row total including tax. */ public function getRowTotalInclTax(); /** - * Returns row_weight + * Gets the row weight for the order item. * - * @return float + * @return float Row weight. */ public function getRowWeight(); /** - * Returns sku + * Gets the SKU for the order item. * - * @return string + * @return string SKU. */ public function getSku(); /** - * Returns store_id + * Gets the store ID for the order item. * - * @return int + * @return int Store ID. */ public function getStoreId(); /** - * Returns tax_amount + * Gets the tax amount for the order item. * - * @return float + * @return float Tax amount. */ public function getTaxAmount(); /** - * Returns tax_before_discount + * Gets the tax before discount for the order item. * - * @return float + * @return float Tax before discount. */ public function getTaxBeforeDiscount(); /** - * Returns tax_canceled + * Gets the tax canceled for the order item. * - * @return float + * @return float Tax canceled. */ public function getTaxCanceled(); /** - * Returns tax_invoiced + * Gets the tax invoiced for the order item. * - * @return float + * @return float Tax invoiced. */ public function getTaxInvoiced(); /** - * Returns tax_percent + * Gets the tax percent for the order item. * - * @return float + * @return float Tax percent. */ public function getTaxPercent(); /** - * Returns tax_refunded + * Gets the tax refunded for the order item. * - * @return float + * @return float Tax refunded. */ public function getTaxRefunded(); /** - * Returns updated_at + * Gets the updated-at timestamp for the order item. * - * @return string + * @return string Updated-at timestamp. */ public function getUpdatedAt(); /** - * Returns weee_tax_applied + * Gets the WEEE tax applied for the order item. * - * @return string + * @return string WEEE tax applied. */ public function getWeeeTaxApplied(); /** - * Returns weee_tax_applied_amount + * Gets the WEEE tax applied amount for the order item. * - * @return float + * @return float WEEE tax applied amount. */ public function getWeeeTaxAppliedAmount(); /** - * Returns weee_tax_applied_row_amount + * Gets the WEEE tax applied row amount for the order item. * - * @return float + * @return float WEEE tax applied row amount. */ public function getWeeeTaxAppliedRowAmount(); /** - * Returns weee_tax_disposition + * Gets the WEEE tax disposition for the order item. * - * @return float + * @return float WEEE tax disposition. */ public function getWeeeTaxDisposition(); /** - * Returns weee_tax_row_disposition + * Gets the WEEE tax row disposition for the order item. * - * @return float + * @return float WEEE tax row disposition. */ public function getWeeeTaxRowDisposition(); /** - * Returns weight + * Gets the weight for the order item. * - * @return float + * @return float Weight. */ public function getWeight(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderItemSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/OrderItemSearchResultInterface.php index a99706259190b..68cbb41c407b0 100644 --- a/app/code/Magento/Sales/Api/Data/OrderItemSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderItemSearchResultInterface.php @@ -2,18 +2,21 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface OrderItemSearchResultInterface + * Order item search result interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderItemSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\OrderItemInterface[] + * @return \Magento\Sales\Api\Data\OrderItemInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderPaymentInterface.php b/app/code/Magento/Sales/Api/Data/OrderPaymentInterface.php index 5f72e46455f93..9f605a4566e7b 100644 --- a/app/code/Magento/Sales/Api/Data/OrderPaymentInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderPaymentInterface.php @@ -5,443 +5,609 @@ namespace Magento\Sales\Api\Data; /** - * Interface OrderPaymentInterface + * Order payment interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderPaymentInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Base shipping captured. + */ const BASE_SHIPPING_CAPTURED = 'base_shipping_captured'; + /* + * Shipping captured. + */ const SHIPPING_CAPTURED = 'shipping_captured'; + /* + * Amount refunded. + */ const AMOUNT_REFUNDED = 'amount_refunded'; + /* + * Base amount paid. + */ const BASE_AMOUNT_PAID = 'base_amount_paid'; + /* + * Amount canceled. + */ const AMOUNT_CANCELED = 'amount_canceled'; + /* + * Base amount authorized. + */ const BASE_AMOUNT_AUTHORIZED = 'base_amount_authorized'; + /* + * Base amount paid online. + */ const BASE_AMOUNT_PAID_ONLINE = 'base_amount_paid_online'; + /* + * Base amount refunded online. + */ const BASE_AMOUNT_REFUNDED_ONLINE = 'base_amount_refunded_online'; + /* + * Base shipping amount. + */ const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'; + /* + * Shipping amount. + */ const SHIPPING_AMOUNT = 'shipping_amount'; + /* + * Amount paid. + */ const AMOUNT_PAID = 'amount_paid'; + /* + * Amount authorized. + */ const AMOUNT_AUTHORIZED = 'amount_authorized'; + /* + * Base amount ordered. + */ const BASE_AMOUNT_ORDERED = 'base_amount_ordered'; + /* + * Base shipping refunded. + */ const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded'; + /* + * Shipping refunded. + */ const SHIPPING_REFUNDED = 'shipping_refunded'; + /* + * Base amount refunded. + */ const BASE_AMOUNT_REFUNDED = 'base_amount_refunded'; + /* + * Amount ordered. + */ const AMOUNT_ORDERED = 'amount_ordered'; + /* + * Base amount canceled. + */ const BASE_AMOUNT_CANCELED = 'base_amount_canceled'; + /* + * Quote payment ID. + */ const QUOTE_PAYMENT_ID = 'quote_payment_id'; + /* + * Additional data. + */ const ADDITIONAL_DATA = 'additional_data'; + /* + * Credit card expiration month. + */ const CC_EXP_MONTH = 'cc_exp_month'; + /* + * Credit card SS start year. + */ const CC_SS_START_YEAR = 'cc_ss_start_year'; + /* + * eCheck bank name. + */ const ECHECK_BANK_NAME = 'echeck_bank_name'; + /* + * Payment method. + */ const METHOD = 'method'; + /* + * Credit card debug request body. + */ const CC_DEBUG_REQUEST_BODY = 'cc_debug_request_body'; + /* + * Credit card secure verify. + */ const CC_SECURE_VERIFY = 'cc_secure_verify'; + /* + * Protection eligibility. + */ const PROTECTION_ELIGIBILITY = 'protection_eligibility'; + /* + * Credit card approval. + */ const CC_APPROVAL = 'cc_approval'; + /* + * Last four digits of credit card number. + */ const CC_LAST4 = 'cc_last4'; + /* + * Credit card status description. + */ const CC_STATUS_DESCRIPTION = 'cc_status_description'; + /* + * eCheck type. + */ const ECHECK_TYPE = 'echeck_type'; + /* + * Credit card debug response serialized. + */ const CC_DEBUG_RESPONSE_SERIALIZED = 'cc_debug_response_serialized'; + /* + * Credit card SS start month. + */ const CC_SS_START_MONTH = 'cc_ss_start_month'; + /* + * eCheck account type. + */ const ECHECK_ACCOUNT_TYPE = 'echeck_account_type'; + /* + * Last transaction ID. + */ const LAST_TRANS_ID = 'last_trans_id'; + /* + * Credit card CID status. + */ const CC_CID_STATUS = 'cc_cid_status'; + /* + * Credit card owner. + */ const CC_OWNER = 'cc_owner'; + /* + * Credit card type. + */ const CC_TYPE = 'cc_type'; + /* + * PO number. + */ const PO_NUMBER = 'po_number'; + /* + * Credit card expiration year. + */ const CC_EXP_YEAR = 'cc_exp_year'; + /* + * Credit card status. + */ const CC_STATUS = 'cc_status'; + /* + * eCheck routing number. + */ const ECHECK_ROUTING_NUMBER = 'echeck_routing_number'; + /* + * Account status. + */ const ACCOUNT_STATUS = 'account_status'; + /* + * ANET transaction method. + */ const ANET_TRANS_METHOD = 'anet_trans_method'; + /* + * Credit card debug response body. + */ const CC_DEBUG_RESPONSE_BODY = 'cc_debug_response_body'; + /* + * Credit card SS issue. + */ const CC_SS_ISSUE = 'cc_ss_issue'; + /* + * eCheck account name. + */ const ECHECK_ACCOUNT_NAME = 'echeck_account_name'; + /* + * Credit card AVS status. + */ const CC_AVS_STATUS = 'cc_avs_status'; + /* + * Encrypted credit card number. + */ const CC_NUMBER_ENC = 'cc_number_enc'; + /* + * Credit card transaction ID. + */ const CC_TRANS_ID = 'cc_trans_id'; + /* + * Address status. + */ const ADDRESS_STATUS = 'address_status'; + /* + * Additional information. + */ const ADDITIONAL_INFORMATION = 'additional_information'; /** - * Returns account_status + * Gets the account status for the order payment. * - * @return string + * @return string Account status. */ public function getAccountStatus(); /** - * Returns additional_data + * Gets the additional data for the order payment. * - * @return string + * @return string Additional data. */ public function getAdditionalData(); /** - * Returns additional_information + * Gets the additional information for the order payment. * - * @return string[] + * @return string[] Array of additional information. */ public function getAdditionalInformation(); /** - * Returns address_status + * Gets the address status for the order payment. * - * @return string + * @return string Address status. */ public function getAddressStatus(); /** - * Returns amount_authorized + * Gets the amount authorized for the order payment. * - * @return float + * @return float Amount authorized. */ public function getAmountAuthorized(); /** - * Returns amount_canceled + * Gets the amount canceled for the order payment. * - * @return float + * @return float Amount canceled. */ public function getAmountCanceled(); /** - * Returns amount_ordered + * Gets the amount ordered for the order payment. * - * @return float + * @return float Amount ordered. */ public function getAmountOrdered(); /** - * Returns amount_paid + * Gets the amount paid for the order payment. * - * @return float + * @return float Amount paid. */ public function getAmountPaid(); /** - * Returns amount_refunded + * Gets the amount refunded for the order payment. * - * @return float + * @return float Amount refunded. */ public function getAmountRefunded(); /** - * Returns anet_trans_method + * Gets the anet transaction method for the order payment. * - * @return string + * @return string Anet transaction method. */ public function getAnetTransMethod(); /** - * Returns base_amount_authorized + * Gets the base amount authorized for the order payment. * - * @return float + * @return float Base amount authorized. */ public function getBaseAmountAuthorized(); /** - * Returns base_amount_canceled + * Gets the base amount canceled for the order payment. * - * @return float + * @return float Base amount canceled. */ public function getBaseAmountCanceled(); /** - * Returns base_amount_ordered + * Gets the base amount ordered for the order payment. * - * @return float + * @return float Base amount ordered. */ public function getBaseAmountOrdered(); /** - * Returns base_amount_paid + * Gets the base amount paid for the order payment. * - * @return float + * @return float Base amount paid. */ public function getBaseAmountPaid(); /** - * Returns base_amount_paid_online + * Gets the base amount paid online for the order payment. * - * @return float + * @return float Base amount paid online. */ public function getBaseAmountPaidOnline(); /** - * Returns base_amount_refunded + * Gets the base amount refunded for the order payment. * - * @return float + * @return float Base amount refunded. */ public function getBaseAmountRefunded(); /** - * Returns base_amount_refunded_online + * Gets the base amount refunded online for the order payment. * - * @return float + * @return float Base amount refunded online. */ public function getBaseAmountRefundedOnline(); /** - * Returns base_shipping_amount + * Gets the base shipping amount for the order payment. * - * @return float + * @return float Base shipping amount. */ public function getBaseShippingAmount(); /** - * Returns base_shipping_captured + * Gets the base shipping captured for the order payment. * - * @return float + * @return float Base shipping captured amount. */ public function getBaseShippingCaptured(); /** - * Returns base_shipping_refunded + * Gets the base shipping refunded amount for the order payment. * - * @return float + * @return float Base shipping refunded amount. */ public function getBaseShippingRefunded(); /** - * Returns cc_approval + * Gets the credit card approval for the order payment. * - * @return string + * @return string Credit card approval. */ public function getCcApproval(); /** - * Returns cc_avs_status + * Gets the credit card avs status for the order payment. * - * @return string + * @return string Credit card avs status. */ public function getCcAvsStatus(); /** - * Returns cc_cid_status + * Gets the credit card cid status for the order payment. * - * @return string + * @return string Credit card CID status. */ public function getCcCidStatus(); /** - * Returns cc_debug_request_body + * Gets the credit card debug request body for the order payment. * - * @return string + * @return string Credit card debug request body. */ public function getCcDebugRequestBody(); /** - * Returns cc_debug_response_body + * Gets the credit card debug response body for the order payment. * - * @return string + * @return string Credit card debug response body. */ public function getCcDebugResponseBody(); /** - * Returns cc_debug_response_serialized + * Gets the credit card debug response serialized for the order payment. * - * @return string + * @return string Credit card debug response serialized. */ public function getCcDebugResponseSerialized(); /** - * Returns cc_exp_month + * Gets the credit card expiration month for the order payment. * - * @return string + * @return string Credit card expiration month. */ public function getCcExpMonth(); /** - * Returns cc_exp_year + * Gets the credit card expiration year for the order payment. * - * @return string + * @return string Credit card expiration year. */ public function getCcExpYear(); /** - * Returns cc_last4 + * Gets the last four digits of the credit card for the order payment. * - * @return string + * @return string Last four digits of the credit card. */ public function getCcLast4(); /** - * Returns cc_number_enc + * Gets the encrypted credit card number for the order payment. * - * @return string + * @return string Encrypted credit card number . */ public function getCcNumberEnc(); /** - * Returns cc_owner + * Gets the credit card owner for the order payment. * - * @return string + * @return string Credit card number. */ public function getCcOwner(); /** - * Returns cc_secure_verify + * Gets the credit card secure verify for the order payment. * - * @return string + * @return string Credit card secure verify. */ public function getCcSecureVerify(); /** - * Returns cc_ss_issue + * Gets the credit card SS issue for the order payment. * - * @return string + * @return string Credit card SS issue. */ public function getCcSsIssue(); /** - * Returns cc_ss_start_month + * Gets the credit card SS start month for the order payment. * - * @return string + * @return string Credit card SS start month. */ public function getCcSsStartMonth(); /** - * Returns cc_ss_start_year + * Gets the credit card SS start year for the order payment. * - * @return string + * @return string Credit card SS start year. */ public function getCcSsStartYear(); /** - * Returns cc_status + * Gets the credit card status for the order payment. * - * @return string + * @return string Credit card status. */ public function getCcStatus(); /** - * Returns cc_status_description + * Gets the credit card status description for the order payment. * - * @return string + * @return string Credit card status description. */ public function getCcStatusDescription(); /** - * Returns cc_trans_id + * Gets the credit card transaction id for the order payment. * - * @return string + * @return string Credit card transaction ID. */ public function getCcTransId(); /** - * Returns cc_type + * Gets the credit card type for the order payment. * - * @return string + * @return string Credit card type. */ public function getCcType(); /** - * Returns echeck_account_name + * Gets the eCheck account name for the order payment. * - * @return string + * @return string eCheck account name. */ public function getEcheckAccountName(); /** - * Returns echeck_account_type + * Gets the eCheck account type for the order payment. * - * @return string + * @return string eCheck account type. */ public function getEcheckAccountType(); /** - * Returns echeck_bank_name + * Gets the eCheck bank name for the order payment. * - * @return string + * @return string eCheck bank name. */ public function getEcheckBankName(); /** - * Returns echeck_routing_number + * Gets the eCheck routing number for the order payment. * - * @return string + * @return string eCheck routing number. */ public function getEcheckRoutingNumber(); /** - * Returns echeck_type + * Gets the eCheck type for the order payment. * - * @return string + * @return string eCheck type. */ public function getEcheckType(); /** - * Returns entity_id + * Gets the entity ID for the order payment. * - * @return int + * @return int Entity ID. */ public function getEntityId(); /** - * Returns last_trans_id + * Gets the last transaction ID for the order payment. * - * @return string + * @return string Last transaction ID. */ public function getLastTransId(); /** - * Returns method + * Gets the method for the order payment. * - * @return string + * @return string Method. */ public function getMethod(); /** - * Returns parent_id + * Gets the parent ID for the order payment. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns po_number + * Gets the PO number for the order payment. * - * @return string + * @return string PO number. */ public function getPoNumber(); /** - * Returns protection_eligibility + * Gets the protection eligibility for the order payment. * - * @return string + * @return string Protection eligibility. */ public function getProtectionEligibility(); /** - * Returns quote_payment_id + * Gets the quote payment ID for the order payment. * - * @return int + * @return int Quote payment ID. */ public function getQuotePaymentId(); /** - * Returns shipping_amount + * Gets the shipping amount for the order payment. * - * @return float + * @return float Shipping amount. */ public function getShippingAmount(); /** - * Returns shipping_captured + * Gets the shipping captured for the order payment. * - * @return float + * @return float Shipping captured. */ public function getShippingCaptured(); /** - * Returns shipping_refunded + * Gets the shipping refunded for the order payment. * - * @return float + * @return float Shipping refunded. */ public function getShippingRefunded(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderPaymentSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/OrderPaymentSearchResultInterface.php index b6a38cfb297be..1e0357cf2b52e 100644 --- a/app/code/Magento/Sales/Api/Data/OrderPaymentSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderPaymentSearchResultInterface.php @@ -2,18 +2,21 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface OrderPaymentSearchResultInterface + * Order payment search result interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderPaymentSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\OrderPaymentInterface[] + * @return \Magento\Sales\Api\Data\OrderPaymentInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/OrderSearchResultInterface.php index 5391609cbeebb..defaf96e51dd2 100644 --- a/app/code/Magento/Sales/Api/Data/OrderSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderSearchResultInterface.php @@ -2,18 +2,21 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface OrderSearchResultInterface + * Order search result interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderSearchResultInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\OrderSearchResultInterface[] + * @return \Magento\Sales\Api\Data\OrderSearchResultInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderStatusHistoryInterface.php b/app/code/Magento/Sales/Api/Data/OrderStatusHistoryInterface.php index 527be3bf03859..86e0ffc81535a 100644 --- a/app/code/Magento/Sales/Api/Data/OrderStatusHistoryInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderStatusHistoryInterface.php @@ -5,75 +5,103 @@ namespace Magento\Sales\Api\Data; /** - * Interface OrderStatusHistoryInterface + * Order status history interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderStatusHistoryInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Is-customer-notified flag. + */ const IS_CUSTOMER_NOTIFIED = 'is_customer_notified'; + /* + * Is-visible-on-storefront flag. + */ const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'; + /* + * Comment. + */ const COMMENT = 'comment'; + /* + * Status. + */ const STATUS = 'status'; + /* + * Create-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Entity name. + */ const ENTITY_NAME = 'entity_name'; /** - * Returns comment + * Gets the comment for the order status history. * - * @return string + * @return string Comment. */ public function getComment(); /** - * Returns created_at + * Gets the created-at timestamp for the order status history. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns entity_id + * Gets the ID for the order status history. * - * @return int + * @return int Order status history ID. */ public function getEntityId(); /** - * Returns entity_name + * Gets the entity name for the order status history. * - * @return string + * @return string Entity name. */ public function getEntityName(); /** - * Returns is_customer_notified + * Gets the is-customer-notified flag value for the order status history. * - * @return int + * @return int Is-customer-notified flag value. */ public function getIsCustomerNotified(); /** - * Returns is_visible_on_front + * Gets the is-visible-on-storefront flag value for the order status history. * - * @return int + * @return int Is-visible-on-storefront flag value. */ public function getIsVisibleOnFront(); /** - * Returns parent_id + * Gets the parent ID for the order status history. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns status + * Gets the status for the order status history. * - * @return string + * @return string Status. */ public function getStatus(); } diff --git a/app/code/Magento/Sales/Api/Data/OrderStatusHistorySearchResultInterface.php b/app/code/Magento/Sales/Api/Data/OrderStatusHistorySearchResultInterface.php index 2f65c5cf1f1dc..1a66bcced0c48 100644 --- a/app/code/Magento/Sales/Api/Data/OrderStatusHistorySearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/OrderStatusHistorySearchResultInterface.php @@ -2,18 +2,21 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface OrderStatusHistorySearchResultInterface + * Order status history search result interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderStatusHistorySearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface[] + * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentCommentInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentCommentInterface.php index 15abbd8409ff1..8de199df5e5e5 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentCommentInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentCommentInterface.php @@ -5,59 +5,80 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentCommentInterface + * Shipment comment 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. A shipment document can contain comments. */ interface ShipmentCommentInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Is-customer-notified flag. + */ const IS_CUSTOMER_NOTIFIED = 'is_customer_notified'; + /* + * Is-visible-on-storefront flag. + */ const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'; + /* + * Comment. + */ const COMMENT = 'comment'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; /** - * Returns comment + * Gets the comment for the shipment. * - * @return string + * @return string Comment. */ public function getComment(); /** - * Returns created_at + * Gets the created-at timestamp for the shipment comment. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns entity_id + * Gets the ID for the shipment comment. * - * @return int + * @return int Shipment comment ID. */ public function getEntityId(); /** - * Returns is_customer_notified + * Gets the is-customer-notified flag value for the shipment comment. * - * @return int + * @return int Is-customer-notified flag value. */ public function getIsCustomerNotified(); /** - * Returns is_visible_on_front + * Gets the is-visible-on-storefront flag value for the shipment comment. * - * @return int + * @return int Is-visible-on-storefront flag value. */ public function getIsVisibleOnFront(); /** - * Returns parent_id + * Gets the parent ID for the shipment comment. * - * @return int + * @return int Parent ID. */ public function getParentId(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentCommentSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentCommentSearchResultInterface.php index 8ed69cd79bd37..c33dcd08535ce 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentCommentSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentCommentSearchResultInterface.php @@ -5,14 +5,17 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentCommentSearchResultInterface + * Shipment comment search result 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. A shipment document can contain comments. */ interface ShipmentCommentSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\ShipmentCommentInterface[] + * @return \Magento\Sales\Api\Data\ShipmentCommentInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentInterface.php index a3faaa9dc120a..e8655ecde2ee3 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentInterface.php @@ -5,155 +5,212 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentInterface + * Shipment 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. */ interface ShipmentInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ * Constants for keys of data array. Identical to the name of the getter in snake case */ + /* + * Entity ID. + */ const ENTITY_ID = 'entity_id'; + /* + * Store ID. + */ const STORE_ID = 'store_id'; + /* + * Total weight. + */ const TOTAL_WEIGHT = 'total_weight'; + /* + * Total quantity. + */ const TOTAL_QTY = 'total_qty'; + /* + * Email sent flag. + */ const EMAIL_SENT = 'email_sent'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Customer ID. + */ const CUSTOMER_ID = 'customer_id'; + /* + * Shipping address ID. + */ const SHIPPING_ADDRESS_ID = 'shipping_address_id'; + /* + * Billing address ID. + */ const BILLING_ADDRESS_ID = 'billing_address_id'; + /* + * Shipment status. + */ const SHIPMENT_STATUS = 'shipment_status'; + /* + * Increment ID. + */ const INCREMENT_ID = 'increment_id'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; + /* + * Packages. + */ const PACKAGES = 'packages'; + /* + * Shipping label. + */ const SHIPPING_LABEL = 'shipping_label'; + /* + * Items. + */ const ITEMS = 'items'; + /* + * Tracks. + */ const TRACKS = 'tracks'; + /* + * Comments. + */ const COMMENTS = 'comments'; /** - * Returns billing_address_id + * Gets the billing address ID for the shipment. * - * @return int + * @return int Billing address ID. */ public function getBillingAddressId(); /** - * Returns created_at + * Gets the created-at timestamp for the shipment. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns customer_id + * Gets the customer ID for the shipment. * - * @return int + * @return int Customer ID. */ public function getCustomerId(); /** - * Returns email_sent + * Gets the email-sent flag value for the shipment. * - * @return int + * @return int Email-sent flag value. */ public function getEmailSent(); /** - * Returns entity_id + * Gets the ID for the shipment. * - * @return int + * @return int Shipment ID. */ public function getEntityId(); /** - * Returns increment_id + * Gets the increment ID for the shipment. * - * @return string + * @return string Increment ID. */ public function getIncrementId(); /** - * Returns order_id + * Gets the order ID for the shipment. * - * @return int + * @return int Order ID. */ public function getOrderId(); /** - * Returns packages + * Gets any packages for the shipment. * - * @return \Magento\Sales\Api\Data\ShipmentPackageInterface[]|null + * @return \Magento\Sales\Api\Data\ShipmentPackageInterface[]|null Array of packages, if any. Otherwise, null. */ public function getPackages(); /** - * Returns shipment_status + * Gets the shipment status. * - * @return int + * @return int Shipment status. */ public function getShipmentStatus(); /** - * Returns shipping_address_id + * Gets the shipping address ID for the shipment. * - * @return int + * @return int Shipping address ID. */ public function getShippingAddressId(); /** - * Returns shipping_label + * Gets the shipping label for the shipment. * - * @return string + * @return string Shipping label. */ public function getShippingLabel(); /** - * Returns store_id + * Gets the store ID for the shipment. * - * @return int + * @return int Store ID. */ public function getStoreId(); /** - * Returns total_qty + * Gets the total quantity for the shipment. * - * @return float + * @return float Total quantity. */ public function getTotalQty(); /** - * Returns total_weight + * Gets the total weight for the shipment. * - * @return float + * @return float Total weight. */ public function getTotalWeight(); /** - * Returns updated_at + * Gets the updated-at timestamp for the shipment. * - * @return string + * @return string Updated-at timestamp. */ public function getUpdatedAt(); /** - * Returns items + * Gets the items for the shipment. * - * @return \Magento\Sales\Api\Data\ShipmentItemInterface[] + * @return \Magento\Sales\Api\Data\ShipmentItemInterface[] Array of items. */ public function getItems(); /** - * Returns tracks + * Gets the tracks for the shipment. * - * @return \Magento\Sales\Api\Data\ShipmentTrackInterface[] + * @return \Magento\Sales\Api\Data\ShipmentTrackInterface[] Array of tracks. */ public function getTracks(); /** - * Returns comments + * Gets the comments for the shipment. * - * @return \Magento\Sales\Api\Data\ShipmentCommentInterface[] + * @return \Magento\Sales\Api\Data\ShipmentCommentInterface[] Array of comments. */ public function getComments(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentItemInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentItemInterface.php index 1702932e7b6fd..7e2f9d0ec0bab 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentItemInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentItemInterface.php @@ -5,107 +5,146 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentItemInterface + * Shipment item 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. A product is an item in a shipment. */ interface ShipmentItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ * Constants for keys of data array. Identical to the name of the getter in snake case */ + /* + * Entity ID. + */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Row total. + */ const ROW_TOTAL = 'row_total'; + /* + * Price. + */ const PRICE = 'price'; + /* + * Weight. + */ const WEIGHT = 'weight'; + /* + * Quantity. + */ const QTY = 'qty'; + /* + * Product ID. + */ const PRODUCT_ID = 'product_id'; + /* + * Order item ID. + */ const ORDER_ITEM_ID = 'order_item_id'; + /* + * Additional data. + */ const ADDITIONAL_DATA = 'additional_data'; + /* + * Description. + */ const DESCRIPTION = 'description'; + /* + * Name. + */ const NAME = 'name'; + /* + * SKU. + */ const SKU = 'sku'; /** - * Returns additional_data + * Gets the additional data for the shipment item. * - * @return string + * @return string Additional data. */ public function getAdditionalData(); /** - * Returns description + * Gets the description for the shipment item. * - * @return string + * @return string Description. */ public function getDescription(); /** - * Returns entity_id + * Gets the ID for the shipment item. * - * @return int + * @return int Shipment item ID. */ public function getEntityId(); /** - * Returns name + * Gets the name for the shipment item. * - * @return string + * @return string Name. */ public function getName(); /** - * Returns order_item_id + * Gets the order item ID for the shipment item. * - * @return int + * @return int Order item ID. */ public function getOrderItemId(); /** - * Returns parent_id + * Gets the parent ID for the shipment item. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns price + * Gets the price for the shipment item. * - * @return float + * @return float Price. */ public function getPrice(); /** - * Returns product_id + * Gets the product ID for the shipment item. * - * @return int + * @return int Product ID. */ public function getProductId(); /** - * Returns qty + * Gets the quantity for the shipment item. * - * @return float + * @return float Quantity. */ public function getQty(); /** - * Returns row_total + * Gets the row total for the shipment item. * - * @return float + * @return float Row total. */ public function getRowTotal(); /** - * Returns sku + * Gets the SKU for the shipment item. * - * @return string + * @return string SKU. */ public function getSku(); /** - * Returns weight + * Gets the weight for the shipment item. * - * @return float + * @return float Weight. */ public function getWeight(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentItemSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentItemSearchResultInterface.php index d9203697e6053..b090456edbdcc 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentItemSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentItemSearchResultInterface.php @@ -2,18 +2,20 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface ShipmentItemSearchResultInterface + * Shipment item search result 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. A product is an item in a shipment. */ interface ShipmentItemSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\ShipmentItemInterface[] + * @return \Magento\Sales\Api\Data\ShipmentItemInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentPackageInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentPackageInterface.php index f617fe7d8be76..df714f9d36b06 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentPackageInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentPackageInterface.php @@ -5,7 +5,10 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentPackageInterface + * Shipment package 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. */ interface ShipmentPackageInterface extends \Magento\Framework\Api\ExtensibleDataInterface { diff --git a/app/code/Magento/Sales/Api/Data/ShipmentSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentSearchResultInterface.php index c2b7e655e3cfe..da6892ba10777 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentSearchResultInterface.php @@ -2,20 +2,22 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; use Magento\Framework\Api\SearchResultsInterface; /** - * Interface ShipmentSearchResultInterface + * Shipment search result 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. */ interface ShipmentSearchResultInterface extends SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\ShipmentInterface[] + * @return \Magento\Sales\Api\Data\ShipmentInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentTrackInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentTrackInterface.php index 2238ba4a2a021..e293d283b8195 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentTrackInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentTrackInterface.php @@ -5,99 +5,136 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentTrackInterface + * Shipment track 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. Merchants and customers can track + * shipments. */ interface ShipmentTrackInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Entity ID. */ const ENTITY_ID = 'entity_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Weight. + */ const WEIGHT = 'weight'; + /* + * Quantity. + */ const QTY = 'qty'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Track number. + */ const TRACK_NUMBER = 'track_number'; + /* + * Description. + */ const DESCRIPTION = 'description'; + /* + * Title. + */ const TITLE = 'title'; + /* + * Carrier code. + */ const CARRIER_CODE = 'carrier_code'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Updated-at timestamp. + */ const UPDATED_AT = 'updated_at'; /** - * Returns carrier_code + * Gets the carrier code for the shipment package. * - * @return string + * @return string Carrier code. */ public function getCarrierCode(); /** - * Returns created_at + * Gets the created-at timestamp for the shipment package. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns description + * Gets the description for the shipment package. * - * @return string + * @return string Description. */ public function getDescription(); /** - * Returns entity_id + * Gets the ID for the shipment package. * - * @return int + * @return int Shipment package ID. */ public function getEntityId(); /** - * Returns order_id + * Gets the order_id for the shipment package. * * @return int */ public function getOrderId(); /** - * Returns parent_id + * Gets the parent ID for the shipment package. * - * @return int + * @return int Parent ID. */ public function getParentId(); /** - * Returns qty + * Gets the quantity for the shipment package. * - * @return float + * @return float Quantity. */ public function getQty(); /** - * Returns title + * Gets the title for the shipment package. * - * @return string + * @return string Title. */ public function getTitle(); /** - * Returns track_number + * Gets the track number for the shipment package. * - * @return string + * @return string Track number. */ public function getTrackNumber(); /** - * Returns updated_at + * Gets the updated-at timestamp for the shipment package. * - * @return string + * @return string Updated-at timestamp. */ public function getUpdatedAt(); /** - * Returns weight + * Gets the weight for the shipment package. * - * @return float + * @return float Weight. */ public function getWeight(); } diff --git a/app/code/Magento/Sales/Api/Data/ShipmentTrackSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/ShipmentTrackSearchResultInterface.php index 6223962192bd7..4e48e7e0871ea 100644 --- a/app/code/Magento/Sales/Api/Data/ShipmentTrackSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/ShipmentTrackSearchResultInterface.php @@ -5,14 +5,18 @@ namespace Magento\Sales\Api\Data; /** - * Interface ShipmentTrackSearchResultInterface + * Shipment track search result 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. Merchants and customers can track + * shipments. */ interface ShipmentTrackSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\ShipmentTrackInterface[] + * @return \Magento\Sales\Api\Data\ShipmentTrackInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/Data/TransactionInterface.php b/app/code/Magento/Sales/Api/Data/TransactionInterface.php index b2a55fcd35ff6..0594cd280a344 100644 --- a/app/code/Magento/Sales/Api/Data/TransactionInterface.php +++ b/app/code/Magento/Sales/Api/Data/TransactionInterface.php @@ -5,101 +5,142 @@ namespace Magento\Sales\Api\Data; /** - * Interface TransactionInterface + * Transaction interface. + * + * A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on. */ interface TransactionInterface extends \Magento\Framework\Api\ExtensibleDataInterface { /**#@+ - * Constants for keys of data array. Identical to the name of the getter in snake case + * Constants for keys of data array. Identical to the name of the getter in snake case. + */ + /* + * Transaction ID. */ const TRANSACTION_ID = 'transaction_id'; + /* + * Parent ID. + */ const PARENT_ID = 'parent_id'; + /* + * Order ID. + */ const ORDER_ID = 'order_id'; + /* + * Payment ID. + */ const PAYMENT_ID = 'payment_id'; + /* + * Transaction business ID. + */ const TXN_ID = 'txn_id'; + /* + * Parent transaction ID. + */ const PARENT_TXN_ID = 'parent_txn_id'; + /* + * Transaction type. + */ const TXN_TYPE = 'txn_type'; + /* + * Is closed flag. + */ const IS_CLOSED = 'is_closed'; + /* + * Additional information. + */ const ADDITIONAL_INFORMATION = 'additional_information'; + /* + * Created-at timestamp. + */ const CREATED_AT = 'created_at'; + /* + * Method. + */ const METHOD = 'method'; + /* + * Increment ID. + */ const INCREMENT_ID = 'increment_id'; + /* + * Child transactions. + */ const CHILD_TRANSACTIONS = 'child_transactions'; /** - * Returns transaction_id + * Gets the transaction ID for the transaction. * - * @return int + * @return int Transaction ID. */ public function getTransactionId(); /** - * Returns parent_id + * Gets the parent ID for the transaction. * - * @return int|null + * @return int|null The parent ID for the transaction. Otherwise, null. */ public function getParentId(); /** - * Returns order_id + * Gets the order ID for the transaction. * - * @return int + * @return int Order ID. */ public function getOrderId(); /** - * Returns payment_id + * Gets the payment ID for the transaction. * - * @return int + * @return int Payment ID. */ public function getPaymentId(); /** - * Returns txn_id + * Gets the transaction business ID for the transaction. * - * @return string + * @return string Transaction business ID. */ public function getTxnId(); /** - * Returns parent_txn_id + * Gets the parent transaction business ID for the transaction. * - * @return string + * @return string Parent transaction business ID. */ public function getParentTxnId(); /** - * Returns txn_type + * Gets the transaction type for the transaction. * - * @return string + * @return string Transaction type. */ public function getTxnType(); /** - * Returns is_closed + * Gets the value of the is-closed flag for the transaction. * - * @return int + * @return int Is-closed flag value. */ public function getIsClosed(); /** - * Returns additional_information + * Gets any additional information for the transaction. * - * @return string[]|null + * @return string[]|null Array of additional information. Otherwise, null. */ public function getAdditionalInformation(); /** - * Returns created_at + * Gets the created-at timestamp for the transaction. * - * @return string + * @return string Created-at timestamp. */ public function getCreatedAt(); /** - * Returns child_transactions + * Gets an array of child transactions for the transaction. * - * @return \Magento\Sales\Api\Data\TransactionInterface[] + * @return \Magento\Sales\Api\Data\TransactionInterface[] Array of child transactions. */ public function getChildTransactions(); } diff --git a/app/code/Magento/Sales/Api/Data/TransactionSearchResultInterface.php b/app/code/Magento/Sales/Api/Data/TransactionSearchResultInterface.php index 79293d4a0d147..5def2fe749240 100644 --- a/app/code/Magento/Sales/Api/Data/TransactionSearchResultInterface.php +++ b/app/code/Magento/Sales/Api/Data/TransactionSearchResultInterface.php @@ -2,18 +2,19 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api\Data; /** - * Interface TransactionSearchResultInterface + * Transaction search result interface. + * + * A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on. */ interface TransactionSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface { /** - * Get collection items + * Gets collection items. * - * @return \Magento\Sales\Api\Data\TransactionInterface[] + * @return \Magento\Sales\Api\Data\TransactionInterface[] Array of collection items. */ public function getItems(); } diff --git a/app/code/Magento/Sales/Api/InvoiceCommentRepositoryInterface.php b/app/code/Magento/Sales/Api/InvoiceCommentRepositoryInterface.php index 8af4f6f90b5b9..e728221b98297 100644 --- a/app/code/Magento/Sales/Api/InvoiceCommentRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/InvoiceCommentRepositoryInterface.php @@ -5,37 +5,42 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Invoice comment repository interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the + * invoice history. */ interface InvoiceCommentRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\InvoiceSearchResultInterface + * Lists invoice comments that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\InvoiceSearchResultInterface Invoice search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified invoice comment. * - * @param int $id - * @return \Magento\Sales\Api\Data\InvoiceCommentInterface + * @param int $id The invoice comment ID. + * @return \Magento\Sales\Api\Data\InvoiceCommentInterface Invoice comment interface. */ public function get($id); /** - * Delete entity + * Deletes a specified invoice comment. * - * @param \Magento\Sales\Api\Data\InvoiceCommentInterface $entity + * @param \Magento\Sales\Api\Data\InvoiceCommentInterface $entity The invoice comment. * @return bool */ public function delete(\Magento\Sales\Api\Data\InvoiceCommentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified invoice comment. * - * @param \Magento\Sales\Api\Data\InvoiceCommentInterface $entity - * @return \Magento\Sales\Api\Data\InvoiceCommentInterface + * @param \Magento\Sales\Api\Data\InvoiceCommentInterface $entity The invoice comment. + * @return \Magento\Sales\Api\Data\InvoiceCommentInterface Invoice comment interface. */ public function save(\Magento\Sales\Api\Data\InvoiceCommentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/InvoiceItemRepositoryInterface.php b/app/code/Magento/Sales/Api/InvoiceItemRepositoryInterface.php index f835ec46b37fe..e3a6a61088484 100644 --- a/app/code/Magento/Sales/Api/InvoiceItemRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/InvoiceItemRepositoryInterface.php @@ -5,37 +5,41 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Invoice item repository interface. + * + * An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice. */ interface InvoiceItemRepositoryInterface { /** + * Lists the invoice items that match specified search criteria. + * * @param \Magento\Framework\Api\SearchCriteria $criteria * @return \Magento\Sales\Api\Data\InvoiceItemSearchResultInterface */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified invoice item. * - * @param int $id - * @return \Magento\Sales\Api\Data\InvoiceItemInterface + * @param int $id The invoice item ID. + * @return \Magento\Sales\Api\Data\InvoiceItemInterface Invoice item interface. */ public function get($id); /** - * Delete entity + * Deletes a specified invoice item. * - * @param \Magento\Sales\Api\Data\InvoiceItemInterface $entity + * @param \Magento\Sales\Api\Data\InvoiceItemInterface $entity The invoice item. * @return bool */ public function delete(\Magento\Sales\Api\Data\InvoiceItemInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified invoice item. * - * @param \Magento\Sales\Api\Data\InvoiceItemInterface $entity - * @return \Magento\Sales\Api\Data\InvoiceItemInterface + * @param \Magento\Sales\Api\Data\InvoiceItemInterface $entity The invoice item. + * @return \Magento\Sales\Api\Data\InvoiceItemInterface Invoice item interface. */ public function save(\Magento\Sales\Api\Data\InvoiceItemInterface $entity); } diff --git a/app/code/Magento/Sales/Api/InvoiceManagementInterface.php b/app/code/Magento/Sales/Api/InvoiceManagementInterface.php index d2a67c87aad34..456ce7ef40a9f 100644 --- a/app/code/Magento/Sales/Api/InvoiceManagementInterface.php +++ b/app/code/Magento/Sales/Api/InvoiceManagementInterface.php @@ -5,12 +5,14 @@ namespace Magento\Sales\Api; /** - * Interface InvoiceManagementInterface + * Invoice management interface. + * + * An invoice is a record of the receipt of payment for an order. */ interface InvoiceManagementInterface { /** - * Set invoice capture + * Sets invoice capture. * * @param int $id * @return string @@ -18,24 +20,25 @@ interface InvoiceManagementInterface public function setCapture($id); /** - * Returns list of comments attached to invoice - * @param int $id - * @return \Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface + * Lists comments for a specified invoice. + * + * @param int $id The invoice ID. + * @return \Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface Invoice comment search result interface. */ public function getCommentsList($id); /** - * Notify user + * Emails a user a specified invoice. * - * @param int $id + * @param int $id The invoice ID. * @return bool */ public function notify($id); /** - * Set invoice void + * Voids a specified invoice. * - * @param int $id + * @param int $id The invoice ID. * @return bool */ public function setVoid($id); diff --git a/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php b/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php index e26196118ecf7..eeb025d497ce6 100644 --- a/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php @@ -5,37 +5,41 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Invoice repository interface. + * + * An invoice is a record of the receipt of payment for an order. */ interface InvoiceRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\InvoiceSearchResultInterface + * Lists invoices that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\InvoiceSearchResultInterface Invoice search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified invoice. * - * @param int $id - * @return \Magento\Sales\Api\Data\InvoiceInterface + * @param int $id The invoice ID. + * @return \Magento\Sales\Api\Data\InvoiceInterface Invoice interface. */ public function get($id); /** - * Delete entity + * Deletes a specified invoice. * - * @param \Magento\Sales\Api\Data\InvoiceInterface $entity + * @param \Magento\Sales\Api\Data\InvoiceInterface $entity The invoice. * @return bool */ public function delete(\Magento\Sales\Api\Data\InvoiceInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified invoice. * - * @param \Magento\Sales\Api\Data\InvoiceInterface $entity - * @return \Magento\Sales\Api\Data\InvoiceInterface + * @param \Magento\Sales\Api\Data\InvoiceInterface $entity The invoice. + * @return \Magento\Sales\Api\Data\InvoiceInterface Invoice interface. */ public function save(\Magento\Sales\Api\Data\InvoiceInterface $entity); } diff --git a/app/code/Magento/Sales/Api/OrderAddressRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderAddressRepositoryInterface.php index 8577230b45ea3..2ce66c0592e63 100644 --- a/app/code/Magento/Sales/Api/OrderAddressRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/OrderAddressRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Order address repository interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderAddressRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\OrderAddressSearchResultInterface + * Lists order addresses that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\OrderAddressSearchResultInterface Order address search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified order address. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderAddressInterface + * @param int $id The order address ID. + * @return \Magento\Sales\Api\Data\OrderAddressInterface Order address interface. */ public function get($id); /** - * Delete entity + * Deletes a specified order address. * - * @param \Magento\Sales\Api\Data\OrderAddressInterface $entity + * @param \Magento\Sales\Api\Data\OrderAddressInterface $entity The order address. * @return bool */ public function delete(\Magento\Sales\Api\Data\OrderAddressInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified order address. * - * @param \Magento\Sales\Api\Data\OrderAddressInterface $entity - * @return \Magento\Sales\Api\Data\OrderAddressInterface + * @param \Magento\Sales\Api\Data\OrderAddressInterface $entity The order address. + * @return \Magento\Sales\Api\Data\OrderAddressInterface Order address interface. */ public function save(\Magento\Sales\Api\Data\OrderAddressInterface $entity); } diff --git a/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php index c93214fdbbe4a..69fd7b5569428 100644 --- a/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Order item repository interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderItemRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\OrderItemSearchResultInterface + * Lists order items that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\OrderItemSearchResultInterface Order item search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified order item. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderItemInterface + * @param int $id The order item ID. + * @return \Magento\Sales\Api\Data\OrderItemInterface Order item interface. */ public function get($id); /** - * Delete entity + * Deletes a specified order item. * - * @param \Magento\Sales\Api\Data\OrderItemInterface $entity + * @param \Magento\Sales\Api\Data\OrderItemInterface $entity The order item. * @return bool */ public function delete(\Magento\Sales\Api\Data\OrderItemInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified order item. * - * @param \Magento\Sales\Api\Data\OrderItemInterface $entity - * @return \Magento\Sales\Api\Data\OrderItemInterface + * @param \Magento\Sales\Api\Data\OrderItemInterface $entity The order item. + * @return \Magento\Sales\Api\Data\OrderItemInterface Order item interface. */ public function save(\Magento\Sales\Api\Data\OrderItemInterface $entity); } diff --git a/app/code/Magento/Sales/Api/OrderManagementInterface.php b/app/code/Magento/Sales/Api/OrderManagementInterface.php index f65062b55f4f9..0d32179b90f8f 100644 --- a/app/code/Magento/Sales/Api/OrderManagementInterface.php +++ b/app/code/Magento/Sales/Api/OrderManagementInterface.php @@ -5,63 +5,67 @@ namespace Magento\Sales\Api; /** - * Interface OrderManagementInterface + * Order management interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderManagementInterface { /** - * Order cancel + * Cancels a specified order. * - * @param int $id + * @param int $id The order ID. * @return bool */ public function cancel($id); /** - * Returns list of comments attached to order + * Lists comments for a specified order. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface + * @param int $id The order ID. + * @return \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface Order status history search results interface. */ public function getCommentsList($id); /** - * Add comment to order + * Adds a comment to a specified order. * - * @param int $id - * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory + * @param int $id The order ID. + * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory Status history comment. * @return bool */ public function addComment($id, \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory); /** - * Notify user + * Emails a user a specified order. * - * @param int $id + * @param int $id The order ID. * @return bool */ public function notify($id); /** - * Returns order status + * Gets the status for a specified order. * - * @param int $id - * @return string + * @param int $id The order ID. + * @return string Order status. */ public function getStatus($id); /** - * Order hold + * Holds a specified order. * - * @param int $id + * @param int $id The order ID. * @return bool */ public function hold($id); /** - * Order un hold + * Releases a specified order from hold status. * - * @param int $id + * @param int $id The order ID. * @return bool */ public function unHold($id); diff --git a/app/code/Magento/Sales/Api/OrderPaymentRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderPaymentRepositoryInterface.php index 131d53dff3b21..4f962f6ac2e96 100644 --- a/app/code/Magento/Sales/Api/OrderPaymentRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/OrderPaymentRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Order payment repository interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderPaymentRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\OrderPaymentSearchResultInterface + * Lists order payments that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\OrderPaymentSearchResultInterface Order payment search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified order payment. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderPaymentInterface + * @param int $id The order payment ID. + * @return \Magento\Sales\Api\Data\OrderPaymentInterface Order payment interface. */ public function get($id); /** - * Delete entity + * Deletes a specified order payment. * - * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity + * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity The order payment ID. * @return bool */ public function delete(\Magento\Sales\Api\Data\OrderPaymentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified order payment. * - * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity - * @return \Magento\Sales\Api\Data\OrderPaymentInterface + * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity The order payment ID. + * @return \Magento\Sales\Api\Data\OrderPaymentInterface Order payment interface. */ public function save(\Magento\Sales\Api\Data\OrderPaymentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/OrderRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderRepositoryInterface.php index 2f8c5e3bc7e0a..fd01cc163b587 100644 --- a/app/code/Magento/Sales/Api/OrderRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/OrderRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Order repository interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\OrderSearchResultInterface + * Lists orders that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\OrderSearchResultInterface Order search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified order. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderInterface + * @param int $id The order ID. + * @return \Magento\Sales\Api\Data\OrderInterface Order interface. */ public function get($id); /** - * Delete entity + * Deletes a specified order. * - * @param \Magento\Sales\Api\Data\OrderInterface $entity + * @param \Magento\Sales\Api\Data\OrderInterface $entity The order ID. * @return bool */ public function delete(\Magento\Sales\Api\Data\OrderInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified order. * - * @param \Magento\Sales\Api\Data\OrderInterface $entity - * @return \Magento\Sales\Api\Data\OrderInterface + * @param \Magento\Sales\Api\Data\OrderInterface $entity The order ID. + * @return \Magento\Sales\Api\Data\OrderInterface Order interface. */ public function save(\Magento\Sales\Api\Data\OrderInterface $entity); } diff --git a/app/code/Magento/Sales/Api/OrderStatusHistoryRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderStatusHistoryRepositoryInterface.php index 38a4cc07abdfe..bb832f7f15bc2 100644 --- a/app/code/Magento/Sales/Api/OrderStatusHistoryRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/OrderStatusHistoryRepositoryInterface.php @@ -5,37 +5,43 @@ namespace Magento\Sales\Api; /** - * Interface RepositoryInterface + * Order status history repository interface. + * + * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product + * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as + * a purchase order, is emailed to the customer. */ interface OrderStatusHistoryRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface + * Lists order status history comments that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface Order status history search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified order status comment. * - * @param int $id - * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface + * @param int $id The order status comment ID. + * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface Order status history interface. */ public function get($id); /** - * Delete entity + * Deletes a specified order status comment. * - * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity + * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity The order status comment. * @return bool */ public function delete(\Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified order status comment. * - * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity - * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface + * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity The order status comment. + * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface Order status history interface. */ public function save(\Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity); } diff --git a/app/code/Magento/Sales/Api/ShipmentCommentRepositoryInterface.php b/app/code/Magento/Sales/Api/ShipmentCommentRepositoryInterface.php index deca5a9776f6f..6fc03862ae6cf 100644 --- a/app/code/Magento/Sales/Api/ShipmentCommentRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/ShipmentCommentRepositoryInterface.php @@ -5,37 +5,42 @@ namespace Magento\Sales\Api; /** - * Interface ShipmentCommentRepositoryInterface + * Shipment comment 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. A shipment document can contain comments. */ interface ShipmentCommentRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface + * Lists shipment comments that match specific search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface Shipment comment search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified shipment comment. * - * @param int $id - * @return \Magento\Sales\Api\Data\ShipmentCommentInterface + * @param int $id The shipment comment ID. + * @return \Magento\Sales\Api\Data\ShipmentCommentInterface Shipment comment interface. */ public function get($id); /** - * Delete entity + * Deletes a specified shipment comment. * - * @param \Magento\Sales\Api\Data\ShipmentCommentInterface $entity + * @param \Magento\Sales\Api\Data\ShipmentCommentInterface $entity The shipment comment. * @return bool */ public function delete(\Magento\Sales\Api\Data\ShipmentCommentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified shipment comment. * - * @param \Magento\Sales\Api\Data\ShipmentCommentInterface $entity - * @return \Magento\Sales\Api\Data\ShipmentCommentInterface + * @param \Magento\Sales\Api\Data\ShipmentCommentInterface $entity The shipment comment. + * @return \Magento\Sales\Api\Data\ShipmentCommentInterface Shipment comment interface. */ public function save(\Magento\Sales\Api\Data\ShipmentCommentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/ShipmentItemRepositoryInterface.php b/app/code/Magento/Sales/Api/ShipmentItemRepositoryInterface.php index 99b61f4ad5e8f..8793d121cdfc4 100644 --- a/app/code/Magento/Sales/Api/ShipmentItemRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/ShipmentItemRepositoryInterface.php @@ -2,22 +2,26 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api; /** - * Interface ShipmentItemRepositoryInterface + * Shipment item 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. A product is an item in a shipment. */ interface ShipmentItemRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\ShipmentItemSearchResultInterface + * Lists shipment items that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\ShipmentItemSearchResultInterface Shipment item search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified shipment item. * * @param int $id * @return \Magento\Sales\Api\Data\ShipmentInterface @@ -25,18 +29,18 @@ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); public function get($id); /** - * Delete entity + * Deletes a specified shipment item. * - * @param \Magento\Sales\Api\Data\ShipmentInterface $entity + * @param \Magento\Sales\Api\Data\ShipmentInterface $entity The shipment item. * @return bool */ public function delete(\Magento\Sales\Api\Data\ShipmentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified shipment item. * - * @param \Magento\Sales\Api\Data\ShipmentInterface $entity - * @return \Magento\Sales\Api\Data\ShipmentInterface + * @param \Magento\Sales\Api\Data\ShipmentInterface $entity The shipment item. + * @return \Magento\Sales\Api\Data\ShipmentInterface Shipment interface. */ public function save(\Magento\Sales\Api\Data\ShipmentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/ShipmentManagementInterface.php b/app/code/Magento/Sales/Api/ShipmentManagementInterface.php index 9b735e62da7e1..5dd8abf38dc12 100644 --- a/app/code/Magento/Sales/Api/ShipmentManagementInterface.php +++ b/app/code/Magento/Sales/Api/ShipmentManagementInterface.php @@ -5,29 +5,33 @@ namespace Magento\Sales\Api; /** - * Interface ShipmentManagementInterface + * 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. */ interface ShipmentManagementInterface { /** - * Returns shipment label + * Gets a specified shipment label. * - * @param int $id - * @return string + * @param int $id The shipment label ID. + * @return string Shipment label. */ public function getLabel($id); /** - * Returns list of comments attached to shipment - * @param int $id - * @return \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface + * Lists comments for a specified shipment. + * + * @param int $id The shipment ID. + * @return \Magento\Sales\Api\Data\ShipmentCommentSearchResultInterface Shipment comment search result interface. */ public function getCommentsList($id); /** - * Notify user + * Emails user a specified shipment. * - * @param int $id + * @param int $id The shipment ID. * @return bool */ public function notify($id); diff --git a/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php b/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php index ae850fd1c43a7..5ac5a6fef046f 100644 --- a/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php @@ -2,41 +2,45 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api; /** - * Interface ShipmentRepositoryInterface + * 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. */ interface ShipmentRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\ShipmentSearchResultInterface + * Lists shipments that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\ShipmentSearchResultInterface Shipment search results interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified shipment. * - * @param int $id + * @param int $id The shipment ID. * @return \Magento\Sales\Api\Data\ShipmentInterface */ public function get($id); /** - * Delete entity + * Deletes a specified shipment. * - * @param \Magento\Sales\Api\Data\ShipmentInterface $entity + * @param \Magento\Sales\Api\Data\ShipmentInterface $entity The shipment. * @return bool */ public function delete(\Magento\Sales\Api\Data\ShipmentInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified shipment. * - * @param \Magento\Sales\Api\Data\ShipmentInterface $entity - * @return \Magento\Sales\Api\Data\ShipmentInterface + * @param \Magento\Sales\Api\Data\ShipmentInterface $entity The shipment. + * @return \Magento\Sales\Api\Data\ShipmentInterface Shipment interface. */ public function save(\Magento\Sales\Api\Data\ShipmentInterface $entity); } diff --git a/app/code/Magento/Sales/Api/ShipmentTrackRepositoryInterface.php b/app/code/Magento/Sales/Api/ShipmentTrackRepositoryInterface.php index e0e915f749e13..8910b5c142f3b 100644 --- a/app/code/Magento/Sales/Api/ShipmentTrackRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/ShipmentTrackRepositoryInterface.php @@ -2,47 +2,52 @@ /** * @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com) */ - namespace Magento\Sales\Api; /** - * Interface ShipmentTrackRepositoryInterface + * Shipment track 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. */ interface ShipmentTrackRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\ShipmentTrackSearchResultInterface + * Lists shipment tracks that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\ShipmentTrackSearchResultInterface Shipment track search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified shipment track. * - * @param int $id - * @return \Magento\Sales\Api\Data\ShipmentTrackInterface + * @param int $id The shipment track ID. + * @return \Magento\Sales\Api\Data\ShipmentTrackInterface Shipment track interface. */ public function get($id); /** - * Delete entity + * Deletes a specified shipment track. * - * @param \Magento\Sales\Api\Data\ShipmentTrackInterface $entity + * @param \Magento\Sales\Api\Data\ShipmentTrackInterface $entity The shipment track. * @return bool */ public function delete(\Magento\Sales\Api\Data\ShipmentTrackInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified shipment track. * - * @param \Magento\Sales\Api\Data\ShipmentTrackInterface $entity - * @return \Magento\Sales\Api\Data\ShipmentTrackInterface + * @param \Magento\Sales\Api\Data\ShipmentTrackInterface $entity The shipment track. + * @return \Magento\Sales\Api\Data\ShipmentTrackInterface Shipment track interface. */ public function save(\Magento\Sales\Api\Data\ShipmentTrackInterface $entity); /** - * Delete entity by Id - * @param int $id + * Deletes a specified shipment track by ID. + * + * @param int $id The shipment track ID. * @return bool */ public function deleteById($id); diff --git a/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php b/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php index 4d5e755263619..67e6cfec367c5 100644 --- a/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php +++ b/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php @@ -5,37 +5,41 @@ namespace Magento\Sales\Api; /** - * Interface TransactionRepositoryInterface + * Transaction repository interface. + * + * A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on. */ interface TransactionRepositoryInterface { /** - * @param \Magento\Framework\Api\SearchCriteria $criteria - * @return \Magento\Sales\Api\Data\TransactionSearchResultInterface + * Lists transactions that match specified search criteria. + * + * @param \Magento\Framework\Api\SearchCriteria $criteria The search criteria. + * @return \Magento\Sales\Api\Data\TransactionSearchResultInterface Transaction search result interface. */ public function getList(\Magento\Framework\Api\SearchCriteria $criteria); /** - * Load entity + * Loads a specified transaction. * - * @param int $id - * @return \Magento\Sales\Api\Data\TransactionInterface + * @param int $id The transaction ID. + * @return \Magento\Sales\Api\Data\TransactionInterface Transaction interface. */ public function get($id); /** - * Delete entity + * Deletes a specified transaction. * - * @param \Magento\Sales\Api\Data\TransactionInterface $entity + * @param \Magento\Sales\Api\Data\TransactionInterface $entity The transaction. * @return bool */ public function delete(\Magento\Sales\Api\Data\TransactionInterface $entity); /** - * Perform persist operations for one entity + * Performs persist operations for a specified transaction. * - * @param \Magento\Sales\Api\Data\TransactionInterface $entity - * @return \Magento\Sales\Api\Data\TransactionInterface + * @param \Magento\Sales\Api\Data\TransactionInterface $entity The transaction. + * @return \Magento\Sales\Api\Data\TransactionInterface Transaction interface. */ public function save(\Magento\Sales\Api\Data\TransactionInterface $entity); }