@final-commerce/common 2.8.0 → 2.8.1-preprod.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +165 -2
- package/dist/index.d.ts +165 -2
- package/dist/index.js +429 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +405 -0
- package/dist/index.mjs.map +1 -1
- package/dist/pos-types/index.d.mts +305 -226
- package/dist/pos-types/index.d.ts +305 -226
- package/dist/pos-types/index.js +1 -0
- package/dist/pos-types/index.js.map +1 -1
- package/dist/pos-types/index.mjs +1 -0
- package/dist/pos-types/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -50,231 +50,6 @@ interface OrderTax {
|
|
|
50
50
|
priority?: number;
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
-
interface OrderTip {
|
|
54
|
-
percentage?: number;
|
|
55
|
-
amount?: number;
|
|
56
|
-
tipTo?: string;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
interface OrderSummaryPayments {
|
|
60
|
-
cardTotal: number;
|
|
61
|
-
cashTotal: number;
|
|
62
|
-
customTotal: number;
|
|
63
|
-
cardProcessingFeesTotal: number;
|
|
64
|
-
}
|
|
65
|
-
interface OrderSummary {
|
|
66
|
-
discountTotal: number;
|
|
67
|
-
shippingTotal?: number;
|
|
68
|
-
total: number;
|
|
69
|
-
totalTaxes: number;
|
|
70
|
-
isTaxInclusive: boolean;
|
|
71
|
-
subtotalAfterFees: number;
|
|
72
|
-
nonRevenueTotal?: number;
|
|
73
|
-
grossSales?: number;
|
|
74
|
-
lineDiscountTotal?: number;
|
|
75
|
-
cartDiscountTotal?: number;
|
|
76
|
-
feesTotal?: number;
|
|
77
|
-
lineFeesTotal?: number;
|
|
78
|
-
cartFeesTotal?: number;
|
|
79
|
-
taxableFeesTotal?: number;
|
|
80
|
-
nonTaxableFeesTotal?: number;
|
|
81
|
-
modifiersTotal?: number;
|
|
82
|
-
taxableModifiersTotal?: number;
|
|
83
|
-
nonTaxableModifiersTotal?: number;
|
|
84
|
-
totalTaxableSales?: number;
|
|
85
|
-
totalNonTaxableSales?: number;
|
|
86
|
-
tipTotal?: number;
|
|
87
|
-
cashRounding: number;
|
|
88
|
-
payments?: OrderSummaryPayments;
|
|
89
|
-
totalBeforeTip?: number;
|
|
90
|
-
amountPaid?: number;
|
|
91
|
-
taxes: OrderTax[];
|
|
92
|
-
tip?: OrderTip;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
interface PriceModifierDetail {
|
|
96
|
-
percentage: number;
|
|
97
|
-
amount: number;
|
|
98
|
-
label?: string;
|
|
99
|
-
tax?: number;
|
|
100
|
-
taxTableId?: string;
|
|
101
|
-
taxRateId?: string;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
interface OrderCartDiscount {
|
|
105
|
-
amount: number;
|
|
106
|
-
percentage: number;
|
|
107
|
-
label?: string;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
interface OrderCartFee {
|
|
111
|
-
label: string;
|
|
112
|
-
id: string;
|
|
113
|
-
percentage: number;
|
|
114
|
-
amount: number;
|
|
115
|
-
taxName?: string;
|
|
116
|
-
taxTableId?: string;
|
|
117
|
-
tax?: number;
|
|
118
|
-
taxes?: OrderTax[];
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
interface OrderPaymentMethod {
|
|
122
|
-
paymentType: string;
|
|
123
|
-
amount: number;
|
|
124
|
-
transactionId: string;
|
|
125
|
-
timestamp?: string;
|
|
126
|
-
emv?: string | null;
|
|
127
|
-
cashRounding?: number;
|
|
128
|
-
change?: number;
|
|
129
|
-
processor?: string;
|
|
130
|
-
processorFee?: number;
|
|
131
|
-
tendered?: number;
|
|
132
|
-
tip?: OrderTip | null;
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
interface OrderPosData {
|
|
136
|
-
outlet?: string;
|
|
137
|
-
station?: string;
|
|
138
|
-
employee?: string;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
interface OrderAssignedUser {
|
|
142
|
-
userId: string;
|
|
143
|
-
assignedAt: string;
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
interface OrderInCart {
|
|
147
|
-
active: boolean;
|
|
148
|
-
stationId: string | null;
|
|
149
|
-
since: string;
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
interface OrderCustomStatus {
|
|
153
|
-
id: string;
|
|
154
|
-
key?: string;
|
|
155
|
-
label: string;
|
|
156
|
-
setAt: string;
|
|
157
|
-
setBy: string | null;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
interface OrderLineItemDiscount {
|
|
161
|
-
itemDiscounts?: PriceModifierDetail[];
|
|
162
|
-
cartDiscount?: PriceModifierDetail;
|
|
163
|
-
}
|
|
164
|
-
interface OrderLineItemFee {
|
|
165
|
-
cartFee?: PriceModifierDetail;
|
|
166
|
-
itemFees?: PriceModifierDetail[];
|
|
167
|
-
}
|
|
168
|
-
interface OrderLineItemModifier {
|
|
169
|
-
modifierId: string;
|
|
170
|
-
modifierName: string;
|
|
171
|
-
choiceId: string;
|
|
172
|
-
choiceName: string;
|
|
173
|
-
unitPrice: number;
|
|
174
|
-
quantity: number;
|
|
175
|
-
total: number;
|
|
176
|
-
totalTax?: number;
|
|
177
|
-
taxes?: OrderTax[];
|
|
178
|
-
componentIndex?: number;
|
|
179
|
-
}
|
|
180
|
-
interface OrderLineItemComponent {
|
|
181
|
-
productId: string;
|
|
182
|
-
variantId: string;
|
|
183
|
-
name: string;
|
|
184
|
-
attributes?: string;
|
|
185
|
-
sku?: string;
|
|
186
|
-
productExternalId?: string;
|
|
187
|
-
variantExternalId?: string;
|
|
188
|
-
partName?: string;
|
|
189
|
-
quantity: number;
|
|
190
|
-
price: number;
|
|
191
|
-
unitId?: string;
|
|
192
|
-
unitAbbreviation?: string;
|
|
193
|
-
unitRatioToBase?: number;
|
|
194
|
-
stockQuantity?: number;
|
|
195
|
-
stockVariantId?: string;
|
|
196
|
-
manageStock?: boolean;
|
|
197
|
-
taxTableId?: string;
|
|
198
|
-
totalTax?: number;
|
|
199
|
-
taxes?: OrderTax[];
|
|
200
|
-
}
|
|
201
|
-
interface OrderLineItem {
|
|
202
|
-
id?: string;
|
|
203
|
-
productId?: string;
|
|
204
|
-
variantId?: string;
|
|
205
|
-
name?: string;
|
|
206
|
-
quantity?: number;
|
|
207
|
-
manageStock?: boolean;
|
|
208
|
-
price?: number;
|
|
209
|
-
description?: string;
|
|
210
|
-
sku?: string;
|
|
211
|
-
totalTax?: number;
|
|
212
|
-
total?: number;
|
|
213
|
-
productExternalId?: string;
|
|
214
|
-
variantExternalId?: string;
|
|
215
|
-
lineItemExternalId?: string;
|
|
216
|
-
internalId?: string;
|
|
217
|
-
note?: string;
|
|
218
|
-
image?: string;
|
|
219
|
-
attributes?: string;
|
|
220
|
-
taxes?: OrderTax[];
|
|
221
|
-
discount?: OrderLineItemDiscount;
|
|
222
|
-
fee?: OrderLineItemFee;
|
|
223
|
-
modifiers?: OrderLineItemModifier[];
|
|
224
|
-
components?: OrderLineItemComponent[];
|
|
225
|
-
lineNetWithFees?: number;
|
|
226
|
-
metadata?: Metadata[];
|
|
227
|
-
stock?: number;
|
|
228
|
-
subTotal?: number;
|
|
229
|
-
unitId?: string;
|
|
230
|
-
unitAbbreviation?: string;
|
|
231
|
-
stockQuantity?: number;
|
|
232
|
-
unitRatioToBase?: number;
|
|
233
|
-
stockVariantId?: string;
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
interface OrderCustomSaleDiscount {
|
|
237
|
-
cartDiscount: OrderCartDiscount;
|
|
238
|
-
}
|
|
239
|
-
interface OrderCustomSaleFee {
|
|
240
|
-
cartFee: PriceModifierDetail;
|
|
241
|
-
}
|
|
242
|
-
interface OrderCustomSale {
|
|
243
|
-
customSaleId: string;
|
|
244
|
-
applyTaxes: boolean;
|
|
245
|
-
quantity: number;
|
|
246
|
-
name: string;
|
|
247
|
-
price: number;
|
|
248
|
-
totalTax: number;
|
|
249
|
-
total: number;
|
|
250
|
-
taxes?: OrderTax[];
|
|
251
|
-
discount?: OrderCustomSaleDiscount;
|
|
252
|
-
fee?: OrderCustomSaleFee;
|
|
253
|
-
}
|
|
254
|
-
|
|
255
|
-
interface OrderRefundSummary {
|
|
256
|
-
total?: number;
|
|
257
|
-
}
|
|
258
|
-
interface OrderRefund {
|
|
259
|
-
externalId?: string;
|
|
260
|
-
reason?: string;
|
|
261
|
-
summary?: OrderRefundSummary;
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
-
interface RefundCartDiscount {
|
|
265
|
-
amount?: number;
|
|
266
|
-
percentage?: number;
|
|
267
|
-
}
|
|
268
|
-
interface RefundItemDiscount {
|
|
269
|
-
amount?: number;
|
|
270
|
-
percentage?: number;
|
|
271
|
-
label?: string;
|
|
272
|
-
}
|
|
273
|
-
interface RefundDiscount {
|
|
274
|
-
cartDiscount?: RefundCartDiscount;
|
|
275
|
-
itemDiscounts?: RefundItemDiscount[];
|
|
276
|
-
}
|
|
277
|
-
|
|
278
53
|
declare enum CurrencyCode {
|
|
279
54
|
USD = "USD",
|
|
280
55
|
EUR = "EUR",
|
|
@@ -545,6 +320,255 @@ declare enum ReservationStatus {
|
|
|
545
320
|
EXPIRED = "expired"
|
|
546
321
|
}
|
|
547
322
|
|
|
323
|
+
declare enum ShippingOptionType {
|
|
324
|
+
SHIP = "ship",
|
|
325
|
+
PICKUP = "pickup"
|
|
326
|
+
}
|
|
327
|
+
declare enum ShippingRateType {
|
|
328
|
+
FLAT = "flat"
|
|
329
|
+
}
|
|
330
|
+
declare enum ShippingChannel {
|
|
331
|
+
WEB = "web",
|
|
332
|
+
POS = "pos"
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
interface OrderShippingLine {
|
|
336
|
+
type: ShippingOptionType | `${ShippingOptionType}`;
|
|
337
|
+
name?: string;
|
|
338
|
+
amount: number;
|
|
339
|
+
zoneId?: string;
|
|
340
|
+
optionId?: string;
|
|
341
|
+
minDays?: number;
|
|
342
|
+
maxDays?: number;
|
|
343
|
+
pickupOutletId?: string;
|
|
344
|
+
taxes?: OrderTax[];
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
interface OrderTip {
|
|
348
|
+
percentage?: number;
|
|
349
|
+
amount?: number;
|
|
350
|
+
tipTo?: string;
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
interface OrderSummaryPayments {
|
|
354
|
+
cardTotal: number;
|
|
355
|
+
cashTotal: number;
|
|
356
|
+
customTotal: number;
|
|
357
|
+
cardProcessingFeesTotal: number;
|
|
358
|
+
}
|
|
359
|
+
interface OrderSummary {
|
|
360
|
+
discountTotal: number;
|
|
361
|
+
shippingTotal?: number;
|
|
362
|
+
total: number;
|
|
363
|
+
totalTaxes: number;
|
|
364
|
+
isTaxInclusive: boolean;
|
|
365
|
+
subtotalAfterFees: number;
|
|
366
|
+
nonRevenueTotal?: number;
|
|
367
|
+
grossSales?: number;
|
|
368
|
+
lineDiscountTotal?: number;
|
|
369
|
+
cartDiscountTotal?: number;
|
|
370
|
+
feesTotal?: number;
|
|
371
|
+
lineFeesTotal?: number;
|
|
372
|
+
cartFeesTotal?: number;
|
|
373
|
+
taxableFeesTotal?: number;
|
|
374
|
+
nonTaxableFeesTotal?: number;
|
|
375
|
+
modifiersTotal?: number;
|
|
376
|
+
taxableModifiersTotal?: number;
|
|
377
|
+
nonTaxableModifiersTotal?: number;
|
|
378
|
+
totalTaxableSales?: number;
|
|
379
|
+
totalNonTaxableSales?: number;
|
|
380
|
+
tipTotal?: number;
|
|
381
|
+
cashRounding: number;
|
|
382
|
+
payments?: OrderSummaryPayments;
|
|
383
|
+
totalBeforeTip?: number;
|
|
384
|
+
amountPaid?: number;
|
|
385
|
+
taxes: OrderTax[];
|
|
386
|
+
tip?: OrderTip;
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
interface PriceModifierDetail {
|
|
390
|
+
percentage: number;
|
|
391
|
+
amount: number;
|
|
392
|
+
label?: string;
|
|
393
|
+
tax?: number;
|
|
394
|
+
taxTableId?: string;
|
|
395
|
+
taxRateId?: string;
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
interface OrderCartDiscount {
|
|
399
|
+
amount: number;
|
|
400
|
+
percentage: number;
|
|
401
|
+
label?: string;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
interface OrderCartFee {
|
|
405
|
+
label: string;
|
|
406
|
+
id: string;
|
|
407
|
+
percentage: number;
|
|
408
|
+
amount: number;
|
|
409
|
+
taxName?: string;
|
|
410
|
+
taxTableId?: string;
|
|
411
|
+
tax?: number;
|
|
412
|
+
taxes?: OrderTax[];
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
interface OrderPaymentMethod {
|
|
416
|
+
paymentType: string;
|
|
417
|
+
amount: number;
|
|
418
|
+
transactionId: string;
|
|
419
|
+
timestamp?: string;
|
|
420
|
+
emv?: string | null;
|
|
421
|
+
cashRounding?: number;
|
|
422
|
+
change?: number;
|
|
423
|
+
processor?: string;
|
|
424
|
+
processorFee?: number;
|
|
425
|
+
tendered?: number;
|
|
426
|
+
tip?: OrderTip | null;
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
interface OrderPosData {
|
|
430
|
+
outlet?: string;
|
|
431
|
+
station?: string;
|
|
432
|
+
employee?: string;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
interface OrderAssignedUser {
|
|
436
|
+
userId: string;
|
|
437
|
+
assignedAt: string;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
interface OrderInCart {
|
|
441
|
+
active: boolean;
|
|
442
|
+
stationId: string | null;
|
|
443
|
+
since: string;
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
interface OrderCustomStatus {
|
|
447
|
+
id: string;
|
|
448
|
+
key?: string;
|
|
449
|
+
label: string;
|
|
450
|
+
setAt: string;
|
|
451
|
+
setBy: string | null;
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
interface OrderLineItemDiscount {
|
|
455
|
+
itemDiscounts?: PriceModifierDetail[];
|
|
456
|
+
cartDiscount?: PriceModifierDetail;
|
|
457
|
+
}
|
|
458
|
+
interface OrderLineItemFee {
|
|
459
|
+
cartFee?: PriceModifierDetail;
|
|
460
|
+
itemFees?: PriceModifierDetail[];
|
|
461
|
+
}
|
|
462
|
+
interface OrderLineItemModifier {
|
|
463
|
+
modifierId: string;
|
|
464
|
+
modifierName: string;
|
|
465
|
+
choiceId: string;
|
|
466
|
+
choiceName: string;
|
|
467
|
+
unitPrice: number;
|
|
468
|
+
quantity: number;
|
|
469
|
+
total: number;
|
|
470
|
+
totalTax?: number;
|
|
471
|
+
taxes?: OrderTax[];
|
|
472
|
+
componentIndex?: number;
|
|
473
|
+
}
|
|
474
|
+
interface OrderLineItemComponent {
|
|
475
|
+
productId: string;
|
|
476
|
+
variantId: string;
|
|
477
|
+
name: string;
|
|
478
|
+
attributes?: string;
|
|
479
|
+
sku?: string;
|
|
480
|
+
productExternalId?: string;
|
|
481
|
+
variantExternalId?: string;
|
|
482
|
+
partName?: string;
|
|
483
|
+
quantity: number;
|
|
484
|
+
price: number;
|
|
485
|
+
unitId?: string;
|
|
486
|
+
unitAbbreviation?: string;
|
|
487
|
+
unitRatioToBase?: number;
|
|
488
|
+
stockQuantity?: number;
|
|
489
|
+
stockVariantId?: string;
|
|
490
|
+
manageStock?: boolean;
|
|
491
|
+
taxTableId?: string;
|
|
492
|
+
totalTax?: number;
|
|
493
|
+
taxes?: OrderTax[];
|
|
494
|
+
}
|
|
495
|
+
interface OrderLineItem {
|
|
496
|
+
id?: string;
|
|
497
|
+
productId?: string;
|
|
498
|
+
variantId?: string;
|
|
499
|
+
name?: string;
|
|
500
|
+
quantity?: number;
|
|
501
|
+
manageStock?: boolean;
|
|
502
|
+
price?: number;
|
|
503
|
+
description?: string;
|
|
504
|
+
sku?: string;
|
|
505
|
+
totalTax?: number;
|
|
506
|
+
total?: number;
|
|
507
|
+
productExternalId?: string;
|
|
508
|
+
variantExternalId?: string;
|
|
509
|
+
lineItemExternalId?: string;
|
|
510
|
+
internalId?: string;
|
|
511
|
+
note?: string;
|
|
512
|
+
image?: string;
|
|
513
|
+
attributes?: string;
|
|
514
|
+
taxes?: OrderTax[];
|
|
515
|
+
discount?: OrderLineItemDiscount;
|
|
516
|
+
fee?: OrderLineItemFee;
|
|
517
|
+
modifiers?: OrderLineItemModifier[];
|
|
518
|
+
components?: OrderLineItemComponent[];
|
|
519
|
+
lineNetWithFees?: number;
|
|
520
|
+
metadata?: Metadata[];
|
|
521
|
+
stock?: number;
|
|
522
|
+
subTotal?: number;
|
|
523
|
+
unitId?: string;
|
|
524
|
+
unitAbbreviation?: string;
|
|
525
|
+
stockQuantity?: number;
|
|
526
|
+
unitRatioToBase?: number;
|
|
527
|
+
stockVariantId?: string;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
interface OrderCustomSaleDiscount {
|
|
531
|
+
cartDiscount: OrderCartDiscount;
|
|
532
|
+
}
|
|
533
|
+
interface OrderCustomSaleFee {
|
|
534
|
+
cartFee: PriceModifierDetail;
|
|
535
|
+
}
|
|
536
|
+
interface OrderCustomSale {
|
|
537
|
+
customSaleId: string;
|
|
538
|
+
applyTaxes: boolean;
|
|
539
|
+
quantity: number;
|
|
540
|
+
name: string;
|
|
541
|
+
price: number;
|
|
542
|
+
totalTax: number;
|
|
543
|
+
total: number;
|
|
544
|
+
taxes?: OrderTax[];
|
|
545
|
+
discount?: OrderCustomSaleDiscount;
|
|
546
|
+
fee?: OrderCustomSaleFee;
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
interface OrderRefundSummary {
|
|
550
|
+
total?: number;
|
|
551
|
+
}
|
|
552
|
+
interface OrderRefund {
|
|
553
|
+
externalId?: string;
|
|
554
|
+
reason?: string;
|
|
555
|
+
summary?: OrderRefundSummary;
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
interface RefundCartDiscount {
|
|
559
|
+
amount?: number;
|
|
560
|
+
percentage?: number;
|
|
561
|
+
}
|
|
562
|
+
interface RefundItemDiscount {
|
|
563
|
+
amount?: number;
|
|
564
|
+
percentage?: number;
|
|
565
|
+
label?: string;
|
|
566
|
+
}
|
|
567
|
+
interface RefundDiscount {
|
|
568
|
+
cartDiscount?: RefundCartDiscount;
|
|
569
|
+
itemDiscounts?: RefundItemDiscount[];
|
|
570
|
+
}
|
|
571
|
+
|
|
548
572
|
interface RefundLineItem {
|
|
549
573
|
taxes?: OrderTax[];
|
|
550
574
|
discount?: RefundDiscount;
|
|
@@ -976,6 +1000,7 @@ interface Order extends BaseEntity {
|
|
|
976
1000
|
notes: OrderNote$1[];
|
|
977
1001
|
billing?: Address$1;
|
|
978
1002
|
shipping?: Address$1;
|
|
1003
|
+
shippingLine?: OrderShippingLine;
|
|
979
1004
|
lineItems: Partial<OrderLineItem>[];
|
|
980
1005
|
customSales?: OrderCustomSale[];
|
|
981
1006
|
nonRevenueItems?: NonRevenueItem$1[];
|
|
@@ -1889,6 +1914,12 @@ interface ActiveProduct {
|
|
|
1889
1914
|
modifierSelections?: ModifierSelection[];
|
|
1890
1915
|
modifiers?: CartLineModifier[];
|
|
1891
1916
|
components?: CartLineComponent[];
|
|
1917
|
+
compositePicks?: (CompositePick & {
|
|
1918
|
+
resourceId?: string;
|
|
1919
|
+
})[];
|
|
1920
|
+
compositeSlot?: {
|
|
1921
|
+
startAt: string;
|
|
1922
|
+
};
|
|
1892
1923
|
currency?: CurrencyCode;
|
|
1893
1924
|
minorUnits?: number;
|
|
1894
1925
|
isUnlimited?: boolean;
|
|
@@ -1907,6 +1938,48 @@ interface CartReservation extends OrderReservation {
|
|
|
1907
1938
|
fees?: CustomFee[];
|
|
1908
1939
|
}
|
|
1909
1940
|
|
|
1941
|
+
interface ShippingPriceTier {
|
|
1942
|
+
from: number;
|
|
1943
|
+
price: number;
|
|
1944
|
+
}
|
|
1945
|
+
interface ShippingOptionRule {
|
|
1946
|
+
id: string;
|
|
1947
|
+
type: ShippingOptionType | `${ShippingOptionType}`;
|
|
1948
|
+
rate?: ShippingRateType | `${ShippingRateType}`;
|
|
1949
|
+
name?: string | null;
|
|
1950
|
+
price: number;
|
|
1951
|
+
priceByTotal?: ShippingPriceTier[] | null;
|
|
1952
|
+
freeOver?: number | null;
|
|
1953
|
+
minDays?: number | null;
|
|
1954
|
+
maxDays?: number | null;
|
|
1955
|
+
channels: (ShippingChannel | `${ShippingChannel}`)[];
|
|
1956
|
+
outletId?: string | null;
|
|
1957
|
+
}
|
|
1958
|
+
|
|
1959
|
+
interface CartAddress {
|
|
1960
|
+
firstName?: string;
|
|
1961
|
+
lastName?: string;
|
|
1962
|
+
address1?: string;
|
|
1963
|
+
address2?: string;
|
|
1964
|
+
city?: string;
|
|
1965
|
+
state?: string;
|
|
1966
|
+
postCode?: string;
|
|
1967
|
+
country?: string;
|
|
1968
|
+
fromCustomer?: boolean;
|
|
1969
|
+
}
|
|
1970
|
+
interface CartShipping {
|
|
1971
|
+
zoneId: string;
|
|
1972
|
+
optionId: string;
|
|
1973
|
+
type: ShippingOptionType | `${ShippingOptionType}`;
|
|
1974
|
+
name: string | null;
|
|
1975
|
+
amount: number;
|
|
1976
|
+
taxes?: Tax[];
|
|
1977
|
+
minDays: number | null;
|
|
1978
|
+
maxDays: number | null;
|
|
1979
|
+
outletId: string | null;
|
|
1980
|
+
rule?: Pick<ShippingOptionRule, 'price' | 'priceByTotal' | 'freeOver'>;
|
|
1981
|
+
}
|
|
1982
|
+
|
|
1910
1983
|
interface ActiveCustomSales {
|
|
1911
1984
|
id: string;
|
|
1912
1985
|
name: string;
|
|
@@ -1942,6 +2015,10 @@ interface ActiveCart {
|
|
|
1942
2015
|
amountToBeCharged: number;
|
|
1943
2016
|
customer?: Partial<ActiveCustomer | null> | null;
|
|
1944
2017
|
orderNotes?: string;
|
|
2018
|
+
shippingAddress?: CartAddress | null;
|
|
2019
|
+
billingAddress?: CartAddress | null;
|
|
2020
|
+
shipping?: CartShipping | null;
|
|
2021
|
+
shippingTotal?: number;
|
|
1945
2022
|
cartTotal?: number;
|
|
1946
2023
|
orderTotal?: number;
|
|
1947
2024
|
orderId?: string;
|
|
@@ -2055,6 +2132,7 @@ declare enum ProcessorType {
|
|
|
2055
2132
|
REDEEM = "Redeem",
|
|
2056
2133
|
INTEGRATION = "Integration",
|
|
2057
2134
|
PAYMENT_LINK = "PaymentLink",
|
|
2135
|
+
ONLINE_PAYMENT = "OnlinePayment",
|
|
2058
2136
|
EXTERNAL = "External"
|
|
2059
2137
|
}
|
|
2060
2138
|
|
|
@@ -2265,6 +2343,7 @@ interface CalculatedTaxDetails {
|
|
|
2265
2343
|
};
|
|
2266
2344
|
totalTaxes: TaxesDetails;
|
|
2267
2345
|
cartFees: CartFeesDetails[];
|
|
2346
|
+
shipping?: CartFeesDetails;
|
|
2268
2347
|
}
|
|
2269
2348
|
interface TipData {
|
|
2270
2349
|
value: number;
|
|
@@ -2562,4 +2641,4 @@ interface PubsubEventMessage {
|
|
|
2562
2641
|
}
|
|
2563
2642
|
type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | RequestTokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | PrinterSettingsMessage | RuntimeReadyMessage | HostNavigateMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage | PubsubTopicsRequestMessage | PubsubTopicsListMessage | PubsubSubscribeMessage | PubsubEventMessage;
|
|
2564
2643
|
|
|
2565
|
-
export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOrderReservation, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type AdyenCardEntryConfig, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineComponent, type CartLineModifier, type CartReservation, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostNavigateMessage, type HostNavigateTarget, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type RequestTokenRefreshMessage, type ResolvedModifier, type ResolvedModifierChoice, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type TimeClockEntry, type TimeClockEntryStatus, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type TopicDefinitionWire, type TopicEventWire, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };
|
|
2644
|
+
export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOrderReservation, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type AdyenCardEntryConfig, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartAddress, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineComponent, type CartLineModifier, type CartReservation, type CartShipping, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostNavigateMessage, type HostNavigateTarget, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, type OrderShippingLine, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type RequestTokenRefreshMessage, type ResolvedModifier, type ResolvedModifierChoice, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type TimeClockEntry, type TimeClockEntryStatus, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type TopicDefinitionWire, type TopicEventWire, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };
|