1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Quote\Api\Data;
/**
* Interface TotalsInterface
* @api
* @since 100.0.2
*/
interface TotalsInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
/**#@+
* Constants defined for keys of array, makes typos less likely
*/
const KEY_GRAND_TOTAL = 'grand_total';
const KEY_BASE_GRAND_TOTAL = 'base_grand_total';
const KEY_SUBTOTAL = 'subtotal';
const KEY_BASE_SUBTOTAL = 'base_subtotal';
const KEY_DISCOUNT_AMOUNT = 'discount_amount';
const KEY_BASE_DISCOUNT_AMOUNT = 'base_discount_amount';
const KEY_SUBTOTAL_WITH_DISCOUNT = 'subtotal_with_discount';
const KEY_BASE_SUBTOTAL_WITH_DISCOUNT = 'base_subtotal_with_discount';
const KEY_SHIPPING_AMOUNT = 'shipping_amount';
const KEY_BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
const KEY_SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount';
const KEY_BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount';
const KEY_TAX_AMOUNT = 'tax_amount';
const KEY_BASE_TAX_AMOUNT = 'base_tax_amount';
const KEY_WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount';
const KEY_SHIPPING_TAX_AMOUNT = 'shipping_tax_amount';
const KEY_BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount';
const KEY_SUBTOTAL_INCL_TAX = 'subtotal_incl_tax';
const KEY_BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax';
const KEY_SHIPPING_INCL_TAX = 'shipping_incl_tax';
const KEY_BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
const KEY_BASE_CURRENCY_CODE = 'base_currency_code';
const KEY_QUOTE_CURRENCY_CODE = 'quote_currency_code';
const KEY_COUPON_CODE = 'coupon_code';
const KEY_ITEMS = 'items';
const KEY_TOTAL_SEGMENTS = 'total_segments';
const KEY_ITEMS_QTY = 'items_qty';
/**#@-*/
/**
* Get grand total in quote currency
*
* @return float|null
*/
public function getGrandTotal();
/**
* Set grand total in quote currency
*
* @param float $grandTotal
* @return $this
*/
public function setGrandTotal($grandTotal);
/**
* Get grand total in base currency
*
* @return float|null
*/
public function getBaseGrandTotal();
/**
* Set grand total in base currency
*
* @param float $baseGrandTotal
* @return $this
*/
public function setBaseGrandTotal($baseGrandTotal);
/**
* Get subtotal in quote currency
*
* @return float|null
*/
public function getSubtotal();
/**
* Set subtotal in quote currency
*
* @param float $subtotal
* @return $this
*/
public function setSubtotal($subtotal);
/**
* Get subtotal in base currency
*
* @return float|null
*/
public function getBaseSubtotal();
/**
* Set subtotal in base currency
*
* @param float $baseSubtotal
* @return $this
*/
public function setBaseSubtotal($baseSubtotal);
/**
* Get discount amount in quote currency
*
* @return float|null
*/
public function getDiscountAmount();
/**
* Set discount amount in quote currency
*
* @param float $discountAmount
* @return $this
*/
public function setDiscountAmount($discountAmount);
/**
* Get discount amount in base currency
*
* @return float|null
*/
public function getBaseDiscountAmount();
/**
* Set discount amount in base currency
*
* @param float $baseDiscountAmount
* @return $this
*/
public function setBaseDiscountAmount($baseDiscountAmount);
/**
* Get subtotal in quote currency with applied discount
*
* @return float|null
*/
public function getSubtotalWithDiscount();
/**
* Set subtotal in quote currency with applied discount
*
* @param float $subtotalWithDiscount
* @return $this
*/
public function setSubtotalWithDiscount($subtotalWithDiscount);
/**
* Get subtotal in base currency with applied discount
*
* @return float|null
*/
public function getBaseSubtotalWithDiscount();
/**
* Set subtotal in base currency with applied discount
*
* @param float $baseSubtotalWithDiscount
* @return $this
*/
public function setBaseSubtotalWithDiscount($baseSubtotalWithDiscount);
/**
* Get shipping amount in quote currency
*
* @return float|null
*/
public function getShippingAmount();
/**
* Set shipping amount in quote currency
*
* @param float $shippingAmount
* @return $this
*/
public function setShippingAmount($shippingAmount);
/**
* Get shipping amount in base currency
*
* @return float|null
*/
public function getBaseShippingAmount();
/**
* Set shipping amount in base currency
*
* @param float $baseShippingAmount
* @return $this
*/
public function setBaseShippingAmount($baseShippingAmount);
/**
* Get shipping discount amount in quote currency
*
* @return float|null
*/
public function getShippingDiscountAmount();
/**
* Set shipping discount amount in quote currency
*
* @param float $shippingDiscountAmount
* @return $this
*/
public function setShippingDiscountAmount($shippingDiscountAmount);
/**
* Get shipping discount amount in base currency
*
* @return float|null
*/
public function getBaseShippingDiscountAmount();
/**
* Set shipping discount amount in base currency
*
* @param float $baseShippingDiscountAmount
* @return $this
*/
public function setBaseShippingDiscountAmount($baseShippingDiscountAmount);
/**
* Get tax amount in quote currency
*
* @return float|null
*/
public function getTaxAmount();
/**
* Set tax amount in quote currency
*
* @param float $taxAmount
* @return $this
*/
public function setTaxAmount($taxAmount);
/**
* Get tax amount in base currency
*
* @return float|null
*/
public function getBaseTaxAmount();
/**
* Set tax amount in base currency
*
* @param float $baseTaxAmount
* @return $this
*/
public function setBaseTaxAmount($baseTaxAmount);
/**
* Returns the total weee tax applied amount in quote currency.
*
* @return float Item weee tax applied amount in quote currency.
*/
public function getWeeeTaxAppliedAmount();
/**
* Sets the total weee tax applied amount in quote currency.
*
* @param float $weeeTaxAppliedAmount
* @return $this
*/
public function setWeeeTaxAppliedAmount($weeeTaxAppliedAmount);
/**
* Get shipping tax amount in quote currency
*
* @return float|null
*/
public function getShippingTaxAmount();
/**
* Set shipping tax amount in quote currency
*
* @param float $shippingTaxAmount
* @return $this
*/
public function setShippingTaxAmount($shippingTaxAmount);
/**
* Get shipping tax amount in base currency
*
* @return float|null
*/
public function getBaseShippingTaxAmount();
/**
* Set shipping tax amount in base currency
*
* @param float $baseShippingTaxAmount
* @return $this
*/
public function setBaseShippingTaxAmount($baseShippingTaxAmount);
/**
* Get subtotal including tax in quote currency
*
* @return float|null
*/
public function getSubtotalInclTax();
/**
* Set subtotal including tax in quote currency
*
* @param float $subtotalInclTax
* @return $this
*/
public function setSubtotalInclTax($subtotalInclTax);
/**
* Get subtotal including tax in base currency
*
* @return float|null
*/
public function getBaseSubtotalInclTax();
/**
* Set subtotal including tax in base currency
*
* @param float $baseSubtotalInclTax
* @return $this
*/
public function setBaseSubtotalInclTax($baseSubtotalInclTax);
/**
* Get shipping including tax in quote currency
*
* @return float|null
*/
public function getShippingInclTax();
/**
* Set shipping including tax in quote currency
*
* @param float $shippingInclTax
* @return $this
*/
public function setShippingInclTax($shippingInclTax);
/**
* Get shipping including tax in base currency
*
* @return float|null
*/
public function getBaseShippingInclTax();
/**
* Set shipping including tax in base currency
*
* @param float $baseShippingInclTax
* @return $this
*/
public function setBaseShippingInclTax($baseShippingInclTax);
/**
* Get base currency code
*
* @return string|null
*/
public function getBaseCurrencyCode();
/**
* Set base currency code
*
* @param string $baseCurrencyCode
* @return $this
*/
public function setBaseCurrencyCode($baseCurrencyCode);
/**
* Get quote currency code
*
* @return string|null
*/
public function getQuoteCurrencyCode();
/**
* Set quote currency code
*
* @param string $quoteCurrencyCode
* @return $this
*/
public function setQuoteCurrencyCode($quoteCurrencyCode);
/**
* Get applied coupon code
*
* @return string|null
*/
public function getCouponCode();
/**
* Set applied coupon code
*
* @param string $couponCode
* @return $this
*/
public function setCouponCode($couponCode);
/**
* Get items qty
*
* @return int||null
*/
public function getItemsQty();
/**
* Set items qty
*
* @param int $itemsQty
* @return $this
*/
public function setItemsQty($itemsQty = null);
/**
* Get totals by items
*
* @return \Magento\Quote\Api\Data\TotalsItemInterface[]|null
*/
public function getItems();
/**
* Set totals by items
*
* @param \Magento\Quote\Api\Data\TotalsItemInterface[] $items
* @return $this
*/
public function setItems(array $items = null);
/**
* Get dynamically calculated totals
*
* @return \Magento\Quote\Api\Data\TotalSegmentInterface[]
*/
public function getTotalSegments();
/**
* Set dynamically calculated totals
*
* @param \Magento\Quote\Api\Data\TotalSegmentInterface[] $totals
* @return $this
*/
public function setTotalSegments($totals = []);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\Quote\Api\Data\TotalsExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\Quote\Api\Data\TotalsExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(\Magento\Quote\Api\Data\TotalsExtensionInterface $extensionAttributes);
}