OrderItemInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Sales\Api\Data;

interface OrderItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
    /*
     * 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';
    /*
     * 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';
    /*
     * Discount tax compensation amount.
     */
    const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount';
    /*
     * Base discount tax compensation amount.
     */
    const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
    /*
     * Discount tax compensation invoiced.
     */
    const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced';
    /*
     * Base discount tax compensation invoiced.
     */
    const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced';
    /*
     * Discount tax compensation refunded.
     */
    const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded';
    /*
     * Base discount tax compensation refunded.
     */
    const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded';
    /*
     * Tax canceled flag
     */
    const TAX_CANCELED = 'tax_canceled';
    /*
     * Discount-tax-compensation-canceled flag.
     */
    const DISCOUNT_TAX_COMPENSATION_CANCELED = 'discount_tax_compensation_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';

    const PARENT_ITEM = 'parent_item';

    const KEY_PRODUCT_OPTION = 'product_option';

    public function getAdditionalData();

    public function getAmountRefunded();

    public function getAppliedRuleIds();

    public function getBaseAmountRefunded();

    public function getBaseCost();

    public function getBaseDiscountAmount();

    public function getBaseDiscountInvoiced();

    public function getBaseDiscountRefunded();

    public function getBaseDiscountTaxCompensationAmount();

    public function getBaseDiscountTaxCompensationInvoiced();

    public function getBaseDiscountTaxCompensationRefunded();

    public function getBaseOriginalPrice();

    public function getBasePrice();

    public function getBasePriceInclTax();

    public function getBaseRowInvoiced();

    public function getBaseRowTotal();

    public function getBaseRowTotalInclTax();

    public function getBaseTaxAmount();

    public function getBaseTaxBeforeDiscount();

    public function getBaseTaxInvoiced();

    public function getBaseTaxRefunded();

    public function getBaseWeeeTaxAppliedAmount();

    public function getBaseWeeeTaxAppliedRowAmnt();

    public function getBaseWeeeTaxDisposition();

    public function getBaseWeeeTaxRowDisposition();

    public function getCreatedAt();

    public function setCreatedAt($createdAt);

    public function getDescription();

    public function getDiscountAmount();

    public function getDiscountInvoiced();

    public function getDiscountPercent();

    public function getDiscountRefunded();

    public function getEventId();

    public function getExtOrderItemId();

    public function getFreeShipping();

    public function getGwBasePrice();

    public function getGwBasePriceInvoiced();

    public function getGwBasePriceRefunded();

    public function getGwBaseTaxAmount();

    public function getGwBaseTaxAmountInvoiced();

    public function getGwBaseTaxAmountRefunded();

    public function getGwId();

    public function getGwPrice();

    public function getGwPriceInvoiced();

    public function getGwPriceRefunded();

    public function getGwTaxAmount();

    public function getGwTaxAmountInvoiced();

    public function getGwTaxAmountRefunded();

    public function getDiscountTaxCompensationAmount();

    public function getDiscountTaxCompensationCanceled();

    public function getDiscountTaxCompensationInvoiced();

    public function getDiscountTaxCompensationRefunded();

    public function getIsQtyDecimal();

    public function getIsVirtual();

    public function getItemId();

    public function getLockedDoInvoice();

    public function getLockedDoShip();

    public function getName();

    public function getNoDiscount();

    public function getOrderId();

    public function getOriginalPrice();

    public function getParentItemId();

    public function getPrice();

    public function getPriceInclTax();

    public function getProductId();

    public function getProductType();

    public function getQtyBackordered();

    public function getQtyCanceled();

    public function getQtyInvoiced();

    public function getQtyOrdered();

    public function getQtyRefunded();

    public function getQtyReturned();

    public function getQtyShipped();

    public function getQuoteItemId();

    public function getRowInvoiced();

    public function getRowTotal();

    public function getRowTotalInclTax();

    public function getRowWeight();

    public function getSku();

    public function getStoreId();

    public function getTaxAmount();

    public function getTaxBeforeDiscount();

    public function getTaxCanceled();

    public function getTaxInvoiced();

    public function getTaxPercent();

    public function getTaxRefunded();

    public function getUpdatedAt();

    public function getWeeeTaxApplied();

    public function getWeeeTaxAppliedAmount();

    public function getWeeeTaxAppliedRowAmount();

    public function getWeeeTaxDisposition();

    public function getWeeeTaxRowDisposition();

    public function getWeight();

    public function getParentItem();

    public function setParentItem($parentItem);

    public function setUpdatedAt($timestamp);

    public function setItemId($id);

    public function setOrderId($id);

    public function setParentItemId($id);

    public function setQuoteItemId($id);

    public function setStoreId($id);

    public function setProductId($id);

    public function setProductType($productType);

    public function setWeight($weight);

    public function setIsVirtual($isVirtual);

    public function setSku($sku);

    public function setName($name);

    public function setDescription($description);

    public function setAppliedRuleIds($appliedRuleIds);

    public function setAdditionalData($additionalData);

    public function setIsQtyDecimal($isQtyDecimal);

    public function setNoDiscount($noDiscount);

    public function setQtyBackordered($qtyBackordered);

    public function setQtyCanceled($qtyCanceled);

    public function setQtyInvoiced($qtyInvoiced);

    public function setQtyOrdered($qtyOrdered);

    public function setQtyRefunded($qtyRefunded);

    public function setQtyShipped($qtyShipped);

    public function setBaseCost($baseCost);

    public function setPrice($price);

    public function setBasePrice($price);

    public function setOriginalPrice($price);

    public function setBaseOriginalPrice($price);

    public function setTaxPercent($taxPercent);

    public function setTaxAmount($amount);

    public function setBaseTaxAmount($amount);

    public function setTaxInvoiced($taxInvoiced);

    public function setBaseTaxInvoiced($baseTaxInvoiced);

    public function setDiscountPercent($discountPercent);

    public function setDiscountAmount($amount);

    public function setBaseDiscountAmount($amount);

    public function setDiscountInvoiced($discountInvoiced);

    public function setBaseDiscountInvoiced($baseDiscountInvoiced);

    public function setAmountRefunded($amountRefunded);

    public function setBaseAmountRefunded($baseAmountRefunded);

    public function setRowTotal($amount);

    public function setBaseRowTotal($amount);

    public function setRowInvoiced($rowInvoiced);

    public function setBaseRowInvoiced($baseRowInvoiced);

    public function setRowWeight($rowWeight);

    public function setBaseTaxBeforeDiscount($baseTaxBeforeDiscount);

    public function setTaxBeforeDiscount($taxBeforeDiscount);

    public function setExtOrderItemId($id);

    public function setLockedDoInvoice($flag);

    public function setLockedDoShip($flag);

    public function setPriceInclTax($amount);

    public function setBasePriceInclTax($amount);

    public function setRowTotalInclTax($amount);

    public function setBaseRowTotalInclTax($amount);

    public function setDiscountTaxCompensationAmount($amount);

    public function setBaseDiscountTaxCompensationAmount($amount);

    public function setDiscountTaxCompensationInvoiced($discountTaxCompensationInvoiced);

    public function setBaseDiscountTaxCompensationInvoiced($baseDiscountTaxCompensationInvoiced);

    public function setDiscountTaxCompensationRefunded($discountTaxCompensationRefunded);

    public function setBaseDiscountTaxCompensationRefunded($baseDiscountTaxCompensationRefunded);

    public function setTaxCanceled($taxCanceled);

    public function setDiscountTaxCompensationCanceled($discountTaxCompensationCanceled);

    public function setTaxRefunded($taxRefunded);

    public function setBaseTaxRefunded($baseTaxRefunded);

    public function setDiscountRefunded($discountRefunded);

    public function setBaseDiscountRefunded($baseDiscountRefunded);

    public function setGwId($id);

    public function setGwBasePrice($price);

    public function setGwPrice($price);

    public function setGwBaseTaxAmount($amount);

    public function setGwTaxAmount($amount);

    public function setGwBasePriceInvoiced($gwBasePriceInvoiced);

    public function setGwPriceInvoiced($gwPriceInvoiced);

    public function setGwBaseTaxAmountInvoiced($gwBaseTaxAmountInvoiced);

    public function setGwTaxAmountInvoiced($gwTaxAmountInvoiced);

    public function setGwBasePriceRefunded($gwBasePriceRefunded);

    public function setGwPriceRefunded($gwPriceRefunded);

    public function setGwBaseTaxAmountRefunded($gwBaseTaxAmountRefunded);

    public function setGwTaxAmountRefunded($gwTaxAmountRefunded);

    public function setFreeShipping($freeShipping);

    public function setQtyReturned($qtyReturned);

    public function setEventId($id);

    public function setBaseWeeeTaxAppliedAmount($amount);

    public function setBaseWeeeTaxAppliedRowAmnt($amnt);

    public function setWeeeTaxAppliedAmount($amount);

    public function setWeeeTaxAppliedRowAmount($amount);

    public function setWeeeTaxApplied($weeeTaxApplied);

    public function setWeeeTaxDisposition($weeeTaxDisposition);

    public function setWeeeTaxRowDisposition($weeeTaxRowDisposition);

    public function setBaseWeeeTaxDisposition($baseWeeeTaxDisposition);

    public function setBaseWeeeTaxRowDisposition($baseWeeeTaxRowDisposition);

    public function getProductOption();

    public function setProductOption(\Magento\Catalog\Api\Data\ProductOptionInterface $productOption);

    public function getExtensionAttributes();

    public function setExtensionAttributes(\Magento\Sales\Api\Data\OrderItemExtensionInterface $extensionAttributes);
}