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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Api\Data;
use Magento\Framework\Api\ExtensibleDataInterface;
/**
* Interface TotalInterface
* @api
* @since 100.0.4
*/
interface TotalInterface extends ExtensibleDataInterface
{
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case.
*/
/*
* Base shipping amount.
*/
const BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
/*
* Base shipping canceled.
*/
const BASE_SHIPPING_CANCELED = 'base_shipping_canceled';
/*
* Base shipping invoiced.
*/
const BASE_SHIPPING_INVOICED = 'base_shipping_invoiced';
/*
* Base shipping refunded.
*/
const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded';
/*
* Base shipping tax amount.
*/
const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount';
/*
* Base shipping tax refunded.
*/
const BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded';
/*
* Shipping amount.
*/
const SHIPPING_AMOUNT = 'shipping_amount';
/*
* Shipping canceled.
*/
const SHIPPING_CANCELED = 'shipping_canceled';
/*
* Shipping invoiced.
*/
const SHIPPING_INVOICED = 'shipping_invoiced';
/*
* Shipping refunded.
*/
const SHIPPING_REFUNDED = 'shipping_refunded';
/*
* Shipping tax amount.
*/
const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount';
/*
* Shipping tax refunded.
*/
const SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded';
/*
* Base shipping discount amount.
*/
const BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount';
/*
* Shipping discount amount.
*/
const SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount';
/*
* Shipping discount tax compensation amount.
*/
const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount';
/*
* Base shipping discount tax compensation amount.
*/
const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt';
/*
* Shipping including tax.
*/
const SHIPPING_INCL_TAX = 'shipping_incl_tax';
/*
* Base shipping including tax.
*/
const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
/**#@-*/
/**
* Gets the base shipping amount.
*
* @return float|null Base shipping amount.
* @since 100.0.4
*/
public function getBaseShippingAmount();
/**
* Gets the base shipping canceled.
*
* @return float|null Base shipping canceled.
* @since 100.0.4
*/
public function getBaseShippingCanceled();
/**
* Gets the base shipping discount amount.
*
* @return float|null Base shipping discount amount.
* @since 100.0.4
*/
public function getBaseShippingDiscountAmount();
/**
* Gets the base shipping discount tax compensation amount.
*
* @return float|null Base shipping discount tax compensation amount.
* @since 100.0.4
*/
public function getBaseShippingDiscountTaxCompensationAmnt();
/**
* Gets the base shipping including tax.
*
* @return float|null Base shipping including tax.
* @since 100.0.4
*/
public function getBaseShippingInclTax();
/**
* Gets the base shipping invoiced amount.
*
* @return float|null Base shipping invoiced.
* @since 100.0.4
*/
public function getBaseShippingInvoiced();
/**
* Gets the base shipping refunded amount.
*
* @return float|null Base shipping refunded.
* @since 100.0.4
*/
public function getBaseShippingRefunded();
/**
* Gets the base shipping tax amount.
*
* @return float|null Base shipping tax amount.
* @since 100.0.4
*/
public function getBaseShippingTaxAmount();
/**
* Gets the base shipping tax refunded amount.
*
* @return float|null Base shipping tax refunded.
* @since 100.0.4
*/
public function getBaseShippingTaxRefunded();
/**
* Gets the shipping amount.
*
* @return float|null Shipping amount.
* @since 100.0.4
*/
public function getShippingAmount();
/**
* Gets the shipping canceled amount.
*
* @return float|null Shipping canceled amount.
* @since 100.0.4
*/
public function getShippingCanceled();
/**
* Gets the shipping discount amount.
*
* @return float|null Shipping discount amount.
* @since 100.0.4
*/
public function getShippingDiscountAmount();
/**
* Gets the shipping discount tax compensation amount.
*
* @return float|null Shipping discount tax compensation amount.
* @since 100.0.4
*/
public function getShippingDiscountTaxCompensationAmount();
/**
* Gets the shipping including tax amount.
*
* @return float|null Shipping including tax amount.
* @since 100.0.4
*/
public function getShippingInclTax();
/**
* Gets the shipping invoiced amount.
*
* @return float|null Shipping invoiced amount.
* @since 100.0.4
*/
public function getShippingInvoiced();
/**
* Gets the shipping refunded amount.
*
* @return float|null Shipping refunded amount.
* @since 100.0.4
*/
public function getShippingRefunded();
/**
* Gets the shipping tax amount.
*
* @return float|null Shipping tax amount.
* @since 100.0.4
*/
public function getShippingTaxAmount();
/**
* Gets the shipping tax refunded amount.
*
* @return float|null Shipping tax refunded amount.
* @since 100.0.4
*/
public function getShippingTaxRefunded();
/**
* Sets the base shipping amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setBaseShippingAmount($amount);
/**
* Sets the base shipping canceled.
*
* @param float $baseShippingCanceled
* @return $this
* @since 100.0.4
*/
public function setBaseShippingCanceled($baseShippingCanceled);
/**
* Sets the base shipping discount amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setBaseShippingDiscountAmount($amount);
/**
* Sets the base shipping discount tax compensation amount.
*
* @param float $amnt
* @return $this
* @since 100.0.4
*/
public function setBaseShippingDiscountTaxCompensationAmnt($amnt);
/**
* Sets the base shipping including tax.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setBaseShippingInclTax($amount);
/**
* Sets the base shipping invoiced amount.
*
* @param float $baseShippingInvoiced
* @return $this
* @since 100.0.4
*/
public function setBaseShippingInvoiced($baseShippingInvoiced);
/**
* Sets the base shipping refunded amount.
*
* @param float $baseShippingRefunded
* @return $this
* @since 100.0.4
*/
public function setBaseShippingRefunded($baseShippingRefunded);
/**
* Sets the base shipping tax amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setBaseShippingTaxAmount($amount);
/**
* Sets the base shipping tax refunded amount.
*
* @param float $baseShippingTaxRefunded
* @return $this
* @since 100.0.4
*/
public function setBaseShippingTaxRefunded($baseShippingTaxRefunded);
/**
* Sets the shipping amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setShippingAmount($amount);
/**
* Sets the shipping canceled amount.
*
* @param float $shippingCanceled
* @return $this
* @since 100.0.4
*/
public function setShippingCanceled($shippingCanceled);
/**
* Sets the shipping discount amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setShippingDiscountAmount($amount);
/**
* Sets the shipping discount tax compensation amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setShippingDiscountTaxCompensationAmount($amount);
/**
* Sets the shipping including tax amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setShippingInclTax($amount);
/**
* Sets the shipping invoiced amount.
*
* @param float $shippingInvoiced
* @return $this
* @since 100.0.4
*/
public function setShippingInvoiced($shippingInvoiced);
/**
* Sets the shipping refunded amount.
*
* @param float $shippingRefunded
* @return $this
* @since 100.0.4
*/
public function setShippingRefunded($shippingRefunded);
/**
* Sets the shipping tax amount.
*
* @param float $amount
* @return $this
* @since 100.0.4
*/
public function setShippingTaxAmount($amount);
/**
* Sets the shipping tax refunded amount.
*
* @param float $shippingTaxRefunded
* @return $this
* @since 100.0.4
*/
public function setShippingTaxRefunded($shippingTaxRefunded);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\Sales\Api\Data\TotalExtensionInterface|null
* @since 100.0.4
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\Sales\Api\Data\TotalExtensionInterface $extensionAttributes
* @return $this
* @since 100.0.4
*/
public function setExtensionAttributes(
\Magento\Sales\Api\Data\TotalExtensionInterface $extensionAttributes
);
}