123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Sales\Api\Data;
- /**
- * 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
- * @since 100.0.2
- */
- 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';
- /*
- * 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';
- /**
- * Parent Item
- */
- const PARENT_ITEM = 'parent_item';
- /**
- * Product Option
- */
- const KEY_PRODUCT_OPTION = 'product_option';
- /**
- * Gets the additional data for the order item.
- *
- * @return string|null Additional data.
- */
- public function getAdditionalData();
- /**
- * Gets the amount refunded for the order item.
- *
- * @return float|null Amount refunded.
- */
- public function getAmountRefunded();
- /**
- * Gets the applied rule IDs for the order item.
- *
- * Rules are comma separated if there are more than one.
- *
- * @return string|null Applied rule IDs.
- */
- public function getAppliedRuleIds();
- /**
- * Gets the base amount refunded for the order item.
- *
- * @return float|null Base amount refunded.
- */
- public function getBaseAmountRefunded();
- /**
- * Gets the base cost for the order item.
- *
- * @return float|null Base cost.
- */
- public function getBaseCost();
- /**
- * Gets the base discount amount for the order item.
- *
- * @return float|null Base discount amount.
- */
- public function getBaseDiscountAmount();
- /**
- * Gets the base discount invoiced for the order item.
- *
- * @return float|null Base discount invoiced.
- */
- public function getBaseDiscountInvoiced();
- /**
- * Gets the base discount refunded for the order item.
- *
- * @return float|null Base discount refunded.
- */
- public function getBaseDiscountRefunded();
- /**
- * Gets the base discount tax compensation amount for the order item.
- *
- * @return float|null Base discount tax compensation amount.
- */
- public function getBaseDiscountTaxCompensationAmount();
- /**
- * Gets the base discount tax compensation invoiced for the order item.
- *
- * @return float|null Base discount tax compensation invoiced.
- */
- public function getBaseDiscountTaxCompensationInvoiced();
- /**
- * Gets the base discount tax compensation refunded for the order item.
- *
- * @return float|null Base discount tax compensation refunded.
- */
- public function getBaseDiscountTaxCompensationRefunded();
- /**
- * Gets the base original price for the order item.
- *
- * @return float|null Base original price.
- */
- public function getBaseOriginalPrice();
- /**
- * Gets the base price for the order item.
- *
- * @return float|null Base price.
- */
- public function getBasePrice();
- /**
- * Gets the base price including tax for the order item.
- *
- * @return float|null Base price including tax.
- */
- public function getBasePriceInclTax();
- /**
- * Gets the base row invoiced for the order item.
- *
- * @return float|null Base row invoiced.
- */
- public function getBaseRowInvoiced();
- /**
- * Gets the base row total for the order item.
- *
- * @return float|null Base row total.
- */
- public function getBaseRowTotal();
- /**
- * Gets the base row total including tax for the order item.
- *
- * @return float|null Base row total including tax.
- */
- public function getBaseRowTotalInclTax();
- /**
- * Gets the base tax amount for the order item.
- *
- * @return float|null Base tax amount.
- */
- public function getBaseTaxAmount();
- /**
- * Gets the base tax before discount for the order item.
- *
- * @return float|null Base tax before discount.
- */
- public function getBaseTaxBeforeDiscount();
- /**
- * Gets the base tax invoiced for the order item.
- *
- * @return float|null Base tax invoiced.
- */
- public function getBaseTaxInvoiced();
- /**
- * Gets the base tax refunded for the order item.
- *
- * @return float|null Base tax refunded.
- */
- public function getBaseTaxRefunded();
- /**
- * Gets the base WEEE tax applied amount for the order item.
- *
- * @return float|null Base WEEE tax applied amount.
- */
- public function getBaseWeeeTaxAppliedAmount();
- /**
- * Gets the base WEEE tax applied row amount for the order item.
- *
- * @return float|null Base WEEE tax applied row amount.
- */
- public function getBaseWeeeTaxAppliedRowAmnt();
- /**
- * Gets the base WEEE tax disposition for the order item.
- *
- * @return float|null Base WEEE tax disposition.
- */
- public function getBaseWeeeTaxDisposition();
- /**
- * Gets the base WEEE tax row disposition for the order item.
- *
- * @return float|null Base WEEE tax row disposition.
- */
- public function getBaseWeeeTaxRowDisposition();
- /**
- * Gets the created-at timestamp for the order item.
- *
- * @return string|null Created-at timestamp.
- */
- public function getCreatedAt();
- /**
- * Sets the created-at timestamp for the order item.
- *
- * @param string $createdAt timestamp
- * @return $this
- */
- public function setCreatedAt($createdAt);
- /**
- * Gets the description for the order item.
- *
- * @return string|null Description.
- */
- public function getDescription();
- /**
- * Gets the discount amount for the order item.
- *
- * @return float|null Discount amount.
- */
- public function getDiscountAmount();
- /**
- * Gets the discount invoiced for the order item.
- *
- * @return float|null Discount invoiced.
- */
- public function getDiscountInvoiced();
- /**
- * Gets the discount percent for the order item.
- *
- * @return float|null Discount percent.
- */
- public function getDiscountPercent();
- /**
- * Gets the discount refunded for the order item.
- *
- * @return float|null Discount refunded.
- */
- public function getDiscountRefunded();
- /**
- * Gets the event ID for the order item.
- *
- * @return int|null Event ID.
- */
- public function getEventId();
- /**
- * Gets the external order item ID for the order item.
- *
- * @return string|null External order item ID.
- */
- public function getExtOrderItemId();
- /**
- * Gets the free-shipping flag value for the order item.
- *
- * @return int|null Free-shipping flag value.
- */
- public function getFreeShipping();
- /**
- * Gets the GW base price for the order item.
- *
- * @return float|null GW base price.
- */
- public function getGwBasePrice();
- /**
- * Gets the GW base price invoiced for the order item.
- *
- * @return float|null GW base price invoiced.
- */
- public function getGwBasePriceInvoiced();
- /**
- * Gets the GW base price refunded for the order item.
- *
- * @return float|null GW base price refunded.
- */
- public function getGwBasePriceRefunded();
- /**
- * Gets the GW base tax amount for the order item.
- *
- * @return float|null GW base tax amount.
- */
- public function getGwBaseTaxAmount();
- /**
- * Gets the GW base tax amount invoiced for the order item.
- *
- * @return float|null GW base tax amount invoiced.
- */
- public function getGwBaseTaxAmountInvoiced();
- /**
- * Gets the GW base tax amount refunded for the order item.
- *
- * @return float|null GW base tax amount refunded.
- */
- public function getGwBaseTaxAmountRefunded();
- /**
- * Gets the GW ID for the order item.
- *
- * @return int|null GW ID.
- */
- public function getGwId();
- /**
- * Gets the GW price for the order item.
- *
- * @return float|null GW price.
- */
- public function getGwPrice();
- /**
- * Gets the GW price invoiced for the order item.
- *
- * @return float|null GW price invoiced.
- */
- public function getGwPriceInvoiced();
- /**
- * Gets the GW price refunded for the order item.
- *
- * @return float|null GW price refunded.
- */
- public function getGwPriceRefunded();
- /**
- * Gets the GW tax amount for the order item.
- *
- * @return float|null GW tax amount.
- */
- public function getGwTaxAmount();
- /**
- * Gets the GW tax amount invoiced for the order item.
- *
- * @return float|null GW tax amount invoiced.
- */
- public function getGwTaxAmountInvoiced();
- /**
- * Gets the GW tax amount refunded for the order item.
- *
- * @return float|null GW tax amount refunded.
- */
- public function getGwTaxAmountRefunded();
- /**
- * Gets the discount tax compensation amount for the order item.
- *
- * @return float|null Discount tax compensation amount.
- */
- public function getDiscountTaxCompensationAmount();
- /**
- * Gets the discount tax compensation canceled for the order item.
- *
- * @return float|null Discount tax compensation canceled.
- */
- public function getDiscountTaxCompensationCanceled();
- /**
- * Gets the discount tax compensation invoiced for the order item.
- *
- * @return float|null Discount tax compensation invoiced.
- */
- public function getDiscountTaxCompensationInvoiced();
- /**
- * Gets the discount tax compensation refunded for the order item.
- *
- * @return float|null Discount tax compensation refunded.
- */
- public function getDiscountTaxCompensationRefunded();
- /**
- * Gets the is-quantity-decimal flag value for the order item.
- *
- * @return int|null Is-quantity-decimal flag value.
- */
- public function getIsQtyDecimal();
- /**
- * Gets the is-virtual flag value for the order item.
- *
- * @return int|null Is-virtual flag value.
- */
- public function getIsVirtual();
- /**
- * Gets the item ID for the order item.
- *
- * @return int|null Item ID.
- */
- public function getItemId();
- /**
- * Gets the locked DO invoice flag value for the order item.
- *
- * @return int|null Locked DO invoice flag value.
- */
- public function getLockedDoInvoice();
- /**
- * Gets the locked DO ship flag value for the order item.
- *
- * @return int|null Locked DO ship flag value.
- */
- public function getLockedDoShip();
- /**
- * Gets the name for the order item.
- *
- * @return string|null Name.
- */
- public function getName();
- /**
- * Gets the no discount flag value for the order item.
- *
- * @return int|null No-discount flag value.
- */
- public function getNoDiscount();
- /**
- * Gets the order ID for the order item.
- *
- * @return int|null Order ID.
- */
- public function getOrderId();
- /**
- * Gets the original price for the order item.
- *
- * @return float|null Original price.
- */
- public function getOriginalPrice();
- /**
- * Gets the parent item ID for the order item.
- *
- * @return int|null Parent item ID.
- */
- public function getParentItemId();
- /**
- * Gets the price for the order item.
- *
- * @return float|null Price.
- */
- public function getPrice();
- /**
- * Gets the price including tax for the order item.
- *
- * @return float|null Price including tax.
- */
- public function getPriceInclTax();
- /**
- * Gets the product ID for the order item.
- *
- * @return int|null Product ID.
- */
- public function getProductId();
- /**
- * Gets the product type for the order item.
- *
- * @return string|null Product type.
- */
- public function getProductType();
- /**
- * Gets the quantity backordered for the order item.
- *
- * @return float|null Quantity backordered.
- */
- public function getQtyBackordered();
- /**
- * Gets the quantity canceled for the order item.
- *
- * @return float|null Quantity canceled.
- */
- public function getQtyCanceled();
- /**
- * Gets the quantity invoiced for the order item.
- *
- * @return float|null Quantity invoiced.
- */
- public function getQtyInvoiced();
- /**
- * Gets the quantity ordered for the order item.
- *
- * @return float|null Quantity ordered.
- */
- public function getQtyOrdered();
- /**
- * Gets the quantity refunded for the order item.
- *
- * @return float|null Quantity refunded.
- */
- public function getQtyRefunded();
- /**
- * Gets the quantity returned for the order item.
- *
- * @return float|null Quantity returned.
- */
- public function getQtyReturned();
- /**
- * Gets the quantity shipped for the order item.
- *
- * @return float|null Quantity shipped.
- */
- public function getQtyShipped();
- /**
- * Gets the quote item ID for the order item.
- *
- * @return int|null Quote item ID.
- */
- public function getQuoteItemId();
- /**
- * Gets the row invoiced for the order item.
- *
- * @return float|null Row invoiced.
- */
- public function getRowInvoiced();
- /**
- * Gets the row total for the order item.
- *
- * @return float|null Row total.
- */
- public function getRowTotal();
- /**
- * Gets the row total including tax for the order item.
- *
- * @return float|null Row total including tax.
- */
- public function getRowTotalInclTax();
- /**
- * Gets the row weight for the order item.
- *
- * @return float|null Row weight.
- */
- public function getRowWeight();
- /**
- * Gets the SKU for the order item.
- *
- * @return string SKU.
- */
- public function getSku();
- /**
- * Gets the store ID for the order item.
- *
- * @return int|null Store ID.
- */
- public function getStoreId();
- /**
- * Gets the tax amount for the order item.
- *
- * @return float|null Tax amount.
- */
- public function getTaxAmount();
- /**
- * Gets the tax before discount for the order item.
- *
- * @return float|null Tax before discount.
- */
- public function getTaxBeforeDiscount();
- /**
- * Gets the tax canceled for the order item.
- *
- * @return float|null Tax canceled.
- */
- public function getTaxCanceled();
- /**
- * Gets the tax invoiced for the order item.
- *
- * @return float|null Tax invoiced.
- */
- public function getTaxInvoiced();
- /**
- * Gets the tax percent for the order item.
- *
- * @return float|null Tax percent.
- */
- public function getTaxPercent();
- /**
- * Gets the tax refunded for the order item.
- *
- * @return float|null Tax refunded.
- */
- public function getTaxRefunded();
- /**
- * Gets the updated-at timestamp for the order item.
- *
- * @return string|null Updated-at timestamp.
- */
- public function getUpdatedAt();
- /**
- * Gets the WEEE tax applied for the order item.
- *
- * @return string|null WEEE tax applied.
- */
- public function getWeeeTaxApplied();
- /**
- * Gets the WEEE tax applied amount for the order item.
- *
- * @return float|null WEEE tax applied amount.
- */
- public function getWeeeTaxAppliedAmount();
- /**
- * Gets the WEEE tax applied row amount for the order item.
- *
- * @return float|null WEEE tax applied row amount.
- */
- public function getWeeeTaxAppliedRowAmount();
- /**
- * Gets the WEEE tax disposition for the order item.
- *
- * @return float|null WEEE tax disposition.
- */
- public function getWeeeTaxDisposition();
- /**
- * Gets the WEEE tax row disposition for the order item.
- *
- * @return float|null WEEE tax row disposition.
- */
- public function getWeeeTaxRowDisposition();
- /**
- * Gets the weight for the order item.
- *
- * @return float|null Weight.
- */
- public function getWeight();
- /**
- * Gets the parent item
- *
- * @return \Magento\Sales\Api\Data\OrderItemInterface|null Parent item
- */
- public function getParentItem();
- /**
- * Sets the parent item
- *
- * @param \Magento\Sales\Api\Data\OrderItemInterface $parentItem
- * @return $this
- */
- public function setParentItem($parentItem);
- /**
- * Sets the updated-at timestamp for the order item.
- *
- * @param string $timestamp
- * @return $this
- */
- public function setUpdatedAt($timestamp);
- /**
- * Sets the item ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setItemId($id);
- /**
- * Sets the order ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setOrderId($id);
- /**
- * Sets the parent item ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setParentItemId($id);
- /**
- * Sets the quote item ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setQuoteItemId($id);
- /**
- * Sets the store ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setStoreId($id);
- /**
- * Sets the product ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setProductId($id);
- /**
- * Sets the product type for the order item.
- *
- * @param string $productType
- * @return $this
- */
- public function setProductType($productType);
- /**
- * Sets the weight for the order item.
- *
- * @param float $weight
- * @return $this
- */
- public function setWeight($weight);
- /**
- * Sets the is-virtual flag value for the order item.
- *
- * @param int $isVirtual
- * @return $this
- */
- public function setIsVirtual($isVirtual);
- /**
- * Sets the SKU for the order item.
- *
- * @param string $sku
- * @return $this
- */
- public function setSku($sku);
- /**
- * Sets the name for the order item.
- *
- * @param string $name
- * @return $this
- */
- public function setName($name);
- /**
- * Sets the description for the order item.
- *
- * @param string $description
- * @return $this
- */
- public function setDescription($description);
- /**
- * Sets the applied rule IDs for the order item.
- *
- * @param string $appliedRuleIds
- * @return $this
- */
- public function setAppliedRuleIds($appliedRuleIds);
- /**
- * Sets the additional data for the order item.
- *
- * @param string $additionalData
- * @return $this
- */
- public function setAdditionalData($additionalData);
- /**
- * Sets the is-quantity-decimal flag value for the order item.
- *
- * @param int $isQtyDecimal
- * @return $this
- */
- public function setIsQtyDecimal($isQtyDecimal);
- /**
- * Sets the no discount flag value for the order item.
- *
- * @param int $noDiscount
- * @return $this
- */
- public function setNoDiscount($noDiscount);
- /**
- * Sets the quantity backordered for the order item.
- *
- * @param float $qtyBackordered
- * @return $this
- */
- public function setQtyBackordered($qtyBackordered);
- /**
- * Sets the quantity canceled for the order item.
- *
- * @param float $qtyCanceled
- * @return $this
- */
- public function setQtyCanceled($qtyCanceled);
- /**
- * Sets the quantity invoiced for the order item.
- *
- * @param float $qtyInvoiced
- * @return $this
- */
- public function setQtyInvoiced($qtyInvoiced);
- /**
- * Sets the quantity ordered for the order item.
- *
- * @param float $qtyOrdered
- * @return $this
- */
- public function setQtyOrdered($qtyOrdered);
- /**
- * Sets the quantity refunded for the order item.
- *
- * @param float $qtyRefunded
- * @return $this
- */
- public function setQtyRefunded($qtyRefunded);
- /**
- * Sets the quantity shipped for the order item.
- *
- * @param float $qtyShipped
- * @return $this
- */
- public function setQtyShipped($qtyShipped);
- /**
- * Sets the base cost for the order item.
- *
- * @param float $baseCost
- * @return $this
- */
- public function setBaseCost($baseCost);
- /**
- * Sets the price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setPrice($price);
- /**
- * Sets the base price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setBasePrice($price);
- /**
- * Sets the original price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setOriginalPrice($price);
- /**
- * Sets the base original price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setBaseOriginalPrice($price);
- /**
- * Sets the tax percent for the order item.
- *
- * @param float $taxPercent
- * @return $this
- */
- public function setTaxPercent($taxPercent);
- /**
- * Sets the tax amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setTaxAmount($amount);
- /**
- * Sets the base tax amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseTaxAmount($amount);
- /**
- * Sets the tax invoiced for the order item.
- *
- * @param float $taxInvoiced
- * @return $this
- */
- public function setTaxInvoiced($taxInvoiced);
- /**
- * Sets the base tax invoiced for the order item.
- *
- * @param float $baseTaxInvoiced
- * @return $this
- */
- public function setBaseTaxInvoiced($baseTaxInvoiced);
- /**
- * Sets the discount percent for the order item.
- *
- * @param float $discountPercent
- * @return $this
- */
- public function setDiscountPercent($discountPercent);
- /**
- * Sets the discount amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setDiscountAmount($amount);
- /**
- * Sets the base discount amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseDiscountAmount($amount);
- /**
- * Sets the discount invoiced for the order item.
- *
- * @param float $discountInvoiced
- * @return $this
- */
- public function setDiscountInvoiced($discountInvoiced);
- /**
- * Sets the base discount invoiced for the order item.
- *
- * @param float $baseDiscountInvoiced
- * @return $this
- */
- public function setBaseDiscountInvoiced($baseDiscountInvoiced);
- /**
- * Sets the amount refunded for the order item.
- *
- * @param float $amountRefunded
- * @return $this
- */
- public function setAmountRefunded($amountRefunded);
- /**
- * Sets the base amount refunded for the order item.
- *
- * @param float $baseAmountRefunded
- * @return $this
- */
- public function setBaseAmountRefunded($baseAmountRefunded);
- /**
- * Sets the row total for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setRowTotal($amount);
- /**
- * Sets the base row total for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseRowTotal($amount);
- /**
- * Sets the row invoiced for the order item.
- *
- * @param float $rowInvoiced
- * @return $this
- */
- public function setRowInvoiced($rowInvoiced);
- /**
- * Sets the base row invoiced for the order item.
- *
- * @param float $baseRowInvoiced
- * @return $this
- */
- public function setBaseRowInvoiced($baseRowInvoiced);
- /**
- * Sets the row weight for the order item.
- *
- * @param float $rowWeight
- * @return $this
- */
- public function setRowWeight($rowWeight);
- /**
- * Sets the base tax before discount for the order item.
- *
- * @param float $baseTaxBeforeDiscount
- * @return $this
- */
- public function setBaseTaxBeforeDiscount($baseTaxBeforeDiscount);
- /**
- * Sets the tax before discount for the order item.
- *
- * @param float $taxBeforeDiscount
- * @return $this
- */
- public function setTaxBeforeDiscount($taxBeforeDiscount);
- /**
- * Sets the external order item ID for the order item.
- *
- * @param string $id
- * @return $this
- */
- public function setExtOrderItemId($id);
- /**
- * Sets the locked DO invoice flag value for the order item.
- *
- * @param int $flag
- * @return $this
- */
- public function setLockedDoInvoice($flag);
- /**
- * Sets the locked DO ship flag value for the order item.
- *
- * @param int $flag
- * @return $this
- */
- public function setLockedDoShip($flag);
- /**
- * Sets the price including tax for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setPriceInclTax($amount);
- /**
- * Sets the base price including tax for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBasePriceInclTax($amount);
- /**
- * Sets the row total including tax for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setRowTotalInclTax($amount);
- /**
- * Sets the base row total including tax for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseRowTotalInclTax($amount);
- /**
- * Sets the discount tax compensation amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setDiscountTaxCompensationAmount($amount);
- /**
- * Sets the base discount tax compensation amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseDiscountTaxCompensationAmount($amount);
- /**
- * Sets the discount tax compensation invoiced for the order item.
- *
- * @param float $discountTaxCompensationInvoiced
- * @return $this
- */
- public function setDiscountTaxCompensationInvoiced($discountTaxCompensationInvoiced);
- /**
- * Sets the base discount tax compensation invoiced for the order item.
- *
- * @param float $baseDiscountTaxCompensationInvoiced
- * @return $this
- */
- public function setBaseDiscountTaxCompensationInvoiced($baseDiscountTaxCompensationInvoiced);
- /**
- * Sets the discount tax compensation refunded for the order item.
- *
- * @param float $discountTaxCompensationRefunded
- * @return $this
- */
- public function setDiscountTaxCompensationRefunded($discountTaxCompensationRefunded);
- /**
- * Sets the base discount tax compensation refunded for the order item.
- *
- * @param float $baseDiscountTaxCompensationRefunded
- * @return $this
- */
- public function setBaseDiscountTaxCompensationRefunded($baseDiscountTaxCompensationRefunded);
- /**
- * Sets the tax canceled for the order item.
- *
- * @param float $taxCanceled
- * @return $this
- */
- public function setTaxCanceled($taxCanceled);
- /**
- * Sets the discount tax compensation canceled for the order item.
- *
- * @param float $discountTaxCompensationCanceled
- * @return $this
- */
- public function setDiscountTaxCompensationCanceled($discountTaxCompensationCanceled);
- /**
- * Sets the tax refunded for the order item.
- *
- * @param float $taxRefunded
- * @return $this
- */
- public function setTaxRefunded($taxRefunded);
- /**
- * Sets the base tax refunded for the order item.
- *
- * @param float $baseTaxRefunded
- * @return $this
- */
- public function setBaseTaxRefunded($baseTaxRefunded);
- /**
- * Sets the discount refunded for the order item.
- *
- * @param float $discountRefunded
- * @return $this
- */
- public function setDiscountRefunded($discountRefunded);
- /**
- * Sets the base discount refunded for the order item.
- *
- * @param float $baseDiscountRefunded
- * @return $this
- */
- public function setBaseDiscountRefunded($baseDiscountRefunded);
- /**
- * Sets the GW ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setGwId($id);
- /**
- * Sets the GW base price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setGwBasePrice($price);
- /**
- * Sets the GW price for the order item.
- *
- * @param float $price
- * @return $this
- */
- public function setGwPrice($price);
- /**
- * Sets the GW base tax amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setGwBaseTaxAmount($amount);
- /**
- * Sets the GW tax amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setGwTaxAmount($amount);
- /**
- * Sets the GW base price invoiced for the order item.
- *
- * @param float $gwBasePriceInvoiced
- * @return $this
- */
- public function setGwBasePriceInvoiced($gwBasePriceInvoiced);
- /**
- * Sets the GW price invoiced for the order item.
- *
- * @param float $gwPriceInvoiced
- * @return $this
- */
- public function setGwPriceInvoiced($gwPriceInvoiced);
- /**
- * Sets the GW base tax amount invoiced for the order item.
- *
- * @param float $gwBaseTaxAmountInvoiced
- * @return $this
- */
- public function setGwBaseTaxAmountInvoiced($gwBaseTaxAmountInvoiced);
- /**
- * Sets the GW tax amount invoiced for the order item.
- *
- * @param float $gwTaxAmountInvoiced
- * @return $this
- */
- public function setGwTaxAmountInvoiced($gwTaxAmountInvoiced);
- /**
- * Sets the GW base price refunded for the order item.
- *
- * @param float $gwBasePriceRefunded
- * @return $this
- */
- public function setGwBasePriceRefunded($gwBasePriceRefunded);
- /**
- * Sets the GW price refunded for the order item.
- *
- * @param float $gwPriceRefunded
- * @return $this
- */
- public function setGwPriceRefunded($gwPriceRefunded);
- /**
- * Sets the GW base tax amount refunded for the order item.
- *
- * @param float $gwBaseTaxAmountRefunded
- * @return $this
- */
- public function setGwBaseTaxAmountRefunded($gwBaseTaxAmountRefunded);
- /**
- * Sets the GW tax amount refunded for the order item.
- *
- * @param float $gwTaxAmountRefunded
- * @return $this
- */
- public function setGwTaxAmountRefunded($gwTaxAmountRefunded);
- /**
- * Sets the free-shipping flag value for the order item.
- *
- * @param int $freeShipping
- * @return $this
- */
- public function setFreeShipping($freeShipping);
- /**
- * Sets the quantity returned for the order item.
- *
- * @param float $qtyReturned
- * @return $this
- */
- public function setQtyReturned($qtyReturned);
- /**
- * Sets the event ID for the order item.
- *
- * @param int $id
- * @return $this
- */
- public function setEventId($id);
- /**
- * Sets the base WEEE tax applied amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setBaseWeeeTaxAppliedAmount($amount);
- /**
- * Sets the base WEEE tax applied row amount for the order item.
- *
- * @param float $amnt
- * @return $this
- */
- public function setBaseWeeeTaxAppliedRowAmnt($amnt);
- /**
- * Sets the WEEE tax applied amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setWeeeTaxAppliedAmount($amount);
- /**
- * Sets the WEEE tax applied row amount for the order item.
- *
- * @param float $amount
- * @return $this
- */
- public function setWeeeTaxAppliedRowAmount($amount);
- /**
- * Sets the WEEE tax applied for the order item.
- *
- * @param string $weeeTaxApplied
- * @return $this
- */
- public function setWeeeTaxApplied($weeeTaxApplied);
- /**
- * Sets the WEEE tax disposition for the order item.
- *
- * @param float $weeeTaxDisposition
- * @return $this
- */
- public function setWeeeTaxDisposition($weeeTaxDisposition);
- /**
- * Sets the WEEE tax row disposition for the order item.
- *
- * @param float $weeeTaxRowDisposition
- * @return $this
- */
- public function setWeeeTaxRowDisposition($weeeTaxRowDisposition);
- /**
- * Sets the base WEEE tax disposition for the order item.
- *
- * @param float $baseWeeeTaxDisposition
- * @return $this
- */
- public function setBaseWeeeTaxDisposition($baseWeeeTaxDisposition);
- /**
- * Sets the base WEEE tax row disposition for the order item.
- *
- * @param float $baseWeeeTaxRowDisposition
- * @return $this
- */
- public function setBaseWeeeTaxRowDisposition($baseWeeeTaxRowDisposition);
- /**
- * Returns product option
- *
- * @return \Magento\Catalog\Api\Data\ProductOptionInterface|null
- */
- public function getProductOption();
- /**
- * Sets product option
- *
- * @param \Magento\Catalog\Api\Data\ProductOptionInterface $productOption
- * @return $this
- */
- public function setProductOption(\Magento\Catalog\Api\Data\ProductOptionInterface $productOption);
- /**
- * Retrieve existing extension attributes object or create a new one.
- *
- * @return \Magento\Sales\Api\Data\OrderItemExtensionInterface|null
- */
- public function getExtensionAttributes();
- /**
- * Set an extension attributes object.
- *
- * @param \Magento\Sales\Api\Data\OrderItemExtensionInterface $extensionAttributes
- * @return $this
- */
- public function setExtensionAttributes(\Magento\Sales\Api\Data\OrderItemExtensionInterface $extensionAttributes);
- }
|