-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
OrderInterface.php
2638 lines (2361 loc) · 62.7 KB
/
OrderInterface.php
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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Api\Data;
/**
* Order interface.
*
* An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product
* items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as
* a purchase order, is emailed to the customer.
* @api
*/
interface OrderInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case.
*/
/*
* Entity ID.
*/
const ENTITY_ID = 'entity_id';
/*
* State.
*/
const STATE = 'state';
/*
* Status.
*/
const STATUS = 'status';
/*
* Coupon code.
*/
const COUPON_CODE = 'coupon_code';
/*
* Protect code.
*/
const PROTECT_CODE = 'protect_code';
/*
* Shipping description.
*/
const SHIPPING_DESCRIPTION = 'shipping_description';
/*
* Is-virtual flag.
*/
const IS_VIRTUAL = 'is_virtual';
/*
* Store ID.
*/
const STORE_ID = 'store_id';
/*
* Customer ID.
*/
const CUSTOMER_ID = 'customer_id';
/*
* Base discount amount.
*/
const BASE_DISCOUNT_AMOUNT = 'base_discount_amount';
/*
* Base discount canceled.
*/
const BASE_DISCOUNT_CANCELED = 'base_discount_canceled';
/*
* Base discount invoiced.
*/
const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced';
/*
* Base discount refunded.
*/
const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded';
/*
* Base grand total.
*/
const BASE_GRAND_TOTAL = 'base_grand_total';
/*
* 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';
/*
* Base subtotal.
*/
const BASE_SUBTOTAL = 'base_subtotal';
/*
* Base subtotal canceled.
*/
const BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled';
/*
* Base subtotal invoiced.
*/
const BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced';
/*
* Base subtotal refunded.
*/
const BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded';
/*
* Base tax amount.
*/
const BASE_TAX_AMOUNT = 'base_tax_amount';
/*
* Base tax canceled.
*/
const BASE_TAX_CANCELED = 'base_tax_canceled';
/*
* Base tax invoiced.
*/
const BASE_TAX_INVOICED = 'base_tax_invoiced';
/*
* Base tax refunded.
*/
const BASE_TAX_REFUNDED = 'base_tax_refunded';
/*
* Base-to-global rate.
*/
const BASE_TO_GLOBAL_RATE = 'base_to_global_rate';
/*
* Base-to-order rate.
*/
const BASE_TO_ORDER_RATE = 'base_to_order_rate';
/*
* Base total canceled.
*/
const BASE_TOTAL_CANCELED = 'base_total_canceled';
/*
* Base total invoiced.
*/
const BASE_TOTAL_INVOICED = 'base_total_invoiced';
/*
* Base total invoiced cost.
*/
const BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost';
/*
* Base total offline refunded.
*/
const BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded';
/*
* Base total online refunded.
*/
const BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded';
/*
* Base total paid.
*/
const BASE_TOTAL_PAID = 'base_total_paid';
/*
* Base total quantity ordered.
*/
const BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered';
/*
* Base total refunded.
*/
const BASE_TOTAL_REFUNDED = 'base_total_refunded';
/*
* Discount amount.
*/
const DISCOUNT_AMOUNT = 'discount_amount';
/*
* Discount canceled.
*/
const DISCOUNT_CANCELED = 'discount_canceled';
/*
* Discount invoiced.
*/
const DISCOUNT_INVOICED = 'discount_invoiced';
/*
* Discount refunded.
*/
const DISCOUNT_REFUNDED = 'discount_refunded';
/*
* Grand total.
*/
const GRAND_TOTAL = 'grand_total';
/*
* 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';
/*
* Store-to-base rate.
*/
const STORE_TO_BASE_RATE = 'store_to_base_rate';
/*
* Store-to-order rate.
*/
const STORE_TO_ORDER_RATE = 'store_to_order_rate';
/*
* Subtotal.
*/
const SUBTOTAL = 'subtotal';
/*
* Subtotal canceled.
*/
const SUBTOTAL_CANCELED = 'subtotal_canceled';
/*
* Subtotal invoiced.
*/
const SUBTOTAL_INVOICED = 'subtotal_invoiced';
/*
* Subtotal refunded.
*/
const SUBTOTAL_REFUNDED = 'subtotal_refunded';
/*
* Tax amount.
*/
const TAX_AMOUNT = 'tax_amount';
/*
* Tax canceled.
*/
const TAX_CANCELED = 'tax_canceled';
/*
* Tax invoiced.
*/
const TAX_INVOICED = 'tax_invoiced';
/*
* Tax refunded.
*/
const TAX_REFUNDED = 'tax_refunded';
/*
* Total canceled.
*/
const TOTAL_CANCELED = 'total_canceled';
/*
* Total invoiced.
*/
const TOTAL_INVOICED = 'total_invoiced';
/*
* Total refunded offline.
*/
const TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded';
/*
* Total refunded online.
*/
const TOTAL_ONLINE_REFUNDED = 'total_online_refunded';
/*
* Total paid.
*/
const TOTAL_PAID = 'total_paid';
/*
* Total quantity ordered.
*/
const TOTAL_QTY_ORDERED = 'total_qty_ordered';
/*
* Total refunded.
*/
const TOTAL_REFUNDED = 'total_refunded';
/*
* Can-ship-partially flag.
*/
const CAN_SHIP_PARTIALLY = 'can_ship_partially';
/*
* Can-ship-item-partially flag.
*/
const CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item';
/*
* Customer-is-guest flag.
*/
const CUSTOMER_IS_GUEST = 'customer_is_guest';
/*
* Customer-note-notify flag.
*/
const CUSTOMER_NOTE_NOTIFY = 'customer_note_notify';
/*
* Billing address ID.
*/
const BILLING_ADDRESS_ID = 'billing_address_id';
/*
* Customer group ID.
*/
const CUSTOMER_GROUP_ID = 'customer_group_id';
/*
* Edit increment value.
*/
const EDIT_INCREMENT = 'edit_increment';
/*
* Email-sent flag.
*/
const EMAIL_SENT = 'email_sent';
/*
* Forced-shipment-with-invoice flag.
*/
const FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice';
/*
* Payment authorization expiration date.
*/
const PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration';
/*
* Quote address ID.
*/
const QUOTE_ADDRESS_ID = 'quote_address_id';
/*
* Quote ID.
*/
const QUOTE_ID = 'quote_id';
/*
* Negative adjustment.
*/
const ADJUSTMENT_NEGATIVE = 'adjustment_negative';
/*
* Positive adjustment.
*/
const ADJUSTMENT_POSITIVE = 'adjustment_positive';
/*
* Base negative adjustment.
*/
const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative';
/*
* Base positive adjustment.
*/
const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive';
/*
* Base shipping discount amount.
*/
const BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount';
/*
* Base subtotal including tax.
*/
const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax';
/*
* Base total due.
*/
const BASE_TOTAL_DUE = 'base_total_due';
/*
* Payment authorization amount.
*/
const PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount';
/*
* Shipping discount amount.
*/
const SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount';
/*
* Subtotal including tax.
*/
const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax';
/*
* Total due.
*/
const TOTAL_DUE = 'total_due';
/*
* Weight.
*/
const WEIGHT = 'weight';
/*
* Customer date-of-birth (DOB).
*/
const CUSTOMER_DOB = 'customer_dob';
/*
* Increment ID.
*/
const INCREMENT_ID = 'increment_id';
/*
* Applied rule IDs.
*/
const APPLIED_RULE_IDS = 'applied_rule_ids';
/*
* Base currency code.
*/
const BASE_CURRENCY_CODE = 'base_currency_code';
/*
* Customer email address.
*/
const CUSTOMER_EMAIL = 'customer_email';
/*
* Customer first name.
*/
const CUSTOMER_FIRSTNAME = 'customer_firstname';
/*
* Customer last name.
*/
const CUSTOMER_LASTNAME = 'customer_lastname';
/*
* Customer middle name.
*/
const CUSTOMER_MIDDLENAME = 'customer_middlename';
/*
* Customer prefix.
*/
const CUSTOMER_PREFIX = 'customer_prefix';
/*
* Customer suffix.
*/
const CUSTOMER_SUFFIX = 'customer_suffix';
/*
* Customer value-added tax (VAT).
*/
const CUSTOMER_TAXVAT = 'customer_taxvat';
/*
* Discount description.
*/
const DISCOUNT_DESCRIPTION = 'discount_description';
/*
* External customer ID.
*/
const EXT_CUSTOMER_ID = 'ext_customer_id';
/*
* External order ID.
*/
const EXT_ORDER_ID = 'ext_order_id';
/*
* Global currency code.
*/
const GLOBAL_CURRENCY_CODE = 'global_currency_code';
/*
* Hold before state.
*/
const HOLD_BEFORE_STATE = 'hold_before_state';
/*
* Hold before status.
*/
const HOLD_BEFORE_STATUS = 'hold_before_status';
/*
* Order currency code.
*/
const ORDER_CURRENCY_CODE = 'order_currency_code';
/*
* Original increment ID.
*/
const ORIGINAL_INCREMENT_ID = 'original_increment_id';
/*
* Relation child ID.
*/
const RELATION_CHILD_ID = 'relation_child_id';
/*
* Relation child real ID.
*/
const RELATION_CHILD_REAL_ID = 'relation_child_real_id';
/*
* Relation parent ID.
*/
const RELATION_PARENT_ID = 'relation_parent_id';
/*
* Relation parent real ID.
*/
const RELATION_PARENT_REAL_ID = 'relation_parent_real_id';
/*
* Remote IP address.
*/
const REMOTE_IP = 'remote_ip';
/*
* Store currency code.
*/
const STORE_CURRENCY_CODE = 'store_currency_code';
/*
* Store name.
*/
const STORE_NAME = 'store_name';
/*
* X-Forwarded-For HTTP header field.
*/
const X_FORWARDED_FOR = 'x_forwarded_for';
/*
* Customer note.
*/
const CUSTOMER_NOTE = 'customer_note';
/*
* Created-at timestamp.
*/
const CREATED_AT = 'created_at';
/*
* Updated-at timestamp.
*/
const UPDATED_AT = 'updated_at';
/*
* Total item count.
*/
const TOTAL_ITEM_COUNT = 'total_item_count';
/*
* Customer gender.
*/
const CUSTOMER_GENDER = 'customer_gender';
/*
* Discount tax compensation amount.
*/
const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount';
/*
* Base discount tax compensation amount.
*/
const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
/*
* 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';
/*
* Discount tax compensation invoiced.
*/
const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced';
/*
* Base discount tax compensation invoiced.
*/
const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced';
/*
* Discount tax compensation refunded.
*/
const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded';
/*
* Base discount tax compensation refunded.
*/
const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded';
/*
* Shipping including tax.
*/
const SHIPPING_INCL_TAX = 'shipping_incl_tax';
/*
* Base shipping including tax.
*/
const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
/*
* Items.
*/
const ITEMS = 'items';
/*
* Billing address.
*/
const BILLING_ADDRESS = 'billing_address';
/*
* Payment.
*/
const PAYMENT = 'payment';
/*
* Status histories.
*/
const STATUS_HISTORIES = 'status_histories';
/**
* Gets the negative adjustment value for the order.
*
* @return float|null Negative adjustment value.
*/
public function getAdjustmentNegative();
/**
* Gets the positive adjustment value for the order.
*
* @return float|null Positive adjustment value.
*/
public function getAdjustmentPositive();
/**
* Gets the applied rule IDs for the order.
*
* @return string|null Applied rule IDs.
*/
public function getAppliedRuleIds();
/**
* Gets the base negative adjustment value for the order.
*
* @return float|null Base negative adjustment value.
*/
public function getBaseAdjustmentNegative();
/**
* Gets the base positive adjustment value for the order.
*
* @return float|null Base positive adjustment value.
*/
public function getBaseAdjustmentPositive();
/**
* Gets the base currency code for the order.
*
* @return string|null Base currency code.
*/
public function getBaseCurrencyCode();
/**
* Gets the base discount amount for the order.
*
* @return float|null Base discount amount.
*/
public function getBaseDiscountAmount();
/**
* Gets the base discount canceled for the order.
*
* @return float|null Base discount canceled.
*/
public function getBaseDiscountCanceled();
/**
* Gets the base discount invoiced amount for the order.
*
* @return float|null Base discount invoiced.
*/
public function getBaseDiscountInvoiced();
/**
* Gets the base discount refunded amount for the order.
*
* @return float|null Base discount refunded.
*/
public function getBaseDiscountRefunded();
/**
* Gets the base grand total for the order.
*
* @return float Base grand total.
*/
public function getBaseGrandTotal();
/**
* Gets the base discount tax compensation amount for the order.
*
* @return float|null Base discount tax compensation amount.
*/
public function getBaseDiscountTaxCompensationAmount();
/**
* Gets the base discount tax compensation invoiced amount for the order.
*
* @return float|null Base discount tax compensation invoiced.
*/
public function getBaseDiscountTaxCompensationInvoiced();
/**
* Gets the base discount tax compensation refunded amount for the order.
*
* @return float|null Base discount tax compensation refunded.
*/
public function getBaseDiscountTaxCompensationRefunded();
/**
* Gets the base shipping amount for the order.
*
* @return float|null Base shipping amount.
*/
public function getBaseShippingAmount();
/**
* Gets the base shipping canceled for the order.
*
* @return float|null Base shipping canceled.
*/
public function getBaseShippingCanceled();
/**
* Gets the base shipping discount amount for the order.
*
* @return float|null Base shipping discount amount.
*/
public function getBaseShippingDiscountAmount();
/**
* Gets the base shipping discount tax compensation amount for the order.
*
* @return float|null Base shipping discount tax compensation amount.
*/
public function getBaseShippingDiscountTaxCompensationAmnt();
/**
* Gets the base shipping including tax for the order.
*
* @return float|null Base shipping including tax.
*/
public function getBaseShippingInclTax();
/**
* Gets the base shipping invoiced amount for the order.
*
* @return float|null Base shipping invoiced.
*/
public function getBaseShippingInvoiced();
/**
* Gets the base shipping refunded amount for the order.
*
* @return float|null Base shipping refunded.
*/
public function getBaseShippingRefunded();
/**
* Gets the base shipping tax amount for the order.
*
* @return float|null Base shipping tax amount.
*/
public function getBaseShippingTaxAmount();
/**
* Gets the base shipping tax refunded amount for the order.
*
* @return float|null Base shipping tax refunded.
*/
public function getBaseShippingTaxRefunded();
/**
* Gets the base subtotal for the order.
*
* @return float|null Base subtotal.
*/
public function getBaseSubtotal();
/**
* Gets the base subtotal canceled for the order.
*
* @return float|null Base subtotal canceled.
*/
public function getBaseSubtotalCanceled();
/**
* Gets the base subtotal including tax for the order.
*
* @return float|null Base subtotal including tax.
*/
public function getBaseSubtotalInclTax();
/**
* Gets the base subtotal invoiced amount for the order.
*
* @return float|null Base subtotal invoiced.
*/
public function getBaseSubtotalInvoiced();
/**
* Gets the base subtotal refunded amount for the order.
*
* @return float|null Base subtotal refunded.
*/
public function getBaseSubtotalRefunded();
/**
* Gets the base tax amount for the order.
*
* @return float|null Base tax amount.
*/
public function getBaseTaxAmount();
/**
* Gets the base tax canceled for the order.
*
* @return float|null Base tax canceled.
*/
public function getBaseTaxCanceled();
/**
* Gets the base tax invoiced amount for the order.
*
* @return float|null Base tax invoiced.
*/
public function getBaseTaxInvoiced();
/**
* Gets the base tax refunded amount for the order.
*
* @return float|null Base tax refunded.
*/
public function getBaseTaxRefunded();
/**
* Gets the base total canceled for the order.
*
* @return float|null Base total canceled.
*/
public function getBaseTotalCanceled();
/**
* Gets the base total due for the order.
*
* @return float|null Base total due.
*/
public function getBaseTotalDue();
/**
* Gets the base total invoiced amount for the order.
*
* @return float|null Base total invoiced.
*/
public function getBaseTotalInvoiced();
/**
* Gets the base total invoiced cost for the order.
*
* @return float|null Base total invoiced cost.
*/
public function getBaseTotalInvoicedCost();
/**
* Gets the base total offline refunded amount for the order.
*
* @return float|null Base total offline refunded.
*/
public function getBaseTotalOfflineRefunded();
/**
* Gets the base total online refunded amount for the order.
*
* @return float|null Base total online refunded.
*/
public function getBaseTotalOnlineRefunded();
/**
* Gets the base total paid for the order.
*
* @return float|null Base total paid.
*/
public function getBaseTotalPaid();
/**
* Gets the base total quantity ordered for the order.
*
* @return float|null Base total quantity ordered.
*/
public function getBaseTotalQtyOrdered();
/**
* Gets the base total refunded amount for the order.
*
* @return float|null Base total refunded.
*/
public function getBaseTotalRefunded();
/**
* Gets the base-to-global rate for the order.
*
* @return float|null Base-to-global rate.
*/
public function getBaseToGlobalRate();
/**
* Gets the base-to-order rate for the order.
*
* @return float|null Base-to-order rate.
*/
public function getBaseToOrderRate();
/**
* Gets the billing address ID for the order.
*
* @return int|null Billing address ID.
*/
public function getBillingAddressId();
/**
* Gets the can-ship-partially flag value for the order.
*
* @return int|null Can-ship-partially flag value.
*/
public function getCanShipPartially();
/**
* Gets the can-ship-partially-item flag value for the order.
*
* @return int|null Can-ship-partially-item flag value.
*/
public function getCanShipPartiallyItem();
/**
* Gets the coupon code for the order.
*
* @return string|null Coupon code.
*/
public function getCouponCode();
/**
* Gets the created-at timestamp for the order.
*
* @return string|null Created-at timestamp.
*/
public function getCreatedAt();
/**
* Sets the created-at timestamp for the order.
*
* @param string $createdAt timestamp
* @return $this
*/
public function setCreatedAt($createdAt);
/**
* Gets the customer date-of-birth (DOB) for the order.
*
* @return string|null Customer date-of-birth (DOB).
*/
public function getCustomerDob();
/**
* Gets the customer email address for the order.
*
* @return string Customer email address.
*/
public function getCustomerEmail();
/**
* Gets the customer first name for the order.
*
* @return string|null Customer first name.
*/
public function getCustomerFirstname();
/**
* Gets the customer gender for the order.
*
* @return int|null Customer gender.
*/
public function getCustomerGender();
/**
* Gets the customer group ID for the order.
*
* @return int|null Customer group ID.
*/
public function getCustomerGroupId();
/**
* Gets the customer ID for the order.
*
* @return int|null Customer ID.
*/
public function getCustomerId();
/**
* Gets the customer-is-guest flag value for the order.
*
* @return int|null Customer-is-guest flag value.
*/
public function getCustomerIsGuest();
/**
* Gets the customer last name for the order.
*
* @return string|null Customer last name.
*/
public function getCustomerLastname();
/**
* Gets the customer middle name for the order.
*
* @return string|null Customer middle name.
*/
public function getCustomerMiddlename();
/**
* Gets the customer note for the order.
*
* @return string|null Customer note.
*/
public function getCustomerNote();
/**
* Gets the customer-note-notify flag value for the order.
*
* @return int|null Customer-note-notify flag value.
*/
public function getCustomerNoteNotify();
/**
* Gets the customer prefix for the order.
*
* @return string|null Customer prefix.
*/
public function getCustomerPrefix();
/**
* Gets the customer suffix for the order.
*
* @return string|null Customer suffix.
*/
public function getCustomerSuffix();