@01.software/sdk 0.35.0 → 0.37.0
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/README.md +71 -6
- package/dist/analytics/react.cjs +33 -9
- package/dist/analytics/react.cjs.map +1 -1
- package/dist/analytics/react.d.cts +1 -1
- package/dist/analytics/react.d.ts +1 -1
- package/dist/analytics/react.js +33 -9
- package/dist/analytics/react.js.map +1 -1
- package/dist/analytics.cjs +30 -8
- package/dist/analytics.cjs.map +1 -1
- package/dist/analytics.d.cts +6 -0
- package/dist/analytics.d.ts +6 -0
- package/dist/analytics.js +30 -8
- package/dist/analytics.js.map +1 -1
- package/dist/client.cjs +94 -114
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +6 -6
- package/dist/client.d.ts +6 -6
- package/dist/client.js +94 -114
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-DkREjhQ9.d.ts → collection-client-DyELGUcL.d.ts} +3 -3
- package/dist/{collection-client-CR2B8c1v.d.cts → collection-client-zOmnxwdA.d.cts} +3 -3
- package/dist/{const-CdqCauHQ.d.ts → const-CK_FPaIn.d.cts} +3 -3
- package/dist/{const-BTvdrXtY.d.cts → const-Dqz05oaG.d.ts} +3 -3
- package/dist/{image-BDz2-AaO.d.cts → image-BDjHp03R.d.cts} +13 -9
- package/dist/{image-BDz2-AaO.d.ts → image-BDjHp03R.d.ts} +13 -9
- package/dist/{index-DK8_NXkh.d.ts → index-DRJs7QIh.d.cts} +9 -6
- package/dist/{index-CjA3U6X3.d.cts → index-DTqoUZk_.d.ts} +9 -6
- package/dist/index.cjs +229 -136
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +229 -136
- package/dist/index.js.map +1 -1
- package/dist/metadata.cjs +5 -3
- package/dist/metadata.cjs.map +1 -1
- package/dist/metadata.js +5 -3
- package/dist/metadata.js.map +1 -1
- package/dist/{payload-types-C7tb7Xbs.d.cts → payload-types-CREOjFNT.d.cts} +281 -128
- package/dist/{payload-types-C7tb7Xbs.d.ts → payload-types-CREOjFNT.d.ts} +281 -128
- package/dist/query.cjs +5 -3
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +5 -5
- package/dist/query.d.ts +5 -5
- package/dist/query.js +5 -3
- package/dist/query.js.map +1 -1
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/server.cjs +99 -69
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +7 -7
- package/dist/server.d.ts +7 -7
- package/dist/server.js +99 -69
- package/dist/server.js.map +1 -1
- package/dist/{types-DDhtZI6E.d.cts → types-BWMUr3Zw.d.cts} +274 -84
- package/dist/{types-Bx558PU6.d.cts → types-BkZNhuBh.d.cts} +1 -1
- package/dist/{types-1ylMrCuW.d.ts → types-CxzWHspI.d.ts} +1 -1
- package/dist/{types-Byo_Rty4.d.ts → types-DMvVHdb1.d.ts} +274 -84
- package/dist/ui/canvas.cjs +15 -5
- package/dist/ui/canvas.cjs.map +1 -1
- package/dist/ui/canvas.d.cts +1 -1
- package/dist/ui/canvas.d.ts +1 -1
- package/dist/ui/canvas.js +15 -5
- package/dist/ui/canvas.js.map +1 -1
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/image.cjs +15 -5
- package/dist/ui/image.cjs.map +1 -1
- package/dist/ui/image.d.cts +1 -1
- package/dist/ui/image.d.ts +1 -1
- package/dist/ui/image.js +15 -5
- package/dist/ui/image.js.map +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/webhook.cjs +5 -1
- package/dist/webhook.cjs.map +1 -1
- package/dist/webhook.d.cts +4 -4
- package/dist/webhook.d.ts +4 -4
- package/dist/webhook.js +5 -1
- package/dist/webhook.js.map +1 -1
- package/package.json +3 -3
|
@@ -50,6 +50,8 @@ interface Config {
|
|
|
50
50
|
transactions: Transaction;
|
|
51
51
|
'order-status-logs': OrderStatusLog;
|
|
52
52
|
'inventory-reservations': InventoryReservation;
|
|
53
|
+
'fulfillment-orders': FulfillmentOrder;
|
|
54
|
+
'fulfillment-order-items': FulfillmentOrderItem;
|
|
53
55
|
fulfillments: Fulfillment;
|
|
54
56
|
'fulfillment-items': FulfillmentItem;
|
|
55
57
|
returns: Return;
|
|
@@ -137,10 +139,14 @@ interface Config {
|
|
|
137
139
|
};
|
|
138
140
|
orders: {
|
|
139
141
|
items: 'order-items';
|
|
140
|
-
|
|
142
|
+
fulfillmentOrders: 'fulfillment-orders';
|
|
141
143
|
fulfillments: 'fulfillments';
|
|
144
|
+
transactions: 'transactions';
|
|
142
145
|
returns: 'returns';
|
|
143
146
|
};
|
|
147
|
+
'fulfillment-orders': {
|
|
148
|
+
items: 'fulfillment-order-items';
|
|
149
|
+
};
|
|
144
150
|
fulfillments: {
|
|
145
151
|
items: 'fulfillment-items';
|
|
146
152
|
};
|
|
@@ -219,6 +225,8 @@ interface Config {
|
|
|
219
225
|
transactions: TransactionsSelect<false> | TransactionsSelect<true>;
|
|
220
226
|
'order-status-logs': OrderStatusLogsSelect<false> | OrderStatusLogsSelect<true>;
|
|
221
227
|
'inventory-reservations': InventoryReservationsSelect<false> | InventoryReservationsSelect<true>;
|
|
228
|
+
'fulfillment-orders': FulfillmentOrdersSelect<false> | FulfillmentOrdersSelect<true>;
|
|
229
|
+
'fulfillment-order-items': FulfillmentOrderItemsSelect<false> | FulfillmentOrderItemsSelect<true>;
|
|
222
230
|
fulfillments: FulfillmentsSelect<false> | FulfillmentsSelect<true>;
|
|
223
231
|
'fulfillment-items': FulfillmentItemsSelect<false> | FulfillmentItemsSelect<true>;
|
|
224
232
|
returns: ReturnsSelect<false> | ReturnsSelect<true>;
|
|
@@ -847,37 +855,22 @@ interface Order {
|
|
|
847
855
|
id: string;
|
|
848
856
|
tenant?: (string | null) | Tenant;
|
|
849
857
|
orderNumber: string;
|
|
850
|
-
cartToken?: string | null;
|
|
851
|
-
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
852
|
-
totalAmount?: number | null;
|
|
853
|
-
discountCode?: string | null;
|
|
854
|
-
discountAmount?: number | null;
|
|
855
|
-
/**
|
|
856
|
-
* Cumulative refunded amount
|
|
857
|
-
*/
|
|
858
|
-
refundedAmount?: number | null;
|
|
859
858
|
/**
|
|
860
|
-
*
|
|
859
|
+
* Display status derived from payment, fulfillment order, shipment, and return state.
|
|
861
860
|
*/
|
|
862
|
-
|
|
861
|
+
displayStatus?: ('pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned') | null;
|
|
863
862
|
/**
|
|
864
|
-
*
|
|
863
|
+
* Primary order lifecycle display status excluding the return axis.
|
|
865
864
|
*/
|
|
866
|
-
|
|
867
|
-
taxAmount?: number | null;
|
|
868
|
-
source?: ('web' | 'app' | 'manual') | null;
|
|
869
|
-
currency?: string | null;
|
|
865
|
+
primaryDisplayStatus?: ('pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed') | null;
|
|
870
866
|
/**
|
|
871
|
-
*
|
|
867
|
+
* Return display status derived only when a return is active.
|
|
872
868
|
*/
|
|
873
|
-
|
|
874
|
-
cancelReason?: string | null;
|
|
875
|
-
canceledAt?: string | null;
|
|
876
|
-
completedAt?: string | null;
|
|
869
|
+
returnDisplayStatus?: ('return_requested' | 'return_processing' | 'returned') | null;
|
|
877
870
|
/**
|
|
878
|
-
*
|
|
871
|
+
* Deprecated: compatibility alias for displayStatus.
|
|
879
872
|
*/
|
|
880
|
-
|
|
873
|
+
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
881
874
|
customer?: (string | null) | Customer;
|
|
882
875
|
/**
|
|
883
876
|
* Customer info at the time of order
|
|
@@ -887,6 +880,11 @@ interface Order {
|
|
|
887
880
|
email?: string | null;
|
|
888
881
|
phone?: string | null;
|
|
889
882
|
};
|
|
883
|
+
items?: {
|
|
884
|
+
docs?: (string | OrderItem)[];
|
|
885
|
+
hasNextPage?: boolean;
|
|
886
|
+
totalDocs?: number;
|
|
887
|
+
};
|
|
890
888
|
shippingAddress?: {
|
|
891
889
|
recipientName?: string | null;
|
|
892
890
|
phone?: string | null;
|
|
@@ -895,33 +893,72 @@ interface Order {
|
|
|
895
893
|
detailAddress?: string | null;
|
|
896
894
|
deliveryMessage?: string | null;
|
|
897
895
|
};
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
businessRegistrationNumber?: string | null;
|
|
901
|
-
email?: string | null;
|
|
902
|
-
phone?: string | null;
|
|
903
|
-
address?: string | null;
|
|
904
|
-
};
|
|
905
|
-
items?: {
|
|
906
|
-
docs?: (string | OrderItem)[];
|
|
896
|
+
fulfillmentOrders?: {
|
|
897
|
+
docs?: (string | FulfillmentOrder)[];
|
|
907
898
|
hasNextPage?: boolean;
|
|
908
899
|
totalDocs?: number;
|
|
909
900
|
};
|
|
910
|
-
|
|
911
|
-
docs?: (string |
|
|
901
|
+
fulfillments?: {
|
|
902
|
+
docs?: (string | Fulfillment)[];
|
|
912
903
|
hasNextPage?: boolean;
|
|
913
904
|
totalDocs?: number;
|
|
914
905
|
};
|
|
915
|
-
|
|
916
|
-
|
|
906
|
+
totalAmount?: number | null;
|
|
907
|
+
/**
|
|
908
|
+
* Shipping amount at time of order
|
|
909
|
+
*/
|
|
910
|
+
shippingAmount?: number | null;
|
|
911
|
+
/**
|
|
912
|
+
* Note left by customer at checkout
|
|
913
|
+
*/
|
|
914
|
+
customerNote?: string | null;
|
|
915
|
+
transactions?: {
|
|
916
|
+
docs?: (string | Transaction)[];
|
|
917
917
|
hasNextPage?: boolean;
|
|
918
918
|
totalDocs?: number;
|
|
919
919
|
};
|
|
920
|
+
financialStatus: 'pending' | 'paid' | 'failed' | 'canceled' | 'partially_refunded' | 'refunded';
|
|
921
|
+
/**
|
|
922
|
+
* Item subtotal (excl. shipping & discount)
|
|
923
|
+
*/
|
|
924
|
+
subtotalAmount?: number | null;
|
|
925
|
+
discountCode?: string | null;
|
|
926
|
+
discountAmount?: number | null;
|
|
927
|
+
/**
|
|
928
|
+
* Cumulative refunded amount
|
|
929
|
+
*/
|
|
930
|
+
refundedAmount?: number | null;
|
|
931
|
+
taxAmount?: number | null;
|
|
932
|
+
/**
|
|
933
|
+
* Initial shipping refund policy snapshot at order time
|
|
934
|
+
*/
|
|
935
|
+
returnShippingRefundPolicySnapshot?: {
|
|
936
|
+
[k: string]: unknown;
|
|
937
|
+
} | unknown[] | string | number | boolean | null;
|
|
920
938
|
returns?: {
|
|
921
939
|
docs?: (string | Return)[];
|
|
922
940
|
hasNextPage?: boolean;
|
|
923
941
|
totalDocs?: number;
|
|
924
942
|
};
|
|
943
|
+
confirmationStatus: 'unconfirmed' | 'confirmed';
|
|
944
|
+
confirmedAt?: string | null;
|
|
945
|
+
cancelReason?: string | null;
|
|
946
|
+
canceledAt?: string | null;
|
|
947
|
+
completedAt?: string | null;
|
|
948
|
+
billingAddress?: {
|
|
949
|
+
recipientName?: string | null;
|
|
950
|
+
businessRegistrationNumber?: string | null;
|
|
951
|
+
email?: string | null;
|
|
952
|
+
phone?: string | null;
|
|
953
|
+
address?: string | null;
|
|
954
|
+
};
|
|
955
|
+
/**
|
|
956
|
+
* Internal admin notes (not visible to customers)
|
|
957
|
+
*/
|
|
958
|
+
adminNotes?: string | null;
|
|
959
|
+
source?: ('web' | 'app' | 'manual') | null;
|
|
960
|
+
currency?: string | null;
|
|
961
|
+
cartToken?: string | null;
|
|
925
962
|
metadata?: {
|
|
926
963
|
[k: string]: unknown;
|
|
927
964
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -1382,10 +1419,6 @@ interface Product {
|
|
|
1382
1419
|
* Maximum order quantity for this product.
|
|
1383
1420
|
*/
|
|
1384
1421
|
maxOrderQuantity?: number | null;
|
|
1385
|
-
/**
|
|
1386
|
-
* Primary option used to expand this product into option-value cards.
|
|
1387
|
-
*/
|
|
1388
|
-
listingPrimaryOption?: (string | null) | ProductOption;
|
|
1389
1422
|
/**
|
|
1390
1423
|
* Automatically computed values for product cards and search.
|
|
1391
1424
|
*/
|
|
@@ -1422,18 +1455,6 @@ interface Product {
|
|
|
1422
1455
|
* Enabled when at least one variant is sellable.
|
|
1423
1456
|
*/
|
|
1424
1457
|
availableForSale?: boolean | null;
|
|
1425
|
-
/**
|
|
1426
|
-
* Automatically derived from the primary option setting.
|
|
1427
|
-
*/
|
|
1428
|
-
groupingState?: ('grouped' | 'no_primary_option' | 'empty') | null;
|
|
1429
|
-
/**
|
|
1430
|
-
* Shown when grouping produces zero cards. Visible before publish.
|
|
1431
|
-
*/
|
|
1432
|
-
groupingEmptyReason?: ('primary_option_not_linked' | 'primary_option_has_no_values' | 'no_variants_for_primary_option') | null;
|
|
1433
|
-
/**
|
|
1434
|
-
* Number of expandable option-value cards.
|
|
1435
|
-
*/
|
|
1436
|
-
groupingCount?: number | null;
|
|
1437
1458
|
};
|
|
1438
1459
|
seo?: {
|
|
1439
1460
|
/**
|
|
@@ -1988,6 +2009,10 @@ interface ProductTag {
|
|
|
1988
2009
|
* Single representative taxonomy image. Add domain-specific fields for multiple images such as thumbnail and hero variants.
|
|
1989
2010
|
*/
|
|
1990
2011
|
image?: (string | null) | Image;
|
|
2012
|
+
/**
|
|
2013
|
+
* Optional #RRGGBB hex color for taxonomy badges or filter UI. This does not replace the representative image.
|
|
2014
|
+
*/
|
|
2015
|
+
color?: string | null;
|
|
1991
2016
|
updatedAt: string;
|
|
1992
2017
|
createdAt: string;
|
|
1993
2018
|
deletedAt?: string | null;
|
|
@@ -2342,62 +2367,43 @@ interface ProductCollection {
|
|
|
2342
2367
|
}
|
|
2343
2368
|
/**
|
|
2344
2369
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2345
|
-
* via the `definition` "
|
|
2370
|
+
* via the `definition` "fulfillment-orders".
|
|
2346
2371
|
*/
|
|
2347
|
-
interface
|
|
2372
|
+
interface FulfillmentOrder {
|
|
2348
2373
|
id: string;
|
|
2349
2374
|
tenant?: (string | null) | Tenant;
|
|
2350
|
-
_title?: string | null;
|
|
2351
|
-
type: 'payment' | 'refund';
|
|
2352
|
-
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded';
|
|
2353
2375
|
order: string | Order;
|
|
2354
|
-
|
|
2376
|
+
status: 'open' | 'in_progress' | 'on_hold' | 'canceled' | 'closed';
|
|
2377
|
+
holdReason?: string | null;
|
|
2355
2378
|
/**
|
|
2356
|
-
*
|
|
2357
|
-
*/
|
|
2358
|
-
paymentMethod?: string | null;
|
|
2359
|
-
/**
|
|
2360
|
-
* Installment months (0 = lump sum)
|
|
2379
|
+
* Warehouse, store, or external location identifier assigned to this fulfillment order.
|
|
2361
2380
|
*/
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
confirmedAmount?: number | null;
|
|
2370
|
-
confirmedCurrency?: string | null;
|
|
2371
|
-
confirmedAt?: string | null;
|
|
2372
|
-
confirmationSource?: ('provider_webhook' | 'provider_lookup' | 'provider_api_confirm' | 'manual_server') | null;
|
|
2373
|
-
cashReceipt?: {
|
|
2374
|
-
issuanceType?: ('none' | 'personal' | 'business') | null;
|
|
2375
|
-
/**
|
|
2376
|
-
* Personal: phone or cash receipt card number / Business: business registration number
|
|
2377
|
-
*/
|
|
2378
|
-
registrationNumber?: string | null;
|
|
2379
|
-
issueNumber?: string | null;
|
|
2380
|
-
issuedAt?: string | null;
|
|
2381
|
-
};
|
|
2382
|
-
cardInfo?: {
|
|
2383
|
-
brand?: string | null;
|
|
2384
|
-
last4?: string | null;
|
|
2385
|
-
expMonth?: number | null;
|
|
2386
|
-
expYear?: number | null;
|
|
2387
|
-
issuerCode?: string | null;
|
|
2388
|
-
type?: ('credit' | 'debit' | 'gift') | null;
|
|
2389
|
-
owner?: string | null;
|
|
2381
|
+
assignedLocation?: string | null;
|
|
2382
|
+
preparedAt?: string | null;
|
|
2383
|
+
closedAt?: string | null;
|
|
2384
|
+
items?: {
|
|
2385
|
+
docs?: (string | FulfillmentOrderItem)[];
|
|
2386
|
+
hasNextPage?: boolean;
|
|
2387
|
+
totalDocs?: number;
|
|
2390
2388
|
};
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2389
|
+
adminNotes?: string | null;
|
|
2390
|
+
metadata?: {
|
|
2391
|
+
[k: string]: unknown;
|
|
2392
|
+
} | unknown[] | string | number | boolean | null;
|
|
2393
|
+
updatedAt: string;
|
|
2394
|
+
createdAt: string;
|
|
2395
|
+
deletedAt?: string | null;
|
|
2396
|
+
}
|
|
2397
|
+
/**
|
|
2398
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
2399
|
+
* via the `definition` "fulfillment-order-items".
|
|
2400
|
+
*/
|
|
2401
|
+
interface FulfillmentOrderItem {
|
|
2402
|
+
id: string;
|
|
2403
|
+
tenant?: (string | null) | Tenant;
|
|
2404
|
+
fulfillmentOrder: string | FulfillmentOrder;
|
|
2405
|
+
orderItem: string | OrderItem;
|
|
2406
|
+
quantity: number;
|
|
2401
2407
|
metadata?: {
|
|
2402
2408
|
[k: string]: unknown;
|
|
2403
2409
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -2413,7 +2419,8 @@ interface Fulfillment {
|
|
|
2413
2419
|
id: string;
|
|
2414
2420
|
tenant?: (string | null) | Tenant;
|
|
2415
2421
|
order: string | Order;
|
|
2416
|
-
status: 'pending' | 'packed' | 'shipped' | 'delivered' | 'failed';
|
|
2422
|
+
status: 'pending' | 'packed' | 'shipped' | 'delivered' | 'canceled' | 'failed';
|
|
2423
|
+
fulfillmentOrder: string | FulfillmentOrder;
|
|
2417
2424
|
/**
|
|
2418
2425
|
* Carrier name (e.g. CJ Logistics, FedEx)
|
|
2419
2426
|
*/
|
|
@@ -2459,6 +2466,71 @@ interface FulfillmentItem {
|
|
|
2459
2466
|
createdAt: string;
|
|
2460
2467
|
deletedAt?: string | null;
|
|
2461
2468
|
}
|
|
2469
|
+
/**
|
|
2470
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
2471
|
+
* via the `definition` "transactions".
|
|
2472
|
+
*/
|
|
2473
|
+
interface Transaction {
|
|
2474
|
+
id: string;
|
|
2475
|
+
tenant?: (string | null) | Tenant;
|
|
2476
|
+
_title?: string | null;
|
|
2477
|
+
type: 'payment' | 'refund';
|
|
2478
|
+
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded';
|
|
2479
|
+
order: string | Order;
|
|
2480
|
+
amount?: number | null;
|
|
2481
|
+
/**
|
|
2482
|
+
* Payment method snapshot returned by the provider. Not edited directly.
|
|
2483
|
+
*/
|
|
2484
|
+
paymentMethod?: string | null;
|
|
2485
|
+
/**
|
|
2486
|
+
* Installment months (0 = lump sum)
|
|
2487
|
+
*/
|
|
2488
|
+
installmentMonths?: number | null;
|
|
2489
|
+
approvedAt?: string | null;
|
|
2490
|
+
receiptUrl?: string | null;
|
|
2491
|
+
pgPaymentId?: string | null;
|
|
2492
|
+
pgOrderId?: string | null;
|
|
2493
|
+
providerEventId?: string | null;
|
|
2494
|
+
providerStatus?: string | null;
|
|
2495
|
+
confirmedAmount?: number | null;
|
|
2496
|
+
confirmedCurrency?: string | null;
|
|
2497
|
+
confirmedAt?: string | null;
|
|
2498
|
+
confirmationSource?: ('provider_webhook' | 'provider_lookup' | 'provider_api_confirm' | 'manual_server') | null;
|
|
2499
|
+
cashReceipt?: {
|
|
2500
|
+
issuanceType?: ('none' | 'personal' | 'business') | null;
|
|
2501
|
+
/**
|
|
2502
|
+
* Personal: phone or cash receipt card number / Business: business registration number
|
|
2503
|
+
*/
|
|
2504
|
+
registrationNumber?: string | null;
|
|
2505
|
+
issueNumber?: string | null;
|
|
2506
|
+
issuedAt?: string | null;
|
|
2507
|
+
};
|
|
2508
|
+
cardInfo?: {
|
|
2509
|
+
brand?: string | null;
|
|
2510
|
+
last4?: string | null;
|
|
2511
|
+
expMonth?: number | null;
|
|
2512
|
+
expYear?: number | null;
|
|
2513
|
+
issuerCode?: string | null;
|
|
2514
|
+
type?: ('credit' | 'debit' | 'gift') | null;
|
|
2515
|
+
owner?: string | null;
|
|
2516
|
+
};
|
|
2517
|
+
failureCode?: string | null;
|
|
2518
|
+
failureMessage?: string | null;
|
|
2519
|
+
/**
|
|
2520
|
+
* Payment gateway (e.g. toss, stripe)
|
|
2521
|
+
*/
|
|
2522
|
+
pgProvider?: string | null;
|
|
2523
|
+
/**
|
|
2524
|
+
* Legal retention deadline (5 years, Electronic Financial Transactions Act)
|
|
2525
|
+
*/
|
|
2526
|
+
retainUntil?: string | null;
|
|
2527
|
+
metadata?: {
|
|
2528
|
+
[k: string]: unknown;
|
|
2529
|
+
} | unknown[] | string | number | boolean | null;
|
|
2530
|
+
updatedAt: string;
|
|
2531
|
+
createdAt: string;
|
|
2532
|
+
deletedAt?: string | null;
|
|
2533
|
+
}
|
|
2462
2534
|
/**
|
|
2463
2535
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2464
2536
|
* via the `definition` "returns".
|
|
@@ -2501,6 +2573,18 @@ interface Return {
|
|
|
2501
2573
|
* Return shipping fee deducted from refundAmount
|
|
2502
2574
|
*/
|
|
2503
2575
|
returnShippingFee?: number | null;
|
|
2576
|
+
/**
|
|
2577
|
+
* Initial order shipping amount refunded
|
|
2578
|
+
*/
|
|
2579
|
+
initialShippingRefundAmount?: number | null;
|
|
2580
|
+
initialShippingRefundSuggestedAmount?: number | null;
|
|
2581
|
+
/**
|
|
2582
|
+
* Audit note for overriding the initial shipping refund suggestion
|
|
2583
|
+
*/
|
|
2584
|
+
initialShippingRefundOverrideNote?: string | null;
|
|
2585
|
+
initialShippingRefundPolicySnapshot?: {
|
|
2586
|
+
[k: string]: unknown;
|
|
2587
|
+
} | unknown[] | string | number | boolean | null;
|
|
2504
2588
|
/**
|
|
2505
2589
|
* Exchange balance (positive: extra charge, negative: extra refund)
|
|
2506
2590
|
*/
|
|
@@ -2770,7 +2854,7 @@ interface Webhook {
|
|
|
2770
2854
|
/**
|
|
2771
2855
|
* HMAC signing secret (encrypted at rest, never returned on read). Reveal or rotate in Admin.
|
|
2772
2856
|
*/
|
|
2773
|
-
secret
|
|
2857
|
+
secret?: string | null;
|
|
2774
2858
|
/**
|
|
2775
2859
|
* When the signing secret was first revealed to a tenant-admin (one time).
|
|
2776
2860
|
*/
|
|
@@ -2790,7 +2874,7 @@ interface Webhook {
|
|
|
2790
2874
|
/**
|
|
2791
2875
|
* Receives create/update events for this collection.
|
|
2792
2876
|
*/
|
|
2793
|
-
collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'canvas-nodes' | 'canvas-edges' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags';
|
|
2877
|
+
collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillment-orders' | 'fulfillment-order-items' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'canvas-nodes' | 'canvas-edges' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags';
|
|
2794
2878
|
id?: string | null;
|
|
2795
2879
|
}[] | null;
|
|
2796
2880
|
isActive?: boolean | null;
|
|
@@ -2949,6 +3033,15 @@ interface TenantMetadatum {
|
|
|
2949
3033
|
*/
|
|
2950
3034
|
twitterImage?: (string | null) | Image;
|
|
2951
3035
|
};
|
|
3036
|
+
ecommerceReturnPolicy?: {
|
|
3037
|
+
initialShippingRefundMode?: ('full_order_only' | 'never') | null;
|
|
3038
|
+
eligibleInitialShippingRefundReasons?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other')[] | null;
|
|
3039
|
+
returnShippingFeeDefaultMode?: 'manual_only' | null;
|
|
3040
|
+
manualOverrideAllowed?: boolean | null;
|
|
3041
|
+
overrideNoteRequired?: boolean | null;
|
|
3042
|
+
multiReturnInitialShippingRefund?: 'once_only' | null;
|
|
3043
|
+
legacyOrderPolicyMode?: 'shipping_amount_manual_cap' | null;
|
|
3044
|
+
};
|
|
2952
3045
|
/**
|
|
2953
3046
|
* Reusable option name and value lists for the Product Editor. Up to 20 presets.
|
|
2954
3047
|
*/
|
|
@@ -3505,7 +3598,13 @@ interface OrderStatusLog {
|
|
|
3505
3598
|
id: string;
|
|
3506
3599
|
tenant?: (string | null) | Tenant;
|
|
3507
3600
|
order: string | Order;
|
|
3601
|
+
/**
|
|
3602
|
+
* Previous deprecated orders.status/displayStatus alias value.
|
|
3603
|
+
*/
|
|
3508
3604
|
fromStatus: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3605
|
+
/**
|
|
3606
|
+
* Next deprecated orders.status/displayStatus alias value.
|
|
3607
|
+
*/
|
|
3509
3608
|
toStatus: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3510
3609
|
/**
|
|
3511
3610
|
* 'user:{id}' | 'api:updateOrder' | 'system:transaction:{paymentId}' | 'system:fulfillment:{id}' | 'system:return:{id}'
|
|
@@ -5212,6 +5311,7 @@ interface PostCategory {
|
|
|
5212
5311
|
interface PostTag {
|
|
5213
5312
|
id: string;
|
|
5214
5313
|
_order?: string | null;
|
|
5314
|
+
tenant?: (string | null) | Tenant;
|
|
5215
5315
|
title?: string | null;
|
|
5216
5316
|
/**
|
|
5217
5317
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
@@ -6596,6 +6696,15 @@ interface TenantMetadataSelect<T extends boolean = true> {
|
|
|
6596
6696
|
twitterDescription?: T;
|
|
6597
6697
|
twitterImage?: T;
|
|
6598
6698
|
};
|
|
6699
|
+
ecommerceReturnPolicy?: T | {
|
|
6700
|
+
initialShippingRefundMode?: T;
|
|
6701
|
+
eligibleInitialShippingRefundReasons?: T;
|
|
6702
|
+
returnShippingFeeDefaultMode?: T;
|
|
6703
|
+
manualOverrideAllowed?: T;
|
|
6704
|
+
overrideNoteRequired?: T;
|
|
6705
|
+
multiReturnInitialShippingRefund?: T;
|
|
6706
|
+
legacyOrderPolicyMode?: T;
|
|
6707
|
+
};
|
|
6599
6708
|
optionPresets?: T | {
|
|
6600
6709
|
name?: T;
|
|
6601
6710
|
options?: T | {
|
|
@@ -7020,7 +7129,6 @@ interface ProductsSelect<T extends boolean = true> {
|
|
|
7020
7129
|
collectionItems?: T;
|
|
7021
7130
|
minOrderQuantity?: T;
|
|
7022
7131
|
maxOrderQuantity?: T;
|
|
7023
|
-
listingPrimaryOption?: T;
|
|
7024
7132
|
listing?: T | {
|
|
7025
7133
|
selectionHintVariant?: T;
|
|
7026
7134
|
primaryImage?: T;
|
|
@@ -7030,9 +7138,6 @@ interface ProductsSelect<T extends boolean = true> {
|
|
|
7030
7138
|
maxCompareAtPrice?: T;
|
|
7031
7139
|
isPriceRange?: T;
|
|
7032
7140
|
availableForSale?: T;
|
|
7033
|
-
groupingState?: T;
|
|
7034
|
-
groupingEmptyReason?: T;
|
|
7035
|
-
groupingCount?: T;
|
|
7036
7141
|
};
|
|
7037
7142
|
seo?: T | {
|
|
7038
7143
|
title?: T;
|
|
@@ -7158,6 +7263,7 @@ interface ProductTagsSelect<T extends boolean = true> {
|
|
|
7158
7263
|
slug?: T;
|
|
7159
7264
|
description?: T;
|
|
7160
7265
|
image?: T;
|
|
7266
|
+
color?: T;
|
|
7161
7267
|
updatedAt?: T;
|
|
7162
7268
|
createdAt?: T;
|
|
7163
7269
|
deletedAt?: T;
|
|
@@ -7340,28 +7446,17 @@ interface BrandLogosSelect<T extends boolean = true> {
|
|
|
7340
7446
|
interface OrdersSelect<T extends boolean = true> {
|
|
7341
7447
|
tenant?: T;
|
|
7342
7448
|
orderNumber?: T;
|
|
7343
|
-
|
|
7449
|
+
displayStatus?: T;
|
|
7450
|
+
primaryDisplayStatus?: T;
|
|
7451
|
+
returnDisplayStatus?: T;
|
|
7344
7452
|
status?: T;
|
|
7345
|
-
totalAmount?: T;
|
|
7346
|
-
discountCode?: T;
|
|
7347
|
-
discountAmount?: T;
|
|
7348
|
-
refundedAmount?: T;
|
|
7349
|
-
shippingAmount?: T;
|
|
7350
|
-
subtotalAmount?: T;
|
|
7351
|
-
taxAmount?: T;
|
|
7352
|
-
source?: T;
|
|
7353
|
-
currency?: T;
|
|
7354
|
-
adminNotes?: T;
|
|
7355
|
-
cancelReason?: T;
|
|
7356
|
-
canceledAt?: T;
|
|
7357
|
-
completedAt?: T;
|
|
7358
|
-
customerNote?: T;
|
|
7359
7453
|
customer?: T;
|
|
7360
7454
|
customerSnapshot?: T | {
|
|
7361
7455
|
name?: T;
|
|
7362
7456
|
email?: T;
|
|
7363
7457
|
phone?: T;
|
|
7364
7458
|
};
|
|
7459
|
+
items?: T;
|
|
7365
7460
|
shippingAddress?: T | {
|
|
7366
7461
|
recipientName?: T;
|
|
7367
7462
|
phone?: T;
|
|
@@ -7370,6 +7465,25 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7370
7465
|
detailAddress?: T;
|
|
7371
7466
|
deliveryMessage?: T;
|
|
7372
7467
|
};
|
|
7468
|
+
fulfillmentOrders?: T;
|
|
7469
|
+
fulfillments?: T;
|
|
7470
|
+
totalAmount?: T;
|
|
7471
|
+
shippingAmount?: T;
|
|
7472
|
+
customerNote?: T;
|
|
7473
|
+
transactions?: T;
|
|
7474
|
+
financialStatus?: T;
|
|
7475
|
+
subtotalAmount?: T;
|
|
7476
|
+
discountCode?: T;
|
|
7477
|
+
discountAmount?: T;
|
|
7478
|
+
refundedAmount?: T;
|
|
7479
|
+
taxAmount?: T;
|
|
7480
|
+
returnShippingRefundPolicySnapshot?: T;
|
|
7481
|
+
returns?: T;
|
|
7482
|
+
confirmationStatus?: T;
|
|
7483
|
+
confirmedAt?: T;
|
|
7484
|
+
cancelReason?: T;
|
|
7485
|
+
canceledAt?: T;
|
|
7486
|
+
completedAt?: T;
|
|
7373
7487
|
billingAddress?: T | {
|
|
7374
7488
|
recipientName?: T;
|
|
7375
7489
|
businessRegistrationNumber?: T;
|
|
@@ -7377,10 +7491,10 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7377
7491
|
phone?: T;
|
|
7378
7492
|
address?: T;
|
|
7379
7493
|
};
|
|
7380
|
-
|
|
7381
|
-
|
|
7382
|
-
|
|
7383
|
-
|
|
7494
|
+
adminNotes?: T;
|
|
7495
|
+
source?: T;
|
|
7496
|
+
currency?: T;
|
|
7497
|
+
cartToken?: T;
|
|
7384
7498
|
metadata?: T;
|
|
7385
7499
|
nextRefundSeq?: T;
|
|
7386
7500
|
nextCaptureSeq?: T;
|
|
@@ -7495,6 +7609,39 @@ interface InventoryReservationsSelect<T extends boolean = true> {
|
|
|
7495
7609
|
createdAt?: T;
|
|
7496
7610
|
deletedAt?: T;
|
|
7497
7611
|
}
|
|
7612
|
+
/**
|
|
7613
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7614
|
+
* via the `definition` "fulfillment-orders_select".
|
|
7615
|
+
*/
|
|
7616
|
+
interface FulfillmentOrdersSelect<T extends boolean = true> {
|
|
7617
|
+
tenant?: T;
|
|
7618
|
+
order?: T;
|
|
7619
|
+
status?: T;
|
|
7620
|
+
holdReason?: T;
|
|
7621
|
+
assignedLocation?: T;
|
|
7622
|
+
preparedAt?: T;
|
|
7623
|
+
closedAt?: T;
|
|
7624
|
+
items?: T;
|
|
7625
|
+
adminNotes?: T;
|
|
7626
|
+
metadata?: T;
|
|
7627
|
+
updatedAt?: T;
|
|
7628
|
+
createdAt?: T;
|
|
7629
|
+
deletedAt?: T;
|
|
7630
|
+
}
|
|
7631
|
+
/**
|
|
7632
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7633
|
+
* via the `definition` "fulfillment-order-items_select".
|
|
7634
|
+
*/
|
|
7635
|
+
interface FulfillmentOrderItemsSelect<T extends boolean = true> {
|
|
7636
|
+
tenant?: T;
|
|
7637
|
+
fulfillmentOrder?: T;
|
|
7638
|
+
orderItem?: T;
|
|
7639
|
+
quantity?: T;
|
|
7640
|
+
metadata?: T;
|
|
7641
|
+
updatedAt?: T;
|
|
7642
|
+
createdAt?: T;
|
|
7643
|
+
deletedAt?: T;
|
|
7644
|
+
}
|
|
7498
7645
|
/**
|
|
7499
7646
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7500
7647
|
* via the `definition` "fulfillments_select".
|
|
@@ -7503,6 +7650,7 @@ interface FulfillmentsSelect<T extends boolean = true> {
|
|
|
7503
7650
|
tenant?: T;
|
|
7504
7651
|
order?: T;
|
|
7505
7652
|
status?: T;
|
|
7653
|
+
fulfillmentOrder?: T;
|
|
7506
7654
|
carrier?: T;
|
|
7507
7655
|
trackingNumber?: T;
|
|
7508
7656
|
trackingUrl?: T;
|
|
@@ -7548,6 +7696,10 @@ interface ReturnsSelect<T extends boolean = true> {
|
|
|
7548
7696
|
refundReceiptUrl?: T;
|
|
7549
7697
|
refundAmount?: T;
|
|
7550
7698
|
returnShippingFee?: T;
|
|
7699
|
+
initialShippingRefundAmount?: T;
|
|
7700
|
+
initialShippingRefundSuggestedAmount?: T;
|
|
7701
|
+
initialShippingRefundOverrideNote?: T;
|
|
7702
|
+
initialShippingRefundPolicySnapshot?: T;
|
|
7551
7703
|
exchangeDifference?: T;
|
|
7552
7704
|
metadata?: T;
|
|
7553
7705
|
updatedAt?: T;
|
|
@@ -8837,6 +8989,7 @@ interface PostCategoriesSelect<T extends boolean = true> {
|
|
|
8837
8989
|
*/
|
|
8838
8990
|
interface PostTagsSelect<T extends boolean = true> {
|
|
8839
8991
|
_order?: T;
|
|
8992
|
+
tenant?: T;
|
|
8840
8993
|
title?: T;
|
|
8841
8994
|
generateSlug?: T;
|
|
8842
8995
|
slug?: T;
|