Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
Data Fields | |
const | ITEM_ID = 'item_id' |
const | ORDER_ID = 'order_id' |
const | PARENT_ITEM_ID = 'parent_item_id' |
const | QUOTE_ITEM_ID = 'quote_item_id' |
const | STORE_ID = 'store_id' |
const | CREATED_AT = 'created_at' |
const | UPDATED_AT = 'updated_at' |
const | PRODUCT_ID = 'product_id' |
const | PRODUCT_TYPE = 'product_type' |
const | WEIGHT = 'weight' |
const | IS_VIRTUAL = 'is_virtual' |
const | SKU = 'sku' |
const | NAME = 'name' |
const | DESCRIPTION = 'description' |
const | APPLIED_RULE_IDS = 'applied_rule_ids' |
const | ADDITIONAL_DATA = 'additional_data' |
const | IS_QTY_DECIMAL = 'is_qty_decimal' |
const | NO_DISCOUNT = 'no_discount' |
const | QTY_BACKORDERED = 'qty_backordered' |
const | QTY_CANCELED = 'qty_canceled' |
const | QTY_INVOICED = 'qty_invoiced' |
const | QTY_ORDERED = 'qty_ordered' |
const | QTY_REFUNDED = 'qty_refunded' |
const | QTY_SHIPPED = 'qty_shipped' |
const | BASE_COST = 'base_cost' |
const | PRICE = 'price' |
const | BASE_PRICE = 'base_price' |
const | ORIGINAL_PRICE = 'original_price' |
const | BASE_ORIGINAL_PRICE = 'base_original_price' |
const | TAX_PERCENT = 'tax_percent' |
const | TAX_AMOUNT = 'tax_amount' |
const | BASE_TAX_AMOUNT = 'base_tax_amount' |
const | TAX_INVOICED = 'tax_invoiced' |
const | BASE_TAX_INVOICED = 'base_tax_invoiced' |
const | DISCOUNT_PERCENT = 'discount_percent' |
const | DISCOUNT_AMOUNT = 'discount_amount' |
const | BASE_DISCOUNT_AMOUNT = 'base_discount_amount' |
const | DISCOUNT_INVOICED = 'discount_invoiced' |
const | BASE_DISCOUNT_INVOICED = 'base_discount_invoiced' |
const | AMOUNT_REFUNDED = 'amount_refunded' |
const | BASE_AMOUNT_REFUNDED = 'base_amount_refunded' |
const | ROW_TOTAL = 'row_total' |
const | BASE_ROW_TOTAL = 'base_row_total' |
const | ROW_INVOICED = 'row_invoiced' |
const | BASE_ROW_INVOICED = 'base_row_invoiced' |
const | ROW_WEIGHT = 'row_weight' |
const | BASE_TAX_BEFORE_DISCOUNT = 'base_tax_before_discount' |
const | TAX_BEFORE_DISCOUNT = 'tax_before_discount' |
const | EXT_ORDER_ITEM_ID = 'ext_order_item_id' |
const | LOCKED_DO_INVOICE = 'locked_do_invoice' |
const | LOCKED_DO_SHIP = 'locked_do_ship' |
const | PRICE_INCL_TAX = 'price_incl_tax' |
const | BASE_PRICE_INCL_TAX = 'base_price_incl_tax' |
const | ROW_TOTAL_INCL_TAX = 'row_total_incl_tax' |
const | BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax' |
const | DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount' |
const | BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount' |
const | DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced' |
const | BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced' |
const | DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded' |
const | BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded' |
const | TAX_CANCELED = 'tax_canceled' |
const | DISCOUNT_TAX_COMPENSATION_CANCELED = 'discount_tax_compensation_canceled' |
const | TAX_REFUNDED = 'tax_refunded' |
const | BASE_TAX_REFUNDED = 'base_tax_refunded' |
const | DISCOUNT_REFUNDED = 'discount_refunded' |
const | BASE_DISCOUNT_REFUNDED = 'base_discount_refunded' |
const | GW_ID = 'gw_id' |
const | GW_BASE_PRICE = 'gw_base_price' |
const | GW_PRICE = 'gw_price' |
const | GW_BASE_TAX_AMOUNT = 'gw_base_tax_amount' |
const | GW_TAX_AMOUNT = 'gw_tax_amount' |
const | GW_BASE_PRICE_INVOICED = 'gw_base_price_invoiced' |
const | GW_PRICE_INVOICED = 'gw_price_invoiced' |
const | GW_BASE_TAX_AMOUNT_INVOICED = 'gw_base_tax_amount_invoiced' |
const | GW_TAX_AMOUNT_INVOICED = 'gw_tax_amount_invoiced' |
const | GW_BASE_PRICE_REFUNDED = 'gw_base_price_refunded' |
const | GW_PRICE_REFUNDED = 'gw_price_refunded' |
const | GW_BASE_TAX_AMOUNT_REFUNDED = 'gw_base_tax_amount_refunded' |
const | GW_TAX_AMOUNT_REFUNDED = 'gw_tax_amount_refunded' |
const | FREE_SHIPPING = 'free_shipping' |
const | QTY_RETURNED = 'qty_returned' |
const | EVENT_ID = 'event_id' |
const | BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount' |
const | BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt' |
const | WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount' |
const | WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount' |
const | WEEE_TAX_APPLIED = 'weee_tax_applied' |
const | WEEE_TAX_DISPOSITION = 'weee_tax_disposition' |
const | WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition' |
const | BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition' |
const | BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition' |
const | PARENT_ITEM = 'parent_item' |
const | KEY_PRODUCT_OPTION = 'product_option' |
![]() | |
const | EXTENSION_ATTRIBUTES_KEY = 'extension_attributes' |
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. @api
Definition at line 17 of file OrderItemInterface.php.
getAdditionalData | ( | ) |
Gets the additional data for the order item.
Implemented in Item.
getAmountRefunded | ( | ) |
Gets the amount refunded for the order item.
Implemented in Item.
getAppliedRuleIds | ( | ) |
Gets the applied rule IDs for the order item.
Implemented in Item.
getBaseAmountRefunded | ( | ) |
Gets the base amount refunded for the order item.
Implemented in Item.
getBaseCost | ( | ) |
getBaseDiscountAmount | ( | ) |
Gets the base discount amount for the order item.
Implemented in Item.
getBaseDiscountInvoiced | ( | ) |
Gets the base discount invoiced for the order item.
Implemented in Item.
getBaseDiscountRefunded | ( | ) |
Gets the base discount refunded for the order item.
Implemented in Item.
getBaseDiscountTaxCompensationAmount | ( | ) |
Gets the base discount tax compensation amount for the order item.
Implemented in Item.
getBaseDiscountTaxCompensationInvoiced | ( | ) |
Gets the base discount tax compensation invoiced for the order item.
Implemented in Item.
getBaseDiscountTaxCompensationRefunded | ( | ) |
Gets the base discount tax compensation refunded for the order item.
Implemented in Item.
getBaseOriginalPrice | ( | ) |
Gets the base original price for the order item.
Implemented in Item.
getBasePrice | ( | ) |
getBasePriceInclTax | ( | ) |
Gets the base price including tax for the order item.
Implemented in Item.
getBaseRowInvoiced | ( | ) |
Gets the base row invoiced for the order item.
Implemented in Item.
getBaseRowTotal | ( | ) |
getBaseRowTotalInclTax | ( | ) |
Gets the base row total including tax for the order item.
Implemented in Item.
getBaseTaxAmount | ( | ) |
Gets the base tax amount for the order item.
Implemented in Item.
getBaseTaxBeforeDiscount | ( | ) |
Gets the base tax before discount for the order item.
Implemented in Item.
getBaseTaxInvoiced | ( | ) |
Gets the base tax invoiced for the order item.
Implemented in Item.
getBaseTaxRefunded | ( | ) |
Gets the base tax refunded for the order item.
Implemented in Item.
getBaseWeeeTaxAppliedAmount | ( | ) |
Gets the base WEEE tax applied amount for the order item.
Implemented in Item.
getBaseWeeeTaxAppliedRowAmnt | ( | ) |
Gets the base WEEE tax applied row amount for the order item.
Implemented in Item.
getBaseWeeeTaxDisposition | ( | ) |
Gets the base WEEE tax disposition for the order item.
Implemented in Item.
getBaseWeeeTaxRowDisposition | ( | ) |
Gets the base WEEE tax row disposition for the order item.
Implemented in Item.
getCreatedAt | ( | ) |
Gets the created-at timestamp for the order item.
Implemented in Item.
getDescription | ( | ) |
getDiscountAmount | ( | ) |
Gets the discount amount for the order item.
Implemented in Item.
getDiscountInvoiced | ( | ) |
Gets the discount invoiced for the order item.
Implemented in Item.
getDiscountPercent | ( | ) |
Gets the discount percent for the order item.
Implemented in Item.
getDiscountRefunded | ( | ) |
Gets the discount refunded for the order item.
Implemented in Item.
getDiscountTaxCompensationAmount | ( | ) |
Gets the discount tax compensation amount for the order item.
Implemented in Item.
getDiscountTaxCompensationCanceled | ( | ) |
Gets the discount tax compensation canceled for the order item.
Implemented in Item.
getDiscountTaxCompensationInvoiced | ( | ) |
Gets the discount tax compensation invoiced for the order item.
Implemented in Item.
getDiscountTaxCompensationRefunded | ( | ) |
Gets the discount tax compensation refunded for the order item.
Implemented in Item.
getEventId | ( | ) |
getExtensionAttributes | ( | ) |
Retrieve existing extension attributes object or create a new one.
Implemented in Item.
getExtOrderItemId | ( | ) |
Gets the external order item ID for the order item.
Implemented in Item.
getFreeShipping | ( | ) |
Gets the free-shipping flag value for the order item.
Implemented in Item.
getGwBasePrice | ( | ) |
getGwBasePriceInvoiced | ( | ) |
Gets the GW base price invoiced for the order item.
Implemented in Item.
getGwBasePriceRefunded | ( | ) |
Gets the GW base price refunded for the order item.
Implemented in Item.
getGwBaseTaxAmount | ( | ) |
Gets the GW base tax amount for the order item.
Implemented in Item.
getGwBaseTaxAmountInvoiced | ( | ) |
Gets the GW base tax amount invoiced for the order item.
Implemented in Item.
getGwBaseTaxAmountRefunded | ( | ) |
Gets the GW base tax amount refunded for the order item.
Implemented in Item.
getGwId | ( | ) |
getGwPrice | ( | ) |
getGwPriceInvoiced | ( | ) |
Gets the GW price invoiced for the order item.
Implemented in Item.
getGwPriceRefunded | ( | ) |
Gets the GW price refunded for the order item.
Implemented in Item.
getGwTaxAmount | ( | ) |
getGwTaxAmountInvoiced | ( | ) |
Gets the GW tax amount invoiced for the order item.
Implemented in Item.
getGwTaxAmountRefunded | ( | ) |
Gets the GW tax amount refunded for the order item.
Implemented in Item.
getIsQtyDecimal | ( | ) |
Gets the is-quantity-decimal flag value for the order item.
Implemented in Item.
getIsVirtual | ( | ) |
Gets the is-virtual flag value for the order item.
Implemented in Item.
getItemId | ( | ) |
getLockedDoInvoice | ( | ) |
Gets the locked DO invoice flag value for the order item.
Implemented in Item.
getLockedDoShip | ( | ) |
Gets the locked DO ship flag value for the order item.
Implemented in Item.
getName | ( | ) |
getNoDiscount | ( | ) |
Gets the no discount flag value for the order item.
Implemented in Item.
getOrderId | ( | ) |
getOriginalPrice | ( | ) |
getParentItem | ( | ) |
Gets the parent item
Implemented in Item.
getParentItemId | ( | ) |
getPrice | ( | ) |
getPriceInclTax | ( | ) |
Gets the price including tax for the order item.
Implemented in Item.
getProductId | ( | ) |
getProductOption | ( | ) |
Returns product option
Implemented in Item.
getProductType | ( | ) |
getQtyBackordered | ( | ) |
Gets the quantity backordered for the order item.
Implemented in Item.
getQtyCanceled | ( | ) |
Gets the quantity canceled for the order item.
Implemented in Item.
getQtyInvoiced | ( | ) |
Gets the quantity invoiced for the order item.
Implemented in Item.
getQtyOrdered | ( | ) |
Gets the quantity ordered for the order item.
Implemented in Item.
getQtyRefunded | ( | ) |
Gets the quantity refunded for the order item.
Implemented in Item.
getQtyReturned | ( | ) |
Gets the quantity returned for the order item.
Implemented in Item.
getQtyShipped | ( | ) |
Gets the quantity shipped for the order item.
Implemented in Item.
getQuoteItemId | ( | ) |
getRowInvoiced | ( | ) |
getRowTotal | ( | ) |
getRowTotalInclTax | ( | ) |
Gets the row total including tax for the order item.
Implemented in Item.
getRowWeight | ( | ) |
getSku | ( | ) |
getTaxAmount | ( | ) |
getTaxBeforeDiscount | ( | ) |
getTaxCanceled | ( | ) |
getTaxInvoiced | ( | ) |
getTaxPercent | ( | ) |
getTaxRefunded | ( | ) |
getUpdatedAt | ( | ) |
Gets the updated-at timestamp for the order item.
Implemented in Item.
getWeeeTaxApplied | ( | ) |
Gets the WEEE tax applied for the order item.
Implemented in Item.
getWeeeTaxAppliedAmount | ( | ) |
Gets the WEEE tax applied amount for the order item.
Implemented in Item.
getWeeeTaxAppliedRowAmount | ( | ) |
Gets the WEEE tax applied row amount for the order item.
Implemented in Item.
getWeeeTaxDisposition | ( | ) |
Gets the WEEE tax disposition for the order item.
Implemented in Item.
getWeeeTaxRowDisposition | ( | ) |
Gets the WEEE tax row disposition for the order item.
Implemented in Item.
getWeight | ( | ) |
setAdditionalData | ( | $additionalData | ) |
Sets the additional data for the order item.
string | $additionalData |
Implemented in Item.
setAmountRefunded | ( | $amountRefunded | ) |
Sets the amount refunded for the order item.
float | $amountRefunded |
Implemented in Item.
setAppliedRuleIds | ( | $appliedRuleIds | ) |
Sets the applied rule IDs for the order item.
string | $appliedRuleIds |
Implemented in Item.
setBaseAmountRefunded | ( | $baseAmountRefunded | ) |
Sets the base amount refunded for the order item.
float | $baseAmountRefunded |
Implemented in Item.
setBaseCost | ( | $baseCost | ) |
setBaseDiscountAmount | ( | $amount | ) |
Sets the base discount amount for the order item.
float | $amount |
Implemented in Item.
setBaseDiscountInvoiced | ( | $baseDiscountInvoiced | ) |
Sets the base discount invoiced for the order item.
float | $baseDiscountInvoiced |
Implemented in Item.
setBaseDiscountRefunded | ( | $baseDiscountRefunded | ) |
Sets the base discount refunded for the order item.
float | $baseDiscountRefunded |
Implemented in Item.
setBaseDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the base discount tax compensation amount for the order item.
float | $amount |
Implemented in Item.
setBaseDiscountTaxCompensationInvoiced | ( | $baseDiscountTaxCompensationInvoiced | ) |
Sets the base discount tax compensation invoiced for the order item.
float | $baseDiscountTaxCompensationInvoiced |
Implemented in Item.
setBaseDiscountTaxCompensationRefunded | ( | $baseDiscountTaxCompensationRefunded | ) |
Sets the base discount tax compensation refunded for the order item.
float | $baseDiscountTaxCompensationRefunded |
Implemented in Item.
setBaseOriginalPrice | ( | $price | ) |
Sets the base original price for the order item.
float | $price |
Implemented in Item.
setBasePrice | ( | $price | ) |
setBasePriceInclTax | ( | $amount | ) |
Sets the base price including tax for the order item.
float | $amount |
Implemented in Item.
setBaseRowInvoiced | ( | $baseRowInvoiced | ) |
Sets the base row invoiced for the order item.
float | $baseRowInvoiced |
Implemented in Item.
setBaseRowTotal | ( | $amount | ) |
Sets the base row total for the order item.
float | $amount |
Implemented in Item.
setBaseRowTotalInclTax | ( | $amount | ) |
Sets the base row total including tax for the order item.
float | $amount |
Implemented in Item.
setBaseTaxAmount | ( | $amount | ) |
Sets the base tax amount for the order item.
float | $amount |
Implemented in Item.
setBaseTaxBeforeDiscount | ( | $baseTaxBeforeDiscount | ) |
Sets the base tax before discount for the order item.
float | $baseTaxBeforeDiscount |
Implemented in Item.
setBaseTaxInvoiced | ( | $baseTaxInvoiced | ) |
Sets the base tax invoiced for the order item.
float | $baseTaxInvoiced |
Implemented in Item.
setBaseTaxRefunded | ( | $baseTaxRefunded | ) |
Sets the base tax refunded for the order item.
float | $baseTaxRefunded |
Implemented in Item.
setBaseWeeeTaxAppliedAmount | ( | $amount | ) |
Sets the base WEEE tax applied amount for the order item.
float | $amount |
Implemented in Item.
setBaseWeeeTaxAppliedRowAmnt | ( | $amnt | ) |
Sets the base WEEE tax applied row amount for the order item.
float | $amnt |
Implemented in Item.
setBaseWeeeTaxDisposition | ( | $baseWeeeTaxDisposition | ) |
Sets the base WEEE tax disposition for the order item.
float | $baseWeeeTaxDisposition |
Implemented in Item.
setBaseWeeeTaxRowDisposition | ( | $baseWeeeTaxRowDisposition | ) |
Sets the base WEEE tax row disposition for the order item.
float | $baseWeeeTaxRowDisposition |
Implemented in Item.
setCreatedAt | ( | $createdAt | ) |
Sets the created-at timestamp for the order item.
string | $createdAt | timestamp |
Implemented in Item.
setDescription | ( | $description | ) |
Sets the description for the order item.
string | $description |
Implemented in Item.
setDiscountAmount | ( | $amount | ) |
Sets the discount amount for the order item.
float | $amount |
Implemented in Item.
setDiscountInvoiced | ( | $discountInvoiced | ) |
Sets the discount invoiced for the order item.
float | $discountInvoiced |
Implemented in Item.
setDiscountPercent | ( | $discountPercent | ) |
Sets the discount percent for the order item.
float | $discountPercent |
Implemented in Item.
setDiscountRefunded | ( | $discountRefunded | ) |
Sets the discount refunded for the order item.
float | $discountRefunded |
Implemented in Item.
setDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the discount tax compensation amount for the order item.
float | $amount |
Implemented in Item.
setDiscountTaxCompensationCanceled | ( | $discountTaxCompensationCanceled | ) |
Sets the discount tax compensation canceled for the order item.
float | $discountTaxCompensationCanceled |
Implemented in Item.
setDiscountTaxCompensationInvoiced | ( | $discountTaxCompensationInvoiced | ) |
Sets the discount tax compensation invoiced for the order item.
float | $discountTaxCompensationInvoiced |
Implemented in Item.
setDiscountTaxCompensationRefunded | ( | $discountTaxCompensationRefunded | ) |
Sets the discount tax compensation refunded for the order item.
float | $discountTaxCompensationRefunded |
Implemented in Item.
setEventId | ( | $id | ) |
setExtensionAttributes | ( | \Magento\Sales\Api\Data\OrderItemExtensionInterface | $extensionAttributes | ) |
Set an extension attributes object.
\Magento\Sales\Api\Data\OrderItemExtensionInterface | $extensionAttributes |
setExtOrderItemId | ( | $id | ) |
Sets the external order item ID for the order item.
string | $id |
Implemented in Item.
setFreeShipping | ( | $freeShipping | ) |
Sets the free-shipping flag value for the order item.
int | $freeShipping |
Implemented in Item.
setGwBasePrice | ( | $price | ) |
setGwBasePriceInvoiced | ( | $gwBasePriceInvoiced | ) |
Sets the GW base price invoiced for the order item.
float | $gwBasePriceInvoiced |
Implemented in Item.
setGwBasePriceRefunded | ( | $gwBasePriceRefunded | ) |
Sets the GW base price refunded for the order item.
float | $gwBasePriceRefunded |
Implemented in Item.
setGwBaseTaxAmount | ( | $amount | ) |
Sets the GW base tax amount for the order item.
float | $amount |
Implemented in Item.
setGwBaseTaxAmountInvoiced | ( | $gwBaseTaxAmountInvoiced | ) |
Sets the GW base tax amount invoiced for the order item.
float | $gwBaseTaxAmountInvoiced |
Implemented in Item.
setGwBaseTaxAmountRefunded | ( | $gwBaseTaxAmountRefunded | ) |
Sets the GW base tax amount refunded for the order item.
float | $gwBaseTaxAmountRefunded |
Implemented in Item.
setGwId | ( | $id | ) |
setGwPrice | ( | $price | ) |
setGwPriceInvoiced | ( | $gwPriceInvoiced | ) |
Sets the GW price invoiced for the order item.
float | $gwPriceInvoiced |
Implemented in Item.
setGwPriceRefunded | ( | $gwPriceRefunded | ) |
Sets the GW price refunded for the order item.
float | $gwPriceRefunded |
Implemented in Item.
setGwTaxAmount | ( | $amount | ) |
Sets the GW tax amount for the order item.
float | $amount |
Implemented in Item.
setGwTaxAmountInvoiced | ( | $gwTaxAmountInvoiced | ) |
Sets the GW tax amount invoiced for the order item.
float | $gwTaxAmountInvoiced |
Implemented in Item.
setGwTaxAmountRefunded | ( | $gwTaxAmountRefunded | ) |
Sets the GW tax amount refunded for the order item.
float | $gwTaxAmountRefunded |
Implemented in Item.
setIsQtyDecimal | ( | $isQtyDecimal | ) |
Sets the is-quantity-decimal flag value for the order item.
int | $isQtyDecimal |
Implemented in Item.
setIsVirtual | ( | $isVirtual | ) |
Sets the is-virtual flag value for the order item.
int | $isVirtual |
Implemented in Item.
setItemId | ( | $id | ) |
setLockedDoInvoice | ( | $flag | ) |
Sets the locked DO invoice flag value for the order item.
int | $flag |
Implemented in Item.
setLockedDoShip | ( | $flag | ) |
Sets the locked DO ship flag value for the order item.
int | $flag |
Implemented in Item.
setName | ( | $name | ) |
setNoDiscount | ( | $noDiscount | ) |
Sets the no discount flag value for the order item.
int | $noDiscount |
Implemented in Item.
setOrderId | ( | $id | ) |
setOriginalPrice | ( | $price | ) |
Sets the original price for the order item.
float | $price |
Implemented in Item.
setParentItem | ( | $parentItem | ) |
Sets the parent item
\Magento\Sales\Api\Data\OrderItemInterface | $parentItem |
Implemented in Item.
setParentItemId | ( | $id | ) |
setPrice | ( | $price | ) |
setPriceInclTax | ( | $amount | ) |
Sets the price including tax for the order item.
float | $amount |
Implemented in Item.
setProductId | ( | $id | ) |
setProductOption | ( | \Magento\Catalog\Api\Data\ProductOptionInterface | $productOption | ) |
Sets product option
\Magento\Catalog\Api\Data\ProductOptionInterface | $productOption |
setProductType | ( | $productType | ) |
Sets the product type for the order item.
string | $productType |
Implemented in Item.
setQtyBackordered | ( | $qtyBackordered | ) |
Sets the quantity backordered for the order item.
float | $qtyBackordered |
Implemented in Item.
setQtyCanceled | ( | $qtyCanceled | ) |
Sets the quantity canceled for the order item.
float | $qtyCanceled |
Implemented in Item.
setQtyInvoiced | ( | $qtyInvoiced | ) |
Sets the quantity invoiced for the order item.
float | $qtyInvoiced |
Implemented in Item.
setQtyOrdered | ( | $qtyOrdered | ) |
Sets the quantity ordered for the order item.
float | $qtyOrdered |
Implemented in Item.
setQtyRefunded | ( | $qtyRefunded | ) |
Sets the quantity refunded for the order item.
float | $qtyRefunded |
Implemented in Item.
setQtyReturned | ( | $qtyReturned | ) |
Sets the quantity returned for the order item.
float | $qtyReturned |
Implemented in Item.
setQtyShipped | ( | $qtyShipped | ) |
Sets the quantity shipped for the order item.
float | $qtyShipped |
Implemented in Item.
setQuoteItemId | ( | $id | ) |
setRowInvoiced | ( | $rowInvoiced | ) |
Sets the row invoiced for the order item.
float | $rowInvoiced |
Implemented in Item.
setRowTotal | ( | $amount | ) |
setRowTotalInclTax | ( | $amount | ) |
Sets the row total including tax for the order item.
float | $amount |
Implemented in Item.
setRowWeight | ( | $rowWeight | ) |
Sets the row weight for the order item.
float | $rowWeight |
Implemented in Item.
setSku | ( | $sku | ) |
setStoreId | ( | $id | ) |
setTaxAmount | ( | $amount | ) |
setTaxBeforeDiscount | ( | $taxBeforeDiscount | ) |
Sets the tax before discount for the order item.
float | $taxBeforeDiscount |
Implemented in Item.
setTaxCanceled | ( | $taxCanceled | ) |
Sets the tax canceled for the order item.
float | $taxCanceled |
Implemented in Item.
setTaxInvoiced | ( | $taxInvoiced | ) |
Sets the tax invoiced for the order item.
float | $taxInvoiced |
Implemented in Item.
setTaxPercent | ( | $taxPercent | ) |
Sets the tax percent for the order item.
float | $taxPercent |
Implemented in Item.
setTaxRefunded | ( | $taxRefunded | ) |
Sets the tax refunded for the order item.
float | $taxRefunded |
Implemented in Item.
setUpdatedAt | ( | $timestamp | ) |
Sets the updated-at timestamp for the order item.
string | $timestamp |
Implemented in Item.
setWeeeTaxApplied | ( | $weeeTaxApplied | ) |
Sets the WEEE tax applied for the order item.
string | $weeeTaxApplied |
Implemented in Item.
setWeeeTaxAppliedAmount | ( | $amount | ) |
Sets the WEEE tax applied amount for the order item.
float | $amount |
Implemented in Item.
setWeeeTaxAppliedRowAmount | ( | $amount | ) |
Sets the WEEE tax applied row amount for the order item.
float | $amount |
Implemented in Item.
setWeeeTaxDisposition | ( | $weeeTaxDisposition | ) |
Sets the WEEE tax disposition for the order item.
float | $weeeTaxDisposition |
Implemented in Item.
setWeeeTaxRowDisposition | ( | $weeeTaxRowDisposition | ) |
Sets the WEEE tax row disposition for the order item.
float | $weeeTaxRowDisposition |
Implemented in Item.
setWeight | ( | $weight | ) |
const ADDITIONAL_DATA = 'additional_data' |
Definition at line 85 of file OrderItemInterface.php.
const AMOUNT_REFUNDED = 'amount_refunded' |
Definition at line 181 of file OrderItemInterface.php.
const APPLIED_RULE_IDS = 'applied_rule_ids' |
Definition at line 81 of file OrderItemInterface.php.
const BASE_AMOUNT_REFUNDED = 'base_amount_refunded' |
Definition at line 185 of file OrderItemInterface.php.
const BASE_COST = 'base_cost' |
Definition at line 121 of file OrderItemInterface.php.
const BASE_DISCOUNT_AMOUNT = 'base_discount_amount' |
Definition at line 169 of file OrderItemInterface.php.
const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced' |
Definition at line 177 of file OrderItemInterface.php.
const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded' |
Definition at line 289 of file OrderItemInterface.php.
const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount' |
Definition at line 249 of file OrderItemInterface.php.
const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced' |
Definition at line 257 of file OrderItemInterface.php.
const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded' |
Definition at line 265 of file OrderItemInterface.php.
const BASE_ORIGINAL_PRICE = 'base_original_price' |
Definition at line 137 of file OrderItemInterface.php.
const BASE_PRICE = 'base_price' |
Definition at line 129 of file OrderItemInterface.php.
const BASE_PRICE_INCL_TAX = 'base_price_incl_tax' |
Definition at line 233 of file OrderItemInterface.php.
const BASE_ROW_INVOICED = 'base_row_invoiced' |
Definition at line 201 of file OrderItemInterface.php.
const BASE_ROW_TOTAL = 'base_row_total' |
Definition at line 193 of file OrderItemInterface.php.
const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax' |
Definition at line 241 of file OrderItemInterface.php.
const BASE_TAX_AMOUNT = 'base_tax_amount' |
Definition at line 149 of file OrderItemInterface.php.
const BASE_TAX_BEFORE_DISCOUNT = 'base_tax_before_discount' |
Definition at line 209 of file OrderItemInterface.php.
const BASE_TAX_INVOICED = 'base_tax_invoiced' |
Definition at line 157 of file OrderItemInterface.php.
const BASE_TAX_REFUNDED = 'base_tax_refunded' |
Definition at line 281 of file OrderItemInterface.php.
const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount' |
Definition at line 357 of file OrderItemInterface.php.
const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt' |
Definition at line 361 of file OrderItemInterface.php.
const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition' |
Definition at line 385 of file OrderItemInterface.php.
const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition' |
Definition at line 389 of file OrderItemInterface.php.
const CREATED_AT = 'created_at' |
Definition at line 45 of file OrderItemInterface.php.
const DESCRIPTION = 'description' |
Definition at line 77 of file OrderItemInterface.php.
const DISCOUNT_AMOUNT = 'discount_amount' |
Definition at line 165 of file OrderItemInterface.php.
const DISCOUNT_INVOICED = 'discount_invoiced' |
Definition at line 173 of file OrderItemInterface.php.
const DISCOUNT_PERCENT = 'discount_percent' |
Definition at line 161 of file OrderItemInterface.php.
const DISCOUNT_REFUNDED = 'discount_refunded' |
Definition at line 285 of file OrderItemInterface.php.
const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount' |
Definition at line 245 of file OrderItemInterface.php.
const DISCOUNT_TAX_COMPENSATION_CANCELED = 'discount_tax_compensation_canceled' |
Definition at line 273 of file OrderItemInterface.php.
const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced' |
Definition at line 253 of file OrderItemInterface.php.
const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded' |
Definition at line 261 of file OrderItemInterface.php.
const EVENT_ID = 'event_id' |
Definition at line 353 of file OrderItemInterface.php.
const EXT_ORDER_ITEM_ID = 'ext_order_item_id' |
Definition at line 217 of file OrderItemInterface.php.
const FREE_SHIPPING = 'free_shipping' |
Definition at line 345 of file OrderItemInterface.php.
const GW_BASE_PRICE = 'gw_base_price' |
Definition at line 297 of file OrderItemInterface.php.
const GW_BASE_PRICE_INVOICED = 'gw_base_price_invoiced' |
Definition at line 313 of file OrderItemInterface.php.
const GW_BASE_PRICE_REFUNDED = 'gw_base_price_refunded' |
Definition at line 329 of file OrderItemInterface.php.
const GW_BASE_TAX_AMOUNT = 'gw_base_tax_amount' |
Definition at line 305 of file OrderItemInterface.php.
const GW_BASE_TAX_AMOUNT_INVOICED = 'gw_base_tax_amount_invoiced' |
Definition at line 321 of file OrderItemInterface.php.
const GW_BASE_TAX_AMOUNT_REFUNDED = 'gw_base_tax_amount_refunded' |
Definition at line 337 of file OrderItemInterface.php.
const GW_ID = 'gw_id' |
Definition at line 293 of file OrderItemInterface.php.
const GW_PRICE = 'gw_price' |
Definition at line 301 of file OrderItemInterface.php.
const GW_PRICE_INVOICED = 'gw_price_invoiced' |
Definition at line 317 of file OrderItemInterface.php.
const GW_PRICE_REFUNDED = 'gw_price_refunded' |
Definition at line 333 of file OrderItemInterface.php.
const GW_TAX_AMOUNT = 'gw_tax_amount' |
Definition at line 309 of file OrderItemInterface.php.
const GW_TAX_AMOUNT_INVOICED = 'gw_tax_amount_invoiced' |
Definition at line 325 of file OrderItemInterface.php.
const GW_TAX_AMOUNT_REFUNDED = 'gw_tax_amount_refunded' |
Definition at line 341 of file OrderItemInterface.php.
const IS_QTY_DECIMAL = 'is_qty_decimal' |
Definition at line 89 of file OrderItemInterface.php.
const IS_VIRTUAL = 'is_virtual' |
Definition at line 65 of file OrderItemInterface.php.
const ITEM_ID = 'item_id' |
#+ Constants for keys of data array. Identical to the name of the getter in snake case
Definition at line 25 of file OrderItemInterface.php.
const KEY_PRODUCT_OPTION = 'product_option' |
Product Option
Definition at line 399 of file OrderItemInterface.php.
const LOCKED_DO_INVOICE = 'locked_do_invoice' |
Definition at line 221 of file OrderItemInterface.php.
const LOCKED_DO_SHIP = 'locked_do_ship' |
Definition at line 225 of file OrderItemInterface.php.
const NAME = 'name' |
Definition at line 73 of file OrderItemInterface.php.
const NO_DISCOUNT = 'no_discount' |
Definition at line 93 of file OrderItemInterface.php.
const ORDER_ID = 'order_id' |
Definition at line 29 of file OrderItemInterface.php.
const ORIGINAL_PRICE = 'original_price' |
Definition at line 133 of file OrderItemInterface.php.
const PARENT_ITEM = 'parent_item' |
Parent Item
Definition at line 394 of file OrderItemInterface.php.
const PARENT_ITEM_ID = 'parent_item_id' |
Definition at line 33 of file OrderItemInterface.php.
const PRICE = 'price' |
Definition at line 125 of file OrderItemInterface.php.
const PRICE_INCL_TAX = 'price_incl_tax' |
Definition at line 229 of file OrderItemInterface.php.
const PRODUCT_ID = 'product_id' |
Definition at line 53 of file OrderItemInterface.php.
const PRODUCT_TYPE = 'product_type' |
Definition at line 57 of file OrderItemInterface.php.
const QTY_BACKORDERED = 'qty_backordered' |
Definition at line 97 of file OrderItemInterface.php.
const QTY_CANCELED = 'qty_canceled' |
Definition at line 101 of file OrderItemInterface.php.
const QTY_INVOICED = 'qty_invoiced' |
Definition at line 105 of file OrderItemInterface.php.
const QTY_ORDERED = 'qty_ordered' |
Definition at line 109 of file OrderItemInterface.php.
const QTY_REFUNDED = 'qty_refunded' |
Definition at line 113 of file OrderItemInterface.php.
const QTY_RETURNED = 'qty_returned' |
Definition at line 349 of file OrderItemInterface.php.
const QTY_SHIPPED = 'qty_shipped' |
Definition at line 117 of file OrderItemInterface.php.
const QUOTE_ITEM_ID = 'quote_item_id' |
Definition at line 37 of file OrderItemInterface.php.
const ROW_INVOICED = 'row_invoiced' |
Definition at line 197 of file OrderItemInterface.php.
const ROW_TOTAL = 'row_total' |
Definition at line 189 of file OrderItemInterface.php.
const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax' |
Definition at line 237 of file OrderItemInterface.php.
const ROW_WEIGHT = 'row_weight' |
Definition at line 205 of file OrderItemInterface.php.
const SKU = 'sku' |
Definition at line 69 of file OrderItemInterface.php.
const STORE_ID = 'store_id' |
Definition at line 41 of file OrderItemInterface.php.
const TAX_AMOUNT = 'tax_amount' |
Definition at line 145 of file OrderItemInterface.php.
const TAX_BEFORE_DISCOUNT = 'tax_before_discount' |
Definition at line 213 of file OrderItemInterface.php.
const TAX_CANCELED = 'tax_canceled' |
Definition at line 269 of file OrderItemInterface.php.
const TAX_INVOICED = 'tax_invoiced' |
Definition at line 153 of file OrderItemInterface.php.
const TAX_PERCENT = 'tax_percent' |
Definition at line 141 of file OrderItemInterface.php.
const TAX_REFUNDED = 'tax_refunded' |
Definition at line 277 of file OrderItemInterface.php.
const UPDATED_AT = 'updated_at' |
Definition at line 49 of file OrderItemInterface.php.
const WEEE_TAX_APPLIED = 'weee_tax_applied' |
Definition at line 373 of file OrderItemInterface.php.
const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount' |
Definition at line 365 of file OrderItemInterface.php.
const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount' |
Definition at line 369 of file OrderItemInterface.php.
const WEEE_TAX_DISPOSITION = 'weee_tax_disposition' |
Definition at line 377 of file OrderItemInterface.php.
const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition' |
Definition at line 381 of file OrderItemInterface.php.
const WEIGHT = 'weight' |
Definition at line 61 of file OrderItemInterface.php.