OrderInterface.php 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Api\Data;
  7. /**
  8. * Order interface.
  9. *
  10. * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product
  11. * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as
  12. * a purchase order, is emailed to the customer.
  13. * @api
  14. * @since 100.0.2
  15. */
  16. interface OrderInterface extends \Magento\Framework\Api\ExtensibleDataInterface
  17. {
  18. /**#@+
  19. * Constants for keys of data array. Identical to the name of the getter in snake case.
  20. */
  21. /*
  22. * Entity ID.
  23. */
  24. const ENTITY_ID = 'entity_id';
  25. /*
  26. * State.
  27. */
  28. const STATE = 'state';
  29. /*
  30. * Status.
  31. */
  32. const STATUS = 'status';
  33. /*
  34. * Coupon code.
  35. */
  36. const COUPON_CODE = 'coupon_code';
  37. /*
  38. * Protect code.
  39. */
  40. const PROTECT_CODE = 'protect_code';
  41. /*
  42. * Shipping description.
  43. */
  44. const SHIPPING_DESCRIPTION = 'shipping_description';
  45. /*
  46. * Is-virtual flag.
  47. */
  48. const IS_VIRTUAL = 'is_virtual';
  49. /*
  50. * Store ID.
  51. */
  52. const STORE_ID = 'store_id';
  53. /*
  54. * Customer ID.
  55. */
  56. const CUSTOMER_ID = 'customer_id';
  57. /*
  58. * Base discount amount.
  59. */
  60. const BASE_DISCOUNT_AMOUNT = 'base_discount_amount';
  61. /*
  62. * Base discount canceled.
  63. */
  64. const BASE_DISCOUNT_CANCELED = 'base_discount_canceled';
  65. /*
  66. * Base discount invoiced.
  67. */
  68. const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced';
  69. /*
  70. * Base discount refunded.
  71. */
  72. const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded';
  73. /*
  74. * Base grand total.
  75. */
  76. const BASE_GRAND_TOTAL = 'base_grand_total';
  77. /*
  78. * Base shipping amount.
  79. */
  80. const BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
  81. /*
  82. * Base shipping canceled.
  83. */
  84. const BASE_SHIPPING_CANCELED = 'base_shipping_canceled';
  85. /*
  86. * Base shipping invoiced.
  87. */
  88. const BASE_SHIPPING_INVOICED = 'base_shipping_invoiced';
  89. /*
  90. * Base shipping refunded.
  91. */
  92. const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded';
  93. /*
  94. * Base shipping tax amount.
  95. */
  96. const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount';
  97. /*
  98. * Base shipping tax refunded.
  99. */
  100. const BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded';
  101. /*
  102. * Base subtotal.
  103. */
  104. const BASE_SUBTOTAL = 'base_subtotal';
  105. /*
  106. * Base subtotal canceled.
  107. */
  108. const BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled';
  109. /*
  110. * Base subtotal invoiced.
  111. */
  112. const BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced';
  113. /*
  114. * Base subtotal refunded.
  115. */
  116. const BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded';
  117. /*
  118. * Base tax amount.
  119. */
  120. const BASE_TAX_AMOUNT = 'base_tax_amount';
  121. /*
  122. * Base tax canceled.
  123. */
  124. const BASE_TAX_CANCELED = 'base_tax_canceled';
  125. /*
  126. * Base tax invoiced.
  127. */
  128. const BASE_TAX_INVOICED = 'base_tax_invoiced';
  129. /*
  130. * Base tax refunded.
  131. */
  132. const BASE_TAX_REFUNDED = 'base_tax_refunded';
  133. /*
  134. * Base-to-global rate.
  135. */
  136. const BASE_TO_GLOBAL_RATE = 'base_to_global_rate';
  137. /*
  138. * Base-to-order rate.
  139. */
  140. const BASE_TO_ORDER_RATE = 'base_to_order_rate';
  141. /*
  142. * Base total canceled.
  143. */
  144. const BASE_TOTAL_CANCELED = 'base_total_canceled';
  145. /*
  146. * Base total invoiced.
  147. */
  148. const BASE_TOTAL_INVOICED = 'base_total_invoiced';
  149. /*
  150. * Base total invoiced cost.
  151. */
  152. const BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost';
  153. /*
  154. * Base total offline refunded.
  155. */
  156. const BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded';
  157. /*
  158. * Base total online refunded.
  159. */
  160. const BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded';
  161. /*
  162. * Base total paid.
  163. */
  164. const BASE_TOTAL_PAID = 'base_total_paid';
  165. /*
  166. * Base total quantity ordered.
  167. */
  168. const BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered';
  169. /*
  170. * Base total refunded.
  171. */
  172. const BASE_TOTAL_REFUNDED = 'base_total_refunded';
  173. /*
  174. * Discount amount.
  175. */
  176. const DISCOUNT_AMOUNT = 'discount_amount';
  177. /*
  178. * Discount canceled.
  179. */
  180. const DISCOUNT_CANCELED = 'discount_canceled';
  181. /*
  182. * Discount invoiced.
  183. */
  184. const DISCOUNT_INVOICED = 'discount_invoiced';
  185. /*
  186. * Discount refunded.
  187. */
  188. const DISCOUNT_REFUNDED = 'discount_refunded';
  189. /*
  190. * Grand total.
  191. */
  192. const GRAND_TOTAL = 'grand_total';
  193. /*
  194. * Shipping amount.
  195. */
  196. const SHIPPING_AMOUNT = 'shipping_amount';
  197. /*
  198. * Shipping canceled.
  199. */
  200. const SHIPPING_CANCELED = 'shipping_canceled';
  201. /*
  202. * Shipping invoiced.
  203. */
  204. const SHIPPING_INVOICED = 'shipping_invoiced';
  205. /*
  206. * Shipping refunded.
  207. */
  208. const SHIPPING_REFUNDED = 'shipping_refunded';
  209. /*
  210. * Shipping tax amount.
  211. */
  212. const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount';
  213. /*
  214. * Shipping tax refunded.
  215. */
  216. const SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded';
  217. /*
  218. * Store-to-base rate.
  219. */
  220. const STORE_TO_BASE_RATE = 'store_to_base_rate';
  221. /*
  222. * Store-to-order rate.
  223. */
  224. const STORE_TO_ORDER_RATE = 'store_to_order_rate';
  225. /*
  226. * Subtotal.
  227. */
  228. const SUBTOTAL = 'subtotal';
  229. /*
  230. * Subtotal canceled.
  231. */
  232. const SUBTOTAL_CANCELED = 'subtotal_canceled';
  233. /*
  234. * Subtotal invoiced.
  235. */
  236. const SUBTOTAL_INVOICED = 'subtotal_invoiced';
  237. /*
  238. * Subtotal refunded.
  239. */
  240. const SUBTOTAL_REFUNDED = 'subtotal_refunded';
  241. /*
  242. * Tax amount.
  243. */
  244. const TAX_AMOUNT = 'tax_amount';
  245. /*
  246. * Tax canceled.
  247. */
  248. const TAX_CANCELED = 'tax_canceled';
  249. /*
  250. * Tax invoiced.
  251. */
  252. const TAX_INVOICED = 'tax_invoiced';
  253. /*
  254. * Tax refunded.
  255. */
  256. const TAX_REFUNDED = 'tax_refunded';
  257. /*
  258. * Total canceled.
  259. */
  260. const TOTAL_CANCELED = 'total_canceled';
  261. /*
  262. * Total invoiced.
  263. */
  264. const TOTAL_INVOICED = 'total_invoiced';
  265. /*
  266. * Total refunded offline.
  267. */
  268. const TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded';
  269. /*
  270. * Total refunded online.
  271. */
  272. const TOTAL_ONLINE_REFUNDED = 'total_online_refunded';
  273. /*
  274. * Total paid.
  275. */
  276. const TOTAL_PAID = 'total_paid';
  277. /*
  278. * Total quantity ordered.
  279. */
  280. const TOTAL_QTY_ORDERED = 'total_qty_ordered';
  281. /*
  282. * Total refunded.
  283. */
  284. const TOTAL_REFUNDED = 'total_refunded';
  285. /*
  286. * Can-ship-partially flag.
  287. */
  288. const CAN_SHIP_PARTIALLY = 'can_ship_partially';
  289. /*
  290. * Can-ship-item-partially flag.
  291. */
  292. const CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item';
  293. /*
  294. * Customer-is-guest flag.
  295. */
  296. const CUSTOMER_IS_GUEST = 'customer_is_guest';
  297. /*
  298. * Customer-note-notify flag.
  299. */
  300. const CUSTOMER_NOTE_NOTIFY = 'customer_note_notify';
  301. /*
  302. * Billing address ID.
  303. */
  304. const BILLING_ADDRESS_ID = 'billing_address_id';
  305. /*
  306. * Customer group ID.
  307. */
  308. const CUSTOMER_GROUP_ID = 'customer_group_id';
  309. /*
  310. * Edit increment value.
  311. */
  312. const EDIT_INCREMENT = 'edit_increment';
  313. /*
  314. * Email-sent flag.
  315. */
  316. const EMAIL_SENT = 'email_sent';
  317. /*
  318. * Forced-shipment-with-invoice flag.
  319. */
  320. const FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice';
  321. /*
  322. * Payment authorization expiration date.
  323. */
  324. const PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration';
  325. /*
  326. * Quote address ID.
  327. */
  328. const QUOTE_ADDRESS_ID = 'quote_address_id';
  329. /*
  330. * Quote ID.
  331. */
  332. const QUOTE_ID = 'quote_id';
  333. /*
  334. * Negative adjustment.
  335. */
  336. const ADJUSTMENT_NEGATIVE = 'adjustment_negative';
  337. /*
  338. * Positive adjustment.
  339. */
  340. const ADJUSTMENT_POSITIVE = 'adjustment_positive';
  341. /*
  342. * Base negative adjustment.
  343. */
  344. const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative';
  345. /*
  346. * Base positive adjustment.
  347. */
  348. const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive';
  349. /*
  350. * Base shipping discount amount.
  351. */
  352. const BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount';
  353. /*
  354. * Base subtotal including tax.
  355. */
  356. const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax';
  357. /*
  358. * Base total due.
  359. */
  360. const BASE_TOTAL_DUE = 'base_total_due';
  361. /*
  362. * Payment authorization amount.
  363. */
  364. const PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount';
  365. /*
  366. * Shipping discount amount.
  367. */
  368. const SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount';
  369. /*
  370. * Subtotal including tax.
  371. */
  372. const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax';
  373. /*
  374. * Total due.
  375. */
  376. const TOTAL_DUE = 'total_due';
  377. /*
  378. * Weight.
  379. */
  380. const WEIGHT = 'weight';
  381. /*
  382. * Customer date-of-birth (DOB).
  383. */
  384. const CUSTOMER_DOB = 'customer_dob';
  385. /*
  386. * Increment ID.
  387. */
  388. const INCREMENT_ID = 'increment_id';
  389. /*
  390. * Applied rule IDs.
  391. */
  392. const APPLIED_RULE_IDS = 'applied_rule_ids';
  393. /*
  394. * Base currency code.
  395. */
  396. const BASE_CURRENCY_CODE = 'base_currency_code';
  397. /*
  398. * Customer email address.
  399. */
  400. const CUSTOMER_EMAIL = 'customer_email';
  401. /*
  402. * Customer first name.
  403. */
  404. const CUSTOMER_FIRSTNAME = 'customer_firstname';
  405. /*
  406. * Customer last name.
  407. */
  408. const CUSTOMER_LASTNAME = 'customer_lastname';
  409. /*
  410. * Customer middle name.
  411. */
  412. const CUSTOMER_MIDDLENAME = 'customer_middlename';
  413. /*
  414. * Customer prefix.
  415. */
  416. const CUSTOMER_PREFIX = 'customer_prefix';
  417. /*
  418. * Customer suffix.
  419. */
  420. const CUSTOMER_SUFFIX = 'customer_suffix';
  421. /*
  422. * Customer value-added tax (VAT).
  423. */
  424. const CUSTOMER_TAXVAT = 'customer_taxvat';
  425. /*
  426. * Discount description.
  427. */
  428. const DISCOUNT_DESCRIPTION = 'discount_description';
  429. /*
  430. * External customer ID.
  431. */
  432. const EXT_CUSTOMER_ID = 'ext_customer_id';
  433. /*
  434. * External order ID.
  435. */
  436. const EXT_ORDER_ID = 'ext_order_id';
  437. /*
  438. * Global currency code.
  439. */
  440. const GLOBAL_CURRENCY_CODE = 'global_currency_code';
  441. /*
  442. * Hold before state.
  443. */
  444. const HOLD_BEFORE_STATE = 'hold_before_state';
  445. /*
  446. * Hold before status.
  447. */
  448. const HOLD_BEFORE_STATUS = 'hold_before_status';
  449. /*
  450. * Order currency code.
  451. */
  452. const ORDER_CURRENCY_CODE = 'order_currency_code';
  453. /*
  454. * Original increment ID.
  455. */
  456. const ORIGINAL_INCREMENT_ID = 'original_increment_id';
  457. /*
  458. * Relation child ID.
  459. */
  460. const RELATION_CHILD_ID = 'relation_child_id';
  461. /*
  462. * Relation child real ID.
  463. */
  464. const RELATION_CHILD_REAL_ID = 'relation_child_real_id';
  465. /*
  466. * Relation parent ID.
  467. */
  468. const RELATION_PARENT_ID = 'relation_parent_id';
  469. /*
  470. * Relation parent real ID.
  471. */
  472. const RELATION_PARENT_REAL_ID = 'relation_parent_real_id';
  473. /*
  474. * Remote IP address.
  475. */
  476. const REMOTE_IP = 'remote_ip';
  477. /*
  478. * Store currency code.
  479. */
  480. const STORE_CURRENCY_CODE = 'store_currency_code';
  481. /*
  482. * Store name.
  483. */
  484. const STORE_NAME = 'store_name';
  485. /*
  486. * X-Forwarded-For HTTP header field.
  487. */
  488. const X_FORWARDED_FOR = 'x_forwarded_for';
  489. /*
  490. * Customer note.
  491. */
  492. const CUSTOMER_NOTE = 'customer_note';
  493. /*
  494. * Created-at timestamp.
  495. */
  496. const CREATED_AT = 'created_at';
  497. /*
  498. * Updated-at timestamp.
  499. */
  500. const UPDATED_AT = 'updated_at';
  501. /*
  502. * Total item count.
  503. */
  504. const TOTAL_ITEM_COUNT = 'total_item_count';
  505. /*
  506. * Customer gender.
  507. */
  508. const CUSTOMER_GENDER = 'customer_gender';
  509. /*
  510. * Discount tax compensation amount.
  511. */
  512. const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount';
  513. /*
  514. * Base discount tax compensation amount.
  515. */
  516. const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
  517. /*
  518. * Shipping discount tax compensation amount.
  519. */
  520. const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount';
  521. /*
  522. * Base shipping discount tax compensation amount.
  523. */
  524. const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt';
  525. /*
  526. * Discount tax compensation invoiced.
  527. */
  528. const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced';
  529. /*
  530. * Base discount tax compensation invoiced.
  531. */
  532. const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced';
  533. /*
  534. * Discount tax compensation refunded.
  535. */
  536. const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded';
  537. /*
  538. * Base discount tax compensation refunded.
  539. */
  540. const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded';
  541. /*
  542. * Shipping including tax.
  543. */
  544. const SHIPPING_INCL_TAX = 'shipping_incl_tax';
  545. /*
  546. * Base shipping including tax.
  547. */
  548. const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
  549. /*
  550. * Items.
  551. */
  552. const ITEMS = 'items';
  553. /*
  554. * Billing address.
  555. */
  556. const BILLING_ADDRESS = 'billing_address';
  557. /*
  558. * Payment.
  559. */
  560. const PAYMENT = 'payment';
  561. /*
  562. * Status histories.
  563. */
  564. const STATUS_HISTORIES = 'status_histories';
  565. /**
  566. * Gets the negative adjustment value for the order.
  567. *
  568. * @return float|null Negative adjustment value.
  569. */
  570. public function getAdjustmentNegative();
  571. /**
  572. * Gets the positive adjustment value for the order.
  573. *
  574. * @return float|null Positive adjustment value.
  575. */
  576. public function getAdjustmentPositive();
  577. /**
  578. * Gets the applied rule IDs for the order.
  579. *
  580. * Rules are comma separated if there are more than one.
  581. *
  582. * @return string|null Applied rule IDs.
  583. */
  584. public function getAppliedRuleIds();
  585. /**
  586. * Gets the base negative adjustment value for the order.
  587. *
  588. * @return float|null Base negative adjustment value.
  589. */
  590. public function getBaseAdjustmentNegative();
  591. /**
  592. * Gets the base positive adjustment value for the order.
  593. *
  594. * @return float|null Base positive adjustment value.
  595. */
  596. public function getBaseAdjustmentPositive();
  597. /**
  598. * Gets the base currency code for the order.
  599. *
  600. * @return string|null Base currency code.
  601. */
  602. public function getBaseCurrencyCode();
  603. /**
  604. * Gets the base discount amount for the order.
  605. *
  606. * @return float|null Base discount amount.
  607. */
  608. public function getBaseDiscountAmount();
  609. /**
  610. * Gets the base discount canceled for the order.
  611. *
  612. * @return float|null Base discount canceled.
  613. */
  614. public function getBaseDiscountCanceled();
  615. /**
  616. * Gets the base discount invoiced amount for the order.
  617. *
  618. * @return float|null Base discount invoiced.
  619. */
  620. public function getBaseDiscountInvoiced();
  621. /**
  622. * Gets the base discount refunded amount for the order.
  623. *
  624. * @return float|null Base discount refunded.
  625. */
  626. public function getBaseDiscountRefunded();
  627. /**
  628. * Gets the base grand total for the order.
  629. *
  630. * @return float Base grand total.
  631. */
  632. public function getBaseGrandTotal();
  633. /**
  634. * Gets the base discount tax compensation amount for the order.
  635. *
  636. * @return float|null Base discount tax compensation amount.
  637. */
  638. public function getBaseDiscountTaxCompensationAmount();
  639. /**
  640. * Gets the base discount tax compensation invoiced amount for the order.
  641. *
  642. * @return float|null Base discount tax compensation invoiced.
  643. */
  644. public function getBaseDiscountTaxCompensationInvoiced();
  645. /**
  646. * Gets the base discount tax compensation refunded amount for the order.
  647. *
  648. * @return float|null Base discount tax compensation refunded.
  649. */
  650. public function getBaseDiscountTaxCompensationRefunded();
  651. /**
  652. * Gets the base shipping amount for the order.
  653. *
  654. * @return float|null Base shipping amount.
  655. */
  656. public function getBaseShippingAmount();
  657. /**
  658. * Gets the base shipping canceled for the order.
  659. *
  660. * @return float|null Base shipping canceled.
  661. */
  662. public function getBaseShippingCanceled();
  663. /**
  664. * Gets the base shipping discount amount for the order.
  665. *
  666. * @return float|null Base shipping discount amount.
  667. */
  668. public function getBaseShippingDiscountAmount();
  669. /**
  670. * Gets the base shipping discount tax compensation amount for the order.
  671. *
  672. * @return float|null Base shipping discount tax compensation amount.
  673. */
  674. public function getBaseShippingDiscountTaxCompensationAmnt();
  675. /**
  676. * Gets the base shipping including tax for the order.
  677. *
  678. * @return float|null Base shipping including tax.
  679. */
  680. public function getBaseShippingInclTax();
  681. /**
  682. * Gets the base shipping invoiced amount for the order.
  683. *
  684. * @return float|null Base shipping invoiced.
  685. */
  686. public function getBaseShippingInvoiced();
  687. /**
  688. * Gets the base shipping refunded amount for the order.
  689. *
  690. * @return float|null Base shipping refunded.
  691. */
  692. public function getBaseShippingRefunded();
  693. /**
  694. * Gets the base shipping tax amount for the order.
  695. *
  696. * @return float|null Base shipping tax amount.
  697. */
  698. public function getBaseShippingTaxAmount();
  699. /**
  700. * Gets the base shipping tax refunded amount for the order.
  701. *
  702. * @return float|null Base shipping tax refunded.
  703. */
  704. public function getBaseShippingTaxRefunded();
  705. /**
  706. * Gets the base subtotal for the order.
  707. *
  708. * @return float|null Base subtotal.
  709. */
  710. public function getBaseSubtotal();
  711. /**
  712. * Gets the base subtotal canceled for the order.
  713. *
  714. * @return float|null Base subtotal canceled.
  715. */
  716. public function getBaseSubtotalCanceled();
  717. /**
  718. * Gets the base subtotal including tax for the order.
  719. *
  720. * @return float|null Base subtotal including tax.
  721. */
  722. public function getBaseSubtotalInclTax();
  723. /**
  724. * Gets the base subtotal invoiced amount for the order.
  725. *
  726. * @return float|null Base subtotal invoiced.
  727. */
  728. public function getBaseSubtotalInvoiced();
  729. /**
  730. * Gets the base subtotal refunded amount for the order.
  731. *
  732. * @return float|null Base subtotal refunded.
  733. */
  734. public function getBaseSubtotalRefunded();
  735. /**
  736. * Gets the base tax amount for the order.
  737. *
  738. * @return float|null Base tax amount.
  739. */
  740. public function getBaseTaxAmount();
  741. /**
  742. * Gets the base tax canceled for the order.
  743. *
  744. * @return float|null Base tax canceled.
  745. */
  746. public function getBaseTaxCanceled();
  747. /**
  748. * Gets the base tax invoiced amount for the order.
  749. *
  750. * @return float|null Base tax invoiced.
  751. */
  752. public function getBaseTaxInvoiced();
  753. /**
  754. * Gets the base tax refunded amount for the order.
  755. *
  756. * @return float|null Base tax refunded.
  757. */
  758. public function getBaseTaxRefunded();
  759. /**
  760. * Gets the base total canceled for the order.
  761. *
  762. * @return float|null Base total canceled.
  763. */
  764. public function getBaseTotalCanceled();
  765. /**
  766. * Gets the base total due for the order.
  767. *
  768. * @return float|null Base total due.
  769. */
  770. public function getBaseTotalDue();
  771. /**
  772. * Gets the base total invoiced amount for the order.
  773. *
  774. * @return float|null Base total invoiced.
  775. */
  776. public function getBaseTotalInvoiced();
  777. /**
  778. * Gets the base total invoiced cost for the order.
  779. *
  780. * @return float|null Base total invoiced cost.
  781. */
  782. public function getBaseTotalInvoicedCost();
  783. /**
  784. * Gets the base total offline refunded amount for the order.
  785. *
  786. * @return float|null Base total offline refunded.
  787. */
  788. public function getBaseTotalOfflineRefunded();
  789. /**
  790. * Gets the base total online refunded amount for the order.
  791. *
  792. * @return float|null Base total online refunded.
  793. */
  794. public function getBaseTotalOnlineRefunded();
  795. /**
  796. * Gets the base total paid for the order.
  797. *
  798. * @return float|null Base total paid.
  799. */
  800. public function getBaseTotalPaid();
  801. /**
  802. * Gets the base total quantity ordered for the order.
  803. *
  804. * @return float|null Base total quantity ordered.
  805. */
  806. public function getBaseTotalQtyOrdered();
  807. /**
  808. * Gets the base total refunded amount for the order.
  809. *
  810. * @return float|null Base total refunded.
  811. */
  812. public function getBaseTotalRefunded();
  813. /**
  814. * Gets the base-to-global rate for the order.
  815. *
  816. * @return float|null Base-to-global rate.
  817. */
  818. public function getBaseToGlobalRate();
  819. /**
  820. * Gets the base-to-order rate for the order.
  821. *
  822. * @return float|null Base-to-order rate.
  823. */
  824. public function getBaseToOrderRate();
  825. /**
  826. * Gets the billing address ID for the order.
  827. *
  828. * @return int|null Billing address ID.
  829. */
  830. public function getBillingAddressId();
  831. /**
  832. * Gets the can-ship-partially flag value for the order.
  833. *
  834. * @return int|null Can-ship-partially flag value.
  835. */
  836. public function getCanShipPartially();
  837. /**
  838. * Gets the can-ship-partially-item flag value for the order.
  839. *
  840. * @return int|null Can-ship-partially-item flag value.
  841. */
  842. public function getCanShipPartiallyItem();
  843. /**
  844. * Gets the coupon code for the order.
  845. *
  846. * @return string|null Coupon code.
  847. */
  848. public function getCouponCode();
  849. /**
  850. * Gets the created-at timestamp for the order.
  851. *
  852. * @return string|null Created-at timestamp.
  853. */
  854. public function getCreatedAt();
  855. /**
  856. * Sets the created-at timestamp for the order.
  857. *
  858. * @param string $createdAt timestamp
  859. * @return $this
  860. */
  861. public function setCreatedAt($createdAt);
  862. /**
  863. * Gets the customer date-of-birth (DOB) for the order.
  864. *
  865. * @return string|null Customer date-of-birth (DOB).
  866. */
  867. public function getCustomerDob();
  868. /**
  869. * Gets the customer email address for the order.
  870. *
  871. * @return string Customer email address.
  872. */
  873. public function getCustomerEmail();
  874. /**
  875. * Gets the customer first name for the order.
  876. *
  877. * @return string|null Customer first name.
  878. */
  879. public function getCustomerFirstname();
  880. /**
  881. * Gets the customer gender for the order.
  882. *
  883. * @return int|null Customer gender.
  884. */
  885. public function getCustomerGender();
  886. /**
  887. * Gets the customer group ID for the order.
  888. *
  889. * @return int|null Customer group ID.
  890. */
  891. public function getCustomerGroupId();
  892. /**
  893. * Gets the customer ID for the order.
  894. *
  895. * @return int|null Customer ID.
  896. */
  897. public function getCustomerId();
  898. /**
  899. * Gets the customer-is-guest flag value for the order.
  900. *
  901. * @return int|null Customer-is-guest flag value.
  902. */
  903. public function getCustomerIsGuest();
  904. /**
  905. * Gets the customer last name for the order.
  906. *
  907. * @return string|null Customer last name.
  908. */
  909. public function getCustomerLastname();
  910. /**
  911. * Gets the customer middle name for the order.
  912. *
  913. * @return string|null Customer middle name.
  914. */
  915. public function getCustomerMiddlename();
  916. /**
  917. * Gets the customer note for the order.
  918. *
  919. * @return string|null Customer note.
  920. */
  921. public function getCustomerNote();
  922. /**
  923. * Gets the customer-note-notify flag value for the order.
  924. *
  925. * @return int|null Customer-note-notify flag value.
  926. */
  927. public function getCustomerNoteNotify();
  928. /**
  929. * Gets the customer prefix for the order.
  930. *
  931. * @return string|null Customer prefix.
  932. */
  933. public function getCustomerPrefix();
  934. /**
  935. * Gets the customer suffix for the order.
  936. *
  937. * @return string|null Customer suffix.
  938. */
  939. public function getCustomerSuffix();
  940. /**
  941. * Gets the customer value-added tax (VAT) for the order.
  942. *
  943. * @return string|null Customer value-added tax (VAT).
  944. */
  945. public function getCustomerTaxvat();
  946. /**
  947. * Gets the discount amount for the order.
  948. *
  949. * @return float|null Discount amount.
  950. */
  951. public function getDiscountAmount();
  952. /**
  953. * Gets the discount canceled for the order.
  954. *
  955. * @return float|null Discount canceled.
  956. */
  957. public function getDiscountCanceled();
  958. /**
  959. * Gets the discount description for the order.
  960. *
  961. * @return string|null Discount description.
  962. */
  963. public function getDiscountDescription();
  964. /**
  965. * Gets the discount invoiced amount for the order.
  966. *
  967. * @return float|null Discount invoiced.
  968. */
  969. public function getDiscountInvoiced();
  970. /**
  971. * Gets the discount refunded amount for the order.
  972. *
  973. * @return float|null Discount refunded amount.
  974. */
  975. public function getDiscountRefunded();
  976. /**
  977. * Gets the edit increment value for the order.
  978. *
  979. * @return int|null Edit increment value.
  980. */
  981. public function getEditIncrement();
  982. /**
  983. * Gets the email-sent flag value for the order.
  984. *
  985. * @return int|null Email-sent flag value.
  986. */
  987. public function getEmailSent();
  988. /**
  989. * Gets the ID for the order.
  990. *
  991. * @return int|null Order ID.
  992. */
  993. public function getEntityId();
  994. /**
  995. * Sets entity ID.
  996. *
  997. * @param int $entityId
  998. * @return $this
  999. */
  1000. public function setEntityId($entityId);
  1001. /**
  1002. * Gets the external customer ID for the order.
  1003. *
  1004. * @return string|null External customer ID.
  1005. */
  1006. public function getExtCustomerId();
  1007. /**
  1008. * Gets the external order ID for the order.
  1009. *
  1010. * @return string|null External order ID.
  1011. */
  1012. public function getExtOrderId();
  1013. /**
  1014. * Gets the forced-shipment-with-invoice flag value for the order.
  1015. *
  1016. * @return int|null Forced-shipment-with-invoice flag value.
  1017. */
  1018. public function getForcedShipmentWithInvoice();
  1019. /**
  1020. * Gets the global currency code for the order.
  1021. *
  1022. * @return string|null Global currency code.
  1023. */
  1024. public function getGlobalCurrencyCode();
  1025. /**
  1026. * Gets the grand total for the order.
  1027. *
  1028. * @return float Grand total.
  1029. */
  1030. public function getGrandTotal();
  1031. /**
  1032. * Gets the discount tax compensation amount for the order.
  1033. *
  1034. * @return float|null Discount tax compensation amount.
  1035. */
  1036. public function getDiscountTaxCompensationAmount();
  1037. /**
  1038. * Gets the discount tax compensation invoiced amount for the order.
  1039. *
  1040. * @return float|null Discount tax compensation invoiced amount.
  1041. */
  1042. public function getDiscountTaxCompensationInvoiced();
  1043. /**
  1044. * Gets the discount tax compensation refunded amount for the order.
  1045. *
  1046. * @return float|null Discount tax compensation refunded amount.
  1047. */
  1048. public function getDiscountTaxCompensationRefunded();
  1049. /**
  1050. * Gets the hold before state for the order.
  1051. *
  1052. * @return string|null Hold before state.
  1053. */
  1054. public function getHoldBeforeState();
  1055. /**
  1056. * Gets the hold before status for the order.
  1057. *
  1058. * @return string|null Hold before status.
  1059. */
  1060. public function getHoldBeforeStatus();
  1061. /**
  1062. * Gets the increment ID for the order.
  1063. *
  1064. * @return string|null Increment ID.
  1065. */
  1066. public function getIncrementId();
  1067. /**
  1068. * Gets the is-virtual flag value for the order.
  1069. *
  1070. * @return int|null Is-virtual flag value.
  1071. */
  1072. public function getIsVirtual();
  1073. /**
  1074. * Gets the order currency code for the order.
  1075. *
  1076. * @return string|null Order currency code.
  1077. */
  1078. public function getOrderCurrencyCode();
  1079. /**
  1080. * Gets the original increment ID for the order.
  1081. *
  1082. * @return string|null Original increment ID.
  1083. */
  1084. public function getOriginalIncrementId();
  1085. /**
  1086. * Gets the payment authorization amount for the order.
  1087. *
  1088. * @return float|null Payment authorization amount.
  1089. */
  1090. public function getPaymentAuthorizationAmount();
  1091. /**
  1092. * Gets the payment authorization expiration date for the order.
  1093. *
  1094. * @return int|null Payment authorization expiration date.
  1095. */
  1096. public function getPaymentAuthExpiration();
  1097. /**
  1098. * Gets the protect code for the order.
  1099. *
  1100. * @return string|null Protect code.
  1101. */
  1102. public function getProtectCode();
  1103. /**
  1104. * Gets the quote address ID for the order.
  1105. *
  1106. * @return int|null Quote address ID.
  1107. */
  1108. public function getQuoteAddressId();
  1109. /**
  1110. * Gets the quote ID for the order.
  1111. *
  1112. * @return int|null Quote ID.
  1113. */
  1114. public function getQuoteId();
  1115. /**
  1116. * Gets the relation child ID for the order.
  1117. *
  1118. * @return string|null Relation child ID.
  1119. */
  1120. public function getRelationChildId();
  1121. /**
  1122. * Gets the relation child real ID for the order.
  1123. *
  1124. * @return string|null Relation child real ID.
  1125. */
  1126. public function getRelationChildRealId();
  1127. /**
  1128. * Gets the relation parent ID for the order.
  1129. *
  1130. * @return string|null Relation parent ID.
  1131. */
  1132. public function getRelationParentId();
  1133. /**
  1134. * Gets the relation parent real ID for the order.
  1135. *
  1136. * @return string|null Relation parent real ID.
  1137. */
  1138. public function getRelationParentRealId();
  1139. /**
  1140. * Gets the remote IP address for the order.
  1141. *
  1142. * @return string|null Remote IP address.
  1143. */
  1144. public function getRemoteIp();
  1145. /**
  1146. * Gets the shipping amount for the order.
  1147. *
  1148. * @return float|null Shipping amount.
  1149. */
  1150. public function getShippingAmount();
  1151. /**
  1152. * Gets the shipping canceled amount for the order.
  1153. *
  1154. * @return float|null Shipping canceled amount.
  1155. */
  1156. public function getShippingCanceled();
  1157. /**
  1158. * Gets the shipping description for the order.
  1159. *
  1160. * @return string|null Shipping description.
  1161. */
  1162. public function getShippingDescription();
  1163. /**
  1164. * Gets the shipping discount amount for the order.
  1165. *
  1166. * @return float|null Shipping discount amount.
  1167. */
  1168. public function getShippingDiscountAmount();
  1169. /**
  1170. * Gets the shipping discount tax compensation amount for the order.
  1171. *
  1172. * @return float|null Shipping discount tax compensation amount.
  1173. */
  1174. public function getShippingDiscountTaxCompensationAmount();
  1175. /**
  1176. * Gets the shipping including tax amount for the order.
  1177. *
  1178. * @return float|null Shipping including tax amount.
  1179. */
  1180. public function getShippingInclTax();
  1181. /**
  1182. * Gets the shipping invoiced amount for the order.
  1183. *
  1184. * @return float|null Shipping invoiced amount.
  1185. */
  1186. public function getShippingInvoiced();
  1187. /**
  1188. * Gets the shipping refunded amount for the order.
  1189. *
  1190. * @return float|null Shipping refunded amount.
  1191. */
  1192. public function getShippingRefunded();
  1193. /**
  1194. * Gets the shipping tax amount for the order.
  1195. *
  1196. * @return float|null Shipping tax amount.
  1197. */
  1198. public function getShippingTaxAmount();
  1199. /**
  1200. * Gets the shipping tax refunded amount for the order.
  1201. *
  1202. * @return float|null Shipping tax refunded amount.
  1203. */
  1204. public function getShippingTaxRefunded();
  1205. /**
  1206. * Gets the state for the order.
  1207. *
  1208. * @return string|null State.
  1209. */
  1210. public function getState();
  1211. /**
  1212. * Gets the status for the order.
  1213. *
  1214. * @return string|null Status.
  1215. */
  1216. public function getStatus();
  1217. /**
  1218. * Gets the store currency code for the order.
  1219. *
  1220. * @return string|null Store currency code.
  1221. */
  1222. public function getStoreCurrencyCode();
  1223. /**
  1224. * Gets the store ID for the order.
  1225. *
  1226. * @return int|null Store ID.
  1227. */
  1228. public function getStoreId();
  1229. /**
  1230. * Gets the store name for the order.
  1231. *
  1232. * @return string|null Store name.
  1233. */
  1234. public function getStoreName();
  1235. /**
  1236. * Gets the store-to-base rate for the order.
  1237. *
  1238. * @return float|null Store-to-base rate.
  1239. */
  1240. public function getStoreToBaseRate();
  1241. /**
  1242. * Gets the store-to-order rate for the order.
  1243. *
  1244. * @return float|null Store-to-order rate.
  1245. */
  1246. public function getStoreToOrderRate();
  1247. /**
  1248. * Gets the subtotal for the order.
  1249. *
  1250. * @return float|null Subtotal.
  1251. */
  1252. public function getSubtotal();
  1253. /**
  1254. * Gets the subtotal canceled amount for the order.
  1255. *
  1256. * @return float|null Subtotal canceled amount.
  1257. */
  1258. public function getSubtotalCanceled();
  1259. /**
  1260. * Gets the subtotal including tax amount for the order.
  1261. *
  1262. * @return float|null Subtotal including tax amount.
  1263. */
  1264. public function getSubtotalInclTax();
  1265. /**
  1266. * Gets the subtotal invoiced amount for the order.
  1267. *
  1268. * @return float|null Subtotal invoiced amount.
  1269. */
  1270. public function getSubtotalInvoiced();
  1271. /**
  1272. * Gets the subtotal refunded amount for the order.
  1273. *
  1274. * @return float|null Subtotal refunded amount.
  1275. */
  1276. public function getSubtotalRefunded();
  1277. /**
  1278. * Gets the tax amount for the order.
  1279. *
  1280. * @return float|null Tax amount.
  1281. */
  1282. public function getTaxAmount();
  1283. /**
  1284. * Gets the tax canceled amount for the order.
  1285. *
  1286. * @return float|null Tax canceled amount.
  1287. */
  1288. public function getTaxCanceled();
  1289. /**
  1290. * Gets the tax invoiced amount for the order.
  1291. *
  1292. * @return float|null Tax invoiced amount.
  1293. */
  1294. public function getTaxInvoiced();
  1295. /**
  1296. * Gets the tax refunded amount for the order.
  1297. *
  1298. * @return float|null Tax refunded amount.
  1299. */
  1300. public function getTaxRefunded();
  1301. /**
  1302. * Gets the total canceled for the order.
  1303. *
  1304. * @return float|null Total canceled.
  1305. */
  1306. public function getTotalCanceled();
  1307. /**
  1308. * Gets the total due for the order.
  1309. *
  1310. * @return float|null Total due.
  1311. */
  1312. public function getTotalDue();
  1313. /**
  1314. * Gets the total invoiced amount for the order.
  1315. *
  1316. * @return float|null Total invoiced amount.
  1317. */
  1318. public function getTotalInvoiced();
  1319. /**
  1320. * Gets the total item count for the order.
  1321. *
  1322. * @return int|null Total item count.
  1323. */
  1324. public function getTotalItemCount();
  1325. /**
  1326. * Gets the total offline refunded amount for the order.
  1327. *
  1328. * @return float|null Total offline refunded amount.
  1329. */
  1330. public function getTotalOfflineRefunded();
  1331. /**
  1332. * Gets the total online refunded amount for the order.
  1333. *
  1334. * @return float|null Total online refunded amount.
  1335. */
  1336. public function getTotalOnlineRefunded();
  1337. /**
  1338. * Gets the total paid for the order.
  1339. *
  1340. * @return float|null Total paid.
  1341. */
  1342. public function getTotalPaid();
  1343. /**
  1344. * Gets the total quantity ordered for the order.
  1345. *
  1346. * @return float|null Total quantity ordered.
  1347. */
  1348. public function getTotalQtyOrdered();
  1349. /**
  1350. * Gets the total amount refunded amount for the order.
  1351. *
  1352. * @return float|null Total amount refunded.
  1353. */
  1354. public function getTotalRefunded();
  1355. /**
  1356. * Gets the updated-at timestamp for the order.
  1357. *
  1358. * @return string|null Updated-at timestamp.
  1359. */
  1360. public function getUpdatedAt();
  1361. /**
  1362. * Gets the weight for the order.
  1363. *
  1364. * @return float|null Weight.
  1365. */
  1366. public function getWeight();
  1367. /**
  1368. * Gets the X-Forwarded-For HTTP header field for the order.
  1369. *
  1370. * This field identifies the originating IP address of a client
  1371. * connecting to a web server through an HTTP proxy or load balancer.
  1372. *
  1373. * @return string|null X-Forwarded-For field value.
  1374. */
  1375. public function getXForwardedFor();
  1376. /**
  1377. * Gets items for the order.
  1378. *
  1379. * @return \Magento\Sales\Api\Data\OrderItemInterface[] Array of items.
  1380. */
  1381. public function getItems();
  1382. /**
  1383. * Sets items for the order.
  1384. *
  1385. * @param \Magento\Sales\Api\Data\OrderItemInterface[] $items
  1386. * @return $this
  1387. */
  1388. public function setItems($items);
  1389. /**
  1390. * Gets the billing address, if any, for the order.
  1391. *
  1392. * @return \Magento\Sales\Api\Data\OrderAddressInterface|null Billing address. Otherwise, null.
  1393. */
  1394. public function getBillingAddress();
  1395. /**
  1396. * Sets the billing address, if any, for the order.
  1397. *
  1398. * @param \Magento\Sales\Api\Data\OrderAddressInterface $billingAddress
  1399. * @return $this
  1400. */
  1401. public function setBillingAddress(\Magento\Sales\Api\Data\OrderAddressInterface $billingAddress = null);
  1402. /**
  1403. * Gets order payment
  1404. *
  1405. * @return \Magento\Sales\Api\Data\OrderPaymentInterface|null
  1406. */
  1407. public function getPayment();
  1408. /**
  1409. * Sets order payment
  1410. *
  1411. * @param \Magento\Sales\Api\Data\OrderPaymentInterface|null $payment
  1412. * @return \Magento\Sales\Api\Data\OrderPaymentInterface
  1413. */
  1414. public function setPayment(\Magento\Sales\Api\Data\OrderPaymentInterface $payment = null);
  1415. /**
  1416. * Gets status histories for the order.
  1417. *
  1418. * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface[]|null Array of status histories.
  1419. */
  1420. public function getStatusHistories();
  1421. /**
  1422. * Sets status histories for the order.
  1423. *
  1424. * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface[] $statusHistories
  1425. * @return $this
  1426. */
  1427. public function setStatusHistories(array $statusHistories = null);
  1428. /**
  1429. * Sets the state for the order.
  1430. *
  1431. * @param string $state
  1432. * @return $this
  1433. */
  1434. public function setState($state);
  1435. /**
  1436. * Sets the status for the order.
  1437. *
  1438. * @param string $status
  1439. * @return $this
  1440. */
  1441. public function setStatus($status);
  1442. /**
  1443. * Sets the coupon code for the order.
  1444. *
  1445. * @param string $code
  1446. * @return $this
  1447. */
  1448. public function setCouponCode($code);
  1449. /**
  1450. * Sets the protect code for the order.
  1451. *
  1452. * @param string $code
  1453. * @return $this
  1454. */
  1455. public function setProtectCode($code);
  1456. /**
  1457. * Sets the shipping description for the order.
  1458. *
  1459. * @param string $description
  1460. * @return $this
  1461. */
  1462. public function setShippingDescription($description);
  1463. /**
  1464. * Sets the is-virtual flag value for the order.
  1465. *
  1466. * @param int $isVirtual
  1467. * @return $this
  1468. */
  1469. public function setIsVirtual($isVirtual);
  1470. /**
  1471. * Sets the store ID for the order.
  1472. *
  1473. * @param int $id
  1474. * @return $this
  1475. */
  1476. public function setStoreId($id);
  1477. /**
  1478. * Sets the customer ID for the order.
  1479. *
  1480. * @param int $id
  1481. * @return $this
  1482. */
  1483. public function setCustomerId($id);
  1484. /**
  1485. * Sets the base discount amount for the order.
  1486. *
  1487. * @param float $amount
  1488. * @return $this
  1489. */
  1490. public function setBaseDiscountAmount($amount);
  1491. /**
  1492. * Sets the base discount canceled for the order.
  1493. *
  1494. * @param float $baseDiscountCanceled
  1495. * @return $this
  1496. */
  1497. public function setBaseDiscountCanceled($baseDiscountCanceled);
  1498. /**
  1499. * Sets the base discount invoiced amount for the order.
  1500. *
  1501. * @param float $baseDiscountInvoiced
  1502. * @return $this
  1503. */
  1504. public function setBaseDiscountInvoiced($baseDiscountInvoiced);
  1505. /**
  1506. * Sets the base discount refunded amount for the order.
  1507. *
  1508. * @param float $baseDiscountRefunded
  1509. * @return $this
  1510. */
  1511. public function setBaseDiscountRefunded($baseDiscountRefunded);
  1512. /**
  1513. * Sets the base grand total for the order.
  1514. *
  1515. * @param float $amount
  1516. * @return $this
  1517. */
  1518. public function setBaseGrandTotal($amount);
  1519. /**
  1520. * Sets the base shipping amount for the order.
  1521. *
  1522. * @param float $amount
  1523. * @return $this
  1524. */
  1525. public function setBaseShippingAmount($amount);
  1526. /**
  1527. * Sets the base shipping canceled for the order.
  1528. *
  1529. * @param float $baseShippingCanceled
  1530. * @return $this
  1531. */
  1532. public function setBaseShippingCanceled($baseShippingCanceled);
  1533. /**
  1534. * Sets the base shipping invoiced amount for the order.
  1535. *
  1536. * @param float $baseShippingInvoiced
  1537. * @return $this
  1538. */
  1539. public function setBaseShippingInvoiced($baseShippingInvoiced);
  1540. /**
  1541. * Sets the base shipping refunded amount for the order.
  1542. *
  1543. * @param float $baseShippingRefunded
  1544. * @return $this
  1545. */
  1546. public function setBaseShippingRefunded($baseShippingRefunded);
  1547. /**
  1548. * Sets the base shipping tax amount for the order.
  1549. *
  1550. * @param float $amount
  1551. * @return $this
  1552. */
  1553. public function setBaseShippingTaxAmount($amount);
  1554. /**
  1555. * Sets the base shipping tax refunded amount for the order.
  1556. *
  1557. * @param float $baseShippingTaxRefunded
  1558. * @return $this
  1559. */
  1560. public function setBaseShippingTaxRefunded($baseShippingTaxRefunded);
  1561. /**
  1562. * Sets the base subtotal for the order.
  1563. *
  1564. * @param float $amount
  1565. * @return $this
  1566. */
  1567. public function setBaseSubtotal($amount);
  1568. /**
  1569. * Sets the base subtotal canceled for the order.
  1570. *
  1571. * @param float $baseSubtotalCanceled
  1572. * @return $this
  1573. */
  1574. public function setBaseSubtotalCanceled($baseSubtotalCanceled);
  1575. /**
  1576. * Sets the base subtotal invoiced amount for the order.
  1577. *
  1578. * @param float $baseSubtotalInvoiced
  1579. * @return $this
  1580. */
  1581. public function setBaseSubtotalInvoiced($baseSubtotalInvoiced);
  1582. /**
  1583. * Sets the base subtotal refunded amount for the order.
  1584. *
  1585. * @param float $baseSubtotalRefunded
  1586. * @return $this
  1587. */
  1588. public function setBaseSubtotalRefunded($baseSubtotalRefunded);
  1589. /**
  1590. * Sets the base tax amount for the order.
  1591. *
  1592. * @param float $amount
  1593. * @return $this
  1594. */
  1595. public function setBaseTaxAmount($amount);
  1596. /**
  1597. * Sets the base tax canceled for the order.
  1598. *
  1599. * @param float $baseTaxCanceled
  1600. * @return $this
  1601. */
  1602. public function setBaseTaxCanceled($baseTaxCanceled);
  1603. /**
  1604. * Sets the base tax invoiced amount for the order.
  1605. *
  1606. * @param float $baseTaxInvoiced
  1607. * @return $this
  1608. */
  1609. public function setBaseTaxInvoiced($baseTaxInvoiced);
  1610. /**
  1611. * Sets the base tax refunded amount for the order.
  1612. *
  1613. * @param float $baseTaxRefunded
  1614. * @return $this
  1615. */
  1616. public function setBaseTaxRefunded($baseTaxRefunded);
  1617. /**
  1618. * Sets the base-to-global rate for the order.
  1619. *
  1620. * @param float $rate
  1621. * @return $this
  1622. */
  1623. public function setBaseToGlobalRate($rate);
  1624. /**
  1625. * Sets the base-to-order rate for the order.
  1626. *
  1627. * @param float $rate
  1628. * @return $this
  1629. */
  1630. public function setBaseToOrderRate($rate);
  1631. /**
  1632. * Sets the base total canceled for the order.
  1633. *
  1634. * @param float $baseTotalCanceled
  1635. * @return $this
  1636. */
  1637. public function setBaseTotalCanceled($baseTotalCanceled);
  1638. /**
  1639. * Sets the base total invoiced amount for the order.
  1640. *
  1641. * @param float $baseTotalInvoiced
  1642. * @return $this
  1643. */
  1644. public function setBaseTotalInvoiced($baseTotalInvoiced);
  1645. /**
  1646. * Sets the base total invoiced cost for the order.
  1647. *
  1648. * @param float $baseTotalInvoicedCost
  1649. * @return $this
  1650. */
  1651. public function setBaseTotalInvoicedCost($baseTotalInvoicedCost);
  1652. /**
  1653. * Sets the base total offline refunded amount for the order.
  1654. *
  1655. * @param float $baseTotalOfflineRefunded
  1656. * @return $this
  1657. */
  1658. public function setBaseTotalOfflineRefunded($baseTotalOfflineRefunded);
  1659. /**
  1660. * Sets the base total online refunded amount for the order.
  1661. *
  1662. * @param float $baseTotalOnlineRefunded
  1663. * @return $this
  1664. */
  1665. public function setBaseTotalOnlineRefunded($baseTotalOnlineRefunded);
  1666. /**
  1667. * Sets the base total paid for the order.
  1668. *
  1669. * @param float $baseTotalPaid
  1670. * @return $this
  1671. */
  1672. public function setBaseTotalPaid($baseTotalPaid);
  1673. /**
  1674. * Sets the base total quantity ordered for the order.
  1675. *
  1676. * @param float $baseTotalQtyOrdered
  1677. * @return $this
  1678. */
  1679. public function setBaseTotalQtyOrdered($baseTotalQtyOrdered);
  1680. /**
  1681. * Sets the base total refunded amount for the order.
  1682. *
  1683. * @param float $baseTotalRefunded
  1684. * @return $this
  1685. */
  1686. public function setBaseTotalRefunded($baseTotalRefunded);
  1687. /**
  1688. * Sets the discount amount for the order.
  1689. *
  1690. * @param float $amount
  1691. * @return $this
  1692. */
  1693. public function setDiscountAmount($amount);
  1694. /**
  1695. * Sets the discount canceled for the order.
  1696. *
  1697. * @param float $discountCanceled
  1698. * @return $this
  1699. */
  1700. public function setDiscountCanceled($discountCanceled);
  1701. /**
  1702. * Sets the discount invoiced amount for the order.
  1703. *
  1704. * @param float $discountInvoiced
  1705. * @return $this
  1706. */
  1707. public function setDiscountInvoiced($discountInvoiced);
  1708. /**
  1709. * Sets the discount refunded amount for the order.
  1710. *
  1711. * @param float $discountRefunded
  1712. * @return $this
  1713. */
  1714. public function setDiscountRefunded($discountRefunded);
  1715. /**
  1716. * Sets the grand total for the order.
  1717. *
  1718. * @param float $amount
  1719. * @return $this
  1720. */
  1721. public function setGrandTotal($amount);
  1722. /**
  1723. * Sets the shipping amount for the order.
  1724. *
  1725. * @param float $amount
  1726. * @return $this
  1727. */
  1728. public function setShippingAmount($amount);
  1729. /**
  1730. * Sets the shipping canceled amount for the order.
  1731. *
  1732. * @param float $shippingCanceled
  1733. * @return $this
  1734. */
  1735. public function setShippingCanceled($shippingCanceled);
  1736. /**
  1737. * Sets the shipping invoiced amount for the order.
  1738. *
  1739. * @param float $shippingInvoiced
  1740. * @return $this
  1741. */
  1742. public function setShippingInvoiced($shippingInvoiced);
  1743. /**
  1744. * Sets the shipping refunded amount for the order.
  1745. *
  1746. * @param float $shippingRefunded
  1747. * @return $this
  1748. */
  1749. public function setShippingRefunded($shippingRefunded);
  1750. /**
  1751. * Sets the shipping tax amount for the order.
  1752. *
  1753. * @param float $amount
  1754. * @return $this
  1755. */
  1756. public function setShippingTaxAmount($amount);
  1757. /**
  1758. * Sets the shipping tax refunded amount for the order.
  1759. *
  1760. * @param float $shippingTaxRefunded
  1761. * @return $this
  1762. */
  1763. public function setShippingTaxRefunded($shippingTaxRefunded);
  1764. /**
  1765. * Sets the store-to-base rate for the order.
  1766. *
  1767. * @param float $rate
  1768. * @return $this
  1769. */
  1770. public function setStoreToBaseRate($rate);
  1771. /**
  1772. * Sets the store-to-order rate for the order.
  1773. *
  1774. * @param float $rate
  1775. * @return $this
  1776. */
  1777. public function setStoreToOrderRate($rate);
  1778. /**
  1779. * Sets the subtotal for the order.
  1780. *
  1781. * @param float $amount
  1782. * @return $this
  1783. */
  1784. public function setSubtotal($amount);
  1785. /**
  1786. * Sets the subtotal canceled amount for the order.
  1787. *
  1788. * @param float $subtotalCanceled
  1789. * @return $this
  1790. */
  1791. public function setSubtotalCanceled($subtotalCanceled);
  1792. /**
  1793. * Sets the subtotal invoiced amount for the order.
  1794. *
  1795. * @param float $subtotalInvoiced
  1796. * @return $this
  1797. */
  1798. public function setSubtotalInvoiced($subtotalInvoiced);
  1799. /**
  1800. * Sets the subtotal refunded amount for the order.
  1801. *
  1802. * @param float $subtotalRefunded
  1803. * @return $this
  1804. */
  1805. public function setSubtotalRefunded($subtotalRefunded);
  1806. /**
  1807. * Sets the tax amount for the order.
  1808. *
  1809. * @param float $amount
  1810. * @return $this
  1811. */
  1812. public function setTaxAmount($amount);
  1813. /**
  1814. * Sets the tax canceled amount for the order.
  1815. *
  1816. * @param float $taxCanceled
  1817. * @return $this
  1818. */
  1819. public function setTaxCanceled($taxCanceled);
  1820. /**
  1821. * Sets the tax invoiced amount for the order.
  1822. *
  1823. * @param float $taxInvoiced
  1824. * @return $this
  1825. */
  1826. public function setTaxInvoiced($taxInvoiced);
  1827. /**
  1828. * Sets the tax refunded amount for the order.
  1829. *
  1830. * @param float $taxRefunded
  1831. * @return $this
  1832. */
  1833. public function setTaxRefunded($taxRefunded);
  1834. /**
  1835. * Sets the total canceled for the order.
  1836. *
  1837. * @param float $totalCanceled
  1838. * @return $this
  1839. */
  1840. public function setTotalCanceled($totalCanceled);
  1841. /**
  1842. * Sets the total invoiced amount for the order.
  1843. *
  1844. * @param float $totalInvoiced
  1845. * @return $this
  1846. */
  1847. public function setTotalInvoiced($totalInvoiced);
  1848. /**
  1849. * Sets the total offline refunded amount for the order.
  1850. *
  1851. * @param float $totalOfflineRefunded
  1852. * @return $this
  1853. */
  1854. public function setTotalOfflineRefunded($totalOfflineRefunded);
  1855. /**
  1856. * Sets the total online refunded amount for the order.
  1857. *
  1858. * @param float $totalOnlineRefunded
  1859. * @return $this
  1860. */
  1861. public function setTotalOnlineRefunded($totalOnlineRefunded);
  1862. /**
  1863. * Sets the total paid for the order.
  1864. *
  1865. * @param float $totalPaid
  1866. * @return $this
  1867. */
  1868. public function setTotalPaid($totalPaid);
  1869. /**
  1870. * Sets the total quantity ordered for the order.
  1871. *
  1872. * @param float $totalQtyOrdered
  1873. * @return $this
  1874. */
  1875. public function setTotalQtyOrdered($totalQtyOrdered);
  1876. /**
  1877. * Sets the total amount refunded amount for the order.
  1878. *
  1879. * @param float $totalRefunded
  1880. * @return $this
  1881. */
  1882. public function setTotalRefunded($totalRefunded);
  1883. /**
  1884. * Sets the can-ship-partially flag value for the order.
  1885. *
  1886. * @param int $flag
  1887. * @return $this
  1888. */
  1889. public function setCanShipPartially($flag);
  1890. /**
  1891. * Sets the can-ship-partially-item flag value for the order.
  1892. *
  1893. * @param int $flag
  1894. * @return $this
  1895. */
  1896. public function setCanShipPartiallyItem($flag);
  1897. /**
  1898. * Sets the customer-is-guest flag value for the order.
  1899. *
  1900. * @param int $customerIsGuest
  1901. * @return $this
  1902. */
  1903. public function setCustomerIsGuest($customerIsGuest);
  1904. /**
  1905. * Sets the customer-note-notify flag value for the order.
  1906. *
  1907. * @param int $customerNoteNotify
  1908. * @return $this
  1909. */
  1910. public function setCustomerNoteNotify($customerNoteNotify);
  1911. /**
  1912. * Sets the billing address ID for the order.
  1913. *
  1914. * @param int $id
  1915. * @return $this
  1916. */
  1917. public function setBillingAddressId($id);
  1918. /**
  1919. * Sets the customer group ID for the order.
  1920. *
  1921. * @param int $id
  1922. * @return $this
  1923. */
  1924. public function setCustomerGroupId($id);
  1925. /**
  1926. * Sets the edit increment value for the order.
  1927. *
  1928. * @param int $editIncrement
  1929. * @return $this
  1930. */
  1931. public function setEditIncrement($editIncrement);
  1932. /**
  1933. * Sets the email-sent flag value for the order.
  1934. *
  1935. * @param int $emailSent
  1936. * @return $this
  1937. */
  1938. public function setEmailSent($emailSent);
  1939. /**
  1940. * Sets the forced-shipment-with-invoice flag value for the order.
  1941. *
  1942. * @param int $forcedShipmentWithInvoice
  1943. * @return $this
  1944. */
  1945. public function setForcedShipmentWithInvoice($forcedShipmentWithInvoice);
  1946. /**
  1947. * Sets the payment authorization expiration date for the order.
  1948. *
  1949. * @param int $paymentAuthExpiration
  1950. * @return $this
  1951. */
  1952. public function setPaymentAuthExpiration($paymentAuthExpiration);
  1953. /**
  1954. * Sets the quote address ID for the order.
  1955. *
  1956. * @param int $id
  1957. * @return $this
  1958. */
  1959. public function setQuoteAddressId($id);
  1960. /**
  1961. * Sets the quote ID for the order.
  1962. *
  1963. * @param int $id
  1964. * @return $this
  1965. */
  1966. public function setQuoteId($id);
  1967. /**
  1968. * Sets the negative adjustment value for the order.
  1969. *
  1970. * @param float $adjustmentNegative
  1971. * @return $this
  1972. */
  1973. public function setAdjustmentNegative($adjustmentNegative);
  1974. /**
  1975. * Sets the positive adjustment value for the order.
  1976. *
  1977. * @param float $adjustmentPositive
  1978. * @return $this
  1979. */
  1980. public function setAdjustmentPositive($adjustmentPositive);
  1981. /**
  1982. * Sets the base negative adjustment value for the order.
  1983. *
  1984. * @param float $baseAdjustmentNegative
  1985. * @return $this
  1986. */
  1987. public function setBaseAdjustmentNegative($baseAdjustmentNegative);
  1988. /**
  1989. * Sets the base positive adjustment value for the order.
  1990. *
  1991. * @param float $baseAdjustmentPositive
  1992. * @return $this
  1993. */
  1994. public function setBaseAdjustmentPositive($baseAdjustmentPositive);
  1995. /**
  1996. * Sets the base shipping discount amount for the order.
  1997. *
  1998. * @param float $amount
  1999. * @return $this
  2000. */
  2001. public function setBaseShippingDiscountAmount($amount);
  2002. /**
  2003. * Sets the base subtotal including tax for the order.
  2004. *
  2005. * @param float $amount
  2006. * @return $this
  2007. */
  2008. public function setBaseSubtotalInclTax($amount);
  2009. /**
  2010. * Sets the base total due for the order.
  2011. *
  2012. * @param float $baseTotalDue
  2013. * @return $this
  2014. */
  2015. public function setBaseTotalDue($baseTotalDue);
  2016. /**
  2017. * Sets the payment authorization amount for the order.
  2018. *
  2019. * @param float $amount
  2020. * @return $this
  2021. */
  2022. public function setPaymentAuthorizationAmount($amount);
  2023. /**
  2024. * Sets the shipping discount amount for the order.
  2025. *
  2026. * @param float $amount
  2027. * @return $this
  2028. */
  2029. public function setShippingDiscountAmount($amount);
  2030. /**
  2031. * Sets the subtotal including tax amount for the order.
  2032. *
  2033. * @param float $amount
  2034. * @return $this
  2035. */
  2036. public function setSubtotalInclTax($amount);
  2037. /**
  2038. * Sets the total due for the order.
  2039. *
  2040. * @param float $totalDue
  2041. * @return $this
  2042. */
  2043. public function setTotalDue($totalDue);
  2044. /**
  2045. * Sets the weight for the order.
  2046. *
  2047. * @param float $weight
  2048. * @return $this
  2049. */
  2050. public function setWeight($weight);
  2051. /**
  2052. * Sets the customer date-of-birth (DOB) for the order.
  2053. *
  2054. * @param string $customerDob
  2055. * @return $this
  2056. */
  2057. public function setCustomerDob($customerDob);
  2058. /**
  2059. * Sets the increment ID for the order.
  2060. *
  2061. * @param string $id
  2062. * @return $this
  2063. */
  2064. public function setIncrementId($id);
  2065. /**
  2066. * Sets the applied rule IDs for the order.
  2067. *
  2068. * @param string $appliedRuleIds
  2069. * @return $this
  2070. */
  2071. public function setAppliedRuleIds($appliedRuleIds);
  2072. /**
  2073. * Sets the base currency code for the order.
  2074. *
  2075. * @param string $code
  2076. * @return $this
  2077. */
  2078. public function setBaseCurrencyCode($code);
  2079. /**
  2080. * Sets the customer email address for the order.
  2081. *
  2082. * @param string $customerEmail
  2083. * @return $this
  2084. */
  2085. public function setCustomerEmail($customerEmail);
  2086. /**
  2087. * Sets the customer first name for the order.
  2088. *
  2089. * @param string $customerFirstname
  2090. * @return $this
  2091. */
  2092. public function setCustomerFirstname($customerFirstname);
  2093. /**
  2094. * Sets the customer last name for the order.
  2095. *
  2096. * @param string $customerLastname
  2097. * @return $this
  2098. */
  2099. public function setCustomerLastname($customerLastname);
  2100. /**
  2101. * Sets the customer middle name for the order.
  2102. *
  2103. * @param string $customerMiddlename
  2104. * @return $this
  2105. */
  2106. public function setCustomerMiddlename($customerMiddlename);
  2107. /**
  2108. * Sets the customer prefix for the order.
  2109. *
  2110. * @param string $customerPrefix
  2111. * @return $this
  2112. */
  2113. public function setCustomerPrefix($customerPrefix);
  2114. /**
  2115. * Sets the customer suffix for the order.
  2116. *
  2117. * @param string $customerSuffix
  2118. * @return $this
  2119. */
  2120. public function setCustomerSuffix($customerSuffix);
  2121. /**
  2122. * Sets the customer value-added tax (VAT) for the order.
  2123. *
  2124. * @param string $customerTaxvat
  2125. * @return $this
  2126. */
  2127. public function setCustomerTaxvat($customerTaxvat);
  2128. /**
  2129. * Sets the discount description for the order.
  2130. *
  2131. * @param string $description
  2132. * @return $this
  2133. */
  2134. public function setDiscountDescription($description);
  2135. /**
  2136. * Sets the external customer ID for the order.
  2137. *
  2138. * @param string $id
  2139. * @return $this
  2140. */
  2141. public function setExtCustomerId($id);
  2142. /**
  2143. * Sets the external order ID for the order.
  2144. *
  2145. * @param string $id
  2146. * @return $this
  2147. */
  2148. public function setExtOrderId($id);
  2149. /**
  2150. * Sets the global currency code for the order.
  2151. *
  2152. * @param string $code
  2153. * @return $this
  2154. */
  2155. public function setGlobalCurrencyCode($code);
  2156. /**
  2157. * Sets the hold before state for the order.
  2158. *
  2159. * @param string $holdBeforeState
  2160. * @return $this
  2161. */
  2162. public function setHoldBeforeState($holdBeforeState);
  2163. /**
  2164. * Sets the hold before status for the order.
  2165. *
  2166. * @param string $holdBeforeStatus
  2167. * @return $this
  2168. */
  2169. public function setHoldBeforeStatus($holdBeforeStatus);
  2170. /**
  2171. * Sets the order currency code for the order.
  2172. *
  2173. * @param string $code
  2174. * @return $this
  2175. */
  2176. public function setOrderCurrencyCode($code);
  2177. /**
  2178. * Sets the original increment ID for the order.
  2179. *
  2180. * @param string $id
  2181. * @return $this
  2182. */
  2183. public function setOriginalIncrementId($id);
  2184. /**
  2185. * Sets the relation child ID for the order.
  2186. *
  2187. * @param string $id
  2188. * @return $this
  2189. */
  2190. public function setRelationChildId($id);
  2191. /**
  2192. * Sets the relation child real ID for the order.
  2193. *
  2194. * @param string $realId
  2195. * @return $this
  2196. */
  2197. public function setRelationChildRealId($realId);
  2198. /**
  2199. * Sets the relation parent ID for the order.
  2200. *
  2201. * @param string $id
  2202. * @return $this
  2203. */
  2204. public function setRelationParentId($id);
  2205. /**
  2206. * Sets the relation parent real ID for the order.
  2207. *
  2208. * @param string $realId
  2209. * @return $this
  2210. */
  2211. public function setRelationParentRealId($realId);
  2212. /**
  2213. * Sets the remote IP address for the order.
  2214. *
  2215. * @param string $remoteIp
  2216. * @return $this
  2217. */
  2218. public function setRemoteIp($remoteIp);
  2219. /**
  2220. * Sets the store currency code for the order.
  2221. *
  2222. * @param string $code
  2223. * @return $this
  2224. */
  2225. public function setStoreCurrencyCode($code);
  2226. /**
  2227. * Sets the store name for the order.
  2228. *
  2229. * @param string $storeName
  2230. * @return $this
  2231. */
  2232. public function setStoreName($storeName);
  2233. /**
  2234. * Sets the X-Forwarded-For HTTP header field for the order.
  2235. *
  2236. * @param string $xForwardedFor
  2237. * @return $this
  2238. */
  2239. public function setXForwardedFor($xForwardedFor);
  2240. /**
  2241. * Sets the customer note for the order.
  2242. *
  2243. * @param string $customerNote
  2244. * @return $this
  2245. */
  2246. public function setCustomerNote($customerNote);
  2247. /**
  2248. * Sets the updated-at timestamp for the order.
  2249. *
  2250. * @param string $timestamp
  2251. * @return $this
  2252. */
  2253. public function setUpdatedAt($timestamp);
  2254. /**
  2255. * Sets the total item count for the order.
  2256. *
  2257. * @param int $totalItemCount
  2258. * @return $this
  2259. */
  2260. public function setTotalItemCount($totalItemCount);
  2261. /**
  2262. * Sets the customer gender for the order.
  2263. *
  2264. * @param int $customerGender
  2265. * @return $this
  2266. */
  2267. public function setCustomerGender($customerGender);
  2268. /**
  2269. * Sets the discount tax compensation amount for the order.
  2270. *
  2271. * @param float $amount
  2272. * @return $this
  2273. */
  2274. public function setDiscountTaxCompensationAmount($amount);
  2275. /**
  2276. * Sets the base discount tax compensation amount for the order.
  2277. *
  2278. * @param float $amount
  2279. * @return $this
  2280. */
  2281. public function setBaseDiscountTaxCompensationAmount($amount);
  2282. /**
  2283. * Sets the shipping discount tax compensation amount for the order.
  2284. *
  2285. * @param float $amount
  2286. * @return $this
  2287. */
  2288. public function setShippingDiscountTaxCompensationAmount($amount);
  2289. /**
  2290. * Sets the base shipping discount tax compensation amount for the order.
  2291. *
  2292. * @param float $amnt
  2293. * @return $this
  2294. */
  2295. public function setBaseShippingDiscountTaxCompensationAmnt($amnt);
  2296. /**
  2297. * Sets the discount tax compensation invoiced amount for the order.
  2298. *
  2299. * @param float $discountTaxCompensationInvoiced
  2300. * @return $this
  2301. */
  2302. public function setDiscountTaxCompensationInvoiced($discountTaxCompensationInvoiced);
  2303. /**
  2304. * Sets the base discount tax compensation invoiced amount for the order.
  2305. *
  2306. * @param float $baseDiscountTaxCompensationInvoiced
  2307. * @return $this
  2308. */
  2309. public function setBaseDiscountTaxCompensationInvoiced($baseDiscountTaxCompensationInvoiced);
  2310. /**
  2311. * Sets the discount tax compensation refunded amount for the order.
  2312. *
  2313. * @param float $discountTaxCompensationRefunded
  2314. * @return $this
  2315. */
  2316. public function setDiscountTaxCompensationRefunded($discountTaxCompensationRefunded);
  2317. /**
  2318. * Sets the base discount tax compensation refunded amount for the order.
  2319. *
  2320. * @param float $baseDiscountTaxCompensationRefunded
  2321. * @return $this
  2322. */
  2323. public function setBaseDiscountTaxCompensationRefunded($baseDiscountTaxCompensationRefunded);
  2324. /**
  2325. * Sets the shipping including tax amount for the order.
  2326. *
  2327. * @param float $amount
  2328. * @return $this
  2329. */
  2330. public function setShippingInclTax($amount);
  2331. /**
  2332. * Sets the base shipping including tax for the order.
  2333. *
  2334. * @param float $amount
  2335. * @return $this
  2336. */
  2337. public function setBaseShippingInclTax($amount);
  2338. /**
  2339. * Retrieve existing extension attributes object or create a new one.
  2340. *
  2341. * @return \Magento\Sales\Api\Data\OrderExtensionInterface|null
  2342. */
  2343. public function getExtensionAttributes();
  2344. /**
  2345. * Set an extension attributes object.
  2346. *
  2347. * @param \Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes
  2348. * @return $this
  2349. */
  2350. public function setExtensionAttributes(\Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes);
  2351. }