@wix/auto_sdk_ecom_draft-orders 1.0.24 → 1.0.25
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/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +18 -2
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +13 -9
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +13 -9
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +16 -11
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +213 -2
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +242 -11
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +60 -8
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +16 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +13 -9
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +13 -9
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +16 -11
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +211 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +242 -11
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +60 -8
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +18 -2
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +13 -9
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +13 -9
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +16 -11
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +213 -2
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +244 -12
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +60 -8
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +16 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +13 -9
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +13 -9
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +16 -11
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +211 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +244 -12
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +60 -8
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/**
|
|
2
|
+
* Draft Order main entity.
|
|
3
|
+
* A temporary version of an order, allowing modifications before finalization.
|
|
4
|
+
*/
|
|
2
5
|
export interface DraftOrder {
|
|
3
6
|
/**
|
|
4
7
|
* Draft order ID.
|
|
@@ -639,6 +642,11 @@ export interface SubscriptionInfo {
|
|
|
639
642
|
* @immutable
|
|
640
643
|
*/
|
|
641
644
|
subscriptionSettings?: SubscriptionSettings;
|
|
645
|
+
/**
|
|
646
|
+
* Description of the charges that will be applied for subscription.
|
|
647
|
+
* @maxLength 1000
|
|
648
|
+
*/
|
|
649
|
+
chargesDescription?: string | null;
|
|
642
650
|
}
|
|
643
651
|
export interface SubscriptionTitle {
|
|
644
652
|
/**
|
|
@@ -776,6 +784,63 @@ export interface ExtendedFields {
|
|
|
776
784
|
*/
|
|
777
785
|
namespaces?: Record<string, Record<string, any>>;
|
|
778
786
|
}
|
|
787
|
+
export interface ModifierGroup {
|
|
788
|
+
/**
|
|
789
|
+
* Modifier group id.
|
|
790
|
+
* @minLength 1
|
|
791
|
+
* @maxLength 36
|
|
792
|
+
*/
|
|
793
|
+
id?: string;
|
|
794
|
+
/** Modifier group name. */
|
|
795
|
+
name?: TranslatableString;
|
|
796
|
+
/**
|
|
797
|
+
* List of modifiers in this group.
|
|
798
|
+
* @minSize 1
|
|
799
|
+
* @maxSize 10
|
|
800
|
+
*/
|
|
801
|
+
modifiers?: ItemModifier[];
|
|
802
|
+
}
|
|
803
|
+
export interface TranslatableString {
|
|
804
|
+
/**
|
|
805
|
+
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
806
|
+
*
|
|
807
|
+
* Min: 1 character.
|
|
808
|
+
* Max: 200 characters.
|
|
809
|
+
* @minLength 1
|
|
810
|
+
* @maxLength 200
|
|
811
|
+
*/
|
|
812
|
+
original?: string;
|
|
813
|
+
/**
|
|
814
|
+
* String translated into the buyer's language.
|
|
815
|
+
*
|
|
816
|
+
* Min: 1 character.
|
|
817
|
+
* Max: 400 characters.
|
|
818
|
+
* Default: Same as `original`.
|
|
819
|
+
* @minLength 1
|
|
820
|
+
* @maxLength 400
|
|
821
|
+
*/
|
|
822
|
+
translated?: string | null;
|
|
823
|
+
}
|
|
824
|
+
export interface ItemModifier {
|
|
825
|
+
/**
|
|
826
|
+
* Modifier ID.
|
|
827
|
+
* @minLength 1
|
|
828
|
+
* @maxLength 36
|
|
829
|
+
*/
|
|
830
|
+
id?: string;
|
|
831
|
+
/**
|
|
832
|
+
* The quantity of this modifier.
|
|
833
|
+
* @min 1
|
|
834
|
+
* @max 100000
|
|
835
|
+
*/
|
|
836
|
+
quantity?: number | null;
|
|
837
|
+
/** Primary display label for the modifier. */
|
|
838
|
+
label?: TranslatableString;
|
|
839
|
+
/** Optional additional details or clarification for the modifier. */
|
|
840
|
+
details?: TranslatableString;
|
|
841
|
+
/** The price of the modifier. */
|
|
842
|
+
price?: Price;
|
|
843
|
+
}
|
|
779
844
|
export interface ItemChangedDetails {
|
|
780
845
|
/**
|
|
781
846
|
* Line item quantity before change.
|
|
@@ -1113,7 +1178,7 @@ export interface AdditionalFeeDetails {
|
|
|
1113
1178
|
* Supported values:
|
|
1114
1179
|
* + `ORIGINAL_ORDER`: This additional fee is part of the original order.
|
|
1115
1180
|
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1116
|
-
* + `CUSTOM`: This additional fee was created by the
|
|
1181
|
+
* + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
|
|
1117
1182
|
*/
|
|
1118
1183
|
source?: SourceType;
|
|
1119
1184
|
/** Whether this additional fee is applied to the order. */
|
|
@@ -1183,7 +1248,7 @@ export interface DiscountDetails {
|
|
|
1183
1248
|
*
|
|
1184
1249
|
* Supported values:
|
|
1185
1250
|
* + `ORIGINAL_ORDER`: This discount is part of the original order.
|
|
1186
|
-
* + `CUSTOM`: This discount was created by the
|
|
1251
|
+
* + `CUSTOM`: This discount was created by the Create Custom Discounts method.
|
|
1187
1252
|
*/
|
|
1188
1253
|
source?: SourceType;
|
|
1189
1254
|
/** Whether this discount is applied to the order. */
|
|
@@ -1679,7 +1744,9 @@ export interface PickupDetails {
|
|
|
1679
1744
|
}
|
|
1680
1745
|
export declare enum PickupMethod {
|
|
1681
1746
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1747
|
+
/** Store pickup. */
|
|
1682
1748
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1749
|
+
/** Pickup point. */
|
|
1683
1750
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1684
1751
|
}
|
|
1685
1752
|
export interface DeliveryTimeSlot {
|
|
@@ -122,7 +122,9 @@ export var WeightUnit;
|
|
|
122
122
|
export var PickupMethod;
|
|
123
123
|
(function (PickupMethod) {
|
|
124
124
|
PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
|
|
125
|
+
/** Store pickup. */
|
|
125
126
|
PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
|
|
127
|
+
/** Pickup point. */
|
|
126
128
|
PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
|
|
127
129
|
})(PickupMethod || (PickupMethod = {}));
|
|
128
130
|
export var RuleType;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-v1-draft-order-draft-orders.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-draft-order-draft-orders.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ecom-v1-draft-order-draft-orders.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-draft-order-draft-orders.types.ts"],"names":[],"mappings":"AA0bA,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B;AAgED,MAAM,CAAN,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,KAAhB,gBAAgB,QAM3B;AAED,uDAAuD;AACvD,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,wEAAwE;IACxE,gEAA2C,CAAA;IAC3C,sIAAsI;IACtI,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AA4ED,0IAA0I;AAC1I,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AA8GD,0CAA0C;AAC1C,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AAoBD,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,qEAAmD,CAAA;IACnD,qIAAqI;IACrI,+CAA6B,CAAA;IAC7B,sIAAsI;IACtI,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAiDD,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAkRD,qBAAqB;AACrB,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB;AAuDD,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,8DAAiC,CAAA;IACjC,0DAA6B,CAAA;IAC7B,0DAA6B,CAAA;AAC/B,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC;AAsJD,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,kCAAkC;IAClC,+CAAiC,CAAA;IACjC,4FAA4F;IAC5F,qCAAuB,CAAA;IACvB,qCAAqC;IACrC,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AA4DD,MAAM,CAAN,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,gDAAiB,CAAA;IACjB,gEAAiC,CAAA;IACjC,oDAAqB,CAAA;AACvB,CAAC,EAJW,2BAA2B,KAA3B,2BAA2B,QAItC;AA4CD,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,qDAAmC,CAAA;IACnC,2DAAyC,CAAA;AAC3C,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAkED,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACvB,mCAAmC;IACnC,gCAAe,CAAA;IACf;;;;OAIG;IACH,wCAAuB,CAAA;AACzB,CAAC,EATW,aAAa,KAAb,aAAa,QASxB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAiWD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,oBAAoB;IACpB,6CAA6B,CAAA;IAC7B,oBAAoB;IACpB,6CAA6B,CAAA;AAC/B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAsGD,MAAM,CAAN,IAAY,QAsBX;AAtBD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,uBAAW,CAAA;IACX,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,6CAAiC,CAAA;IACjC,mDAAuC,CAAA;IACvC,iDAAqC,CAAA;IACrC,yCAA6B,CAAA;IAC7B,qCAAyB,CAAA;IACzB,2DAA+C,CAAA;AACjD,CAAC,EAtBW,QAAQ,KAAR,QAAQ,QAsBnB;AA2KD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,6CAAiC,CAAA;IACjC,yCAA6B,CAAA;IAC7B,+CAAmC,CAAA;IACnC,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AA6JD,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,6CAA6B,CAAA;IAC7B,4CAA4C;IAC5C,iCAAiB,CAAA;IACjB,2CAA2C;IAC3C,iDAAiC,CAAA;IACjC,wCAAwC;IACxC,qCAAqB,CAAA;AACvB,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AA+PD,MAAM,CAAN,IAAY,kBAsBX;AAtBD,WAAY,kBAAkB;IAC5B,iDAA2B,CAAA;IAC3B,0DAA0D;IAC1D,iFAA2D,CAAA;IAC3D;;;;;;OAMG;IACH,2EAAqD,CAAA;IACrD,oCAAoC;IACpC,qFAA+D,CAAA;IAC/D,+CAA+C;IAC/C,+GAAyF,CAAA;IACzF,iDAAiD;IACjD,mHAA6F,CAAA;IAC7F,uBAAuB;IACvB,yDAAmC,CAAA;IACnC,yEAAyE;IACzE,qFAA+D,CAAA;AACjE,CAAC,EAtBW,kBAAkB,KAAlB,kBAAkB,QAsB7B;AAiMD,MAAM,CAAN,IAAY,aAwCX;AAxCD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B;;;OAGG;IACH,sCAAqB,CAAA;IACrB,iEAAiE;IACjE,8BAAa,CAAA;IACb,2IAA2I;IAC3I,0DAAyC,CAAA;IACzC,2GAA2G;IAC3G,kDAAiC,CAAA;IACjC;;;;;OAKG;IACH,oCAAmB,CAAA;IACnB,gJAAgJ;IAChJ,kDAAiC,CAAA;IACjC;;;;;;OAMG;IACH,sDAAqC,CAAA;IACrC;;;OAGG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,sCAAqB,CAAA;AACvB,CAAC,EAxCW,aAAa,KAAb,aAAa,QAwCxB;AAED,MAAM,CAAN,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IAC3B,6FAA6F;IAC7F,oDAA+B,CAAA;IAC/B;;;OAGG;IACH,4CAAuB,CAAA;IACvB,2DAA2D;IAC3D,gEAA2C,CAAA;AAC7C,CAAC,EAVW,iBAAiB,KAAjB,iBAAiB,QAU5B;AAmBD,MAAM,CAAN,IAAY,WAwBX;AAxBD,WAAY,WAAW;IACrB,uDAAuD;IACvD,0CAA2B,CAAA;IAC3B;;;;;OAKG;IACH,oCAAqB,CAAA;IACrB,kCAAkC;IAClC,oCAAqB,CAAA;IACrB;;;OAGG;IACH,kCAAmB,CAAA;IACnB;;;;;OAKG;IACH,oCAAqB,CAAA;AACvB,CAAC,EAxBW,WAAW,KAAX,WAAW,QAwBtB;AAyLD,MAAM,CAAN,IAAY,0BAKX;AALD,WAAY,0BAA0B;IACpC,0BAA0B;IAC1B,uEAAyC,CAAA;IACzC,0BAA0B;IAC1B,uEAAyC,CAAA;AAC3C,CAAC,EALW,0BAA0B,KAA1B,0BAA0B,QAKrC;AAibD,MAAM,CAAN,IAAY,YAoCX;AApCD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,yCAAyB,CAAA;IACzB,mDAAmC,CAAA;IACnC,2DAA2C,CAAA;IAC3C,iDAAiC,CAAA;IACjC,yDAAyC,CAAA;IACzC,+DAA+C,CAAA;IAC/C,iEAAiD,CAAA;IACjD,2DAA2C,CAAA;IAC3C,qFAAqE,CAAA;IACrE,+CAA+B,CAAA;IAC/B,mDAAmC,CAAA;IACnC,6CAA6B,CAAA;IAC7B,6DAA6C,CAAA;IAC7C,mEAAmD,CAAA;IACnD,6CAA6B,CAAA;IAC7B,mEAAmD,CAAA;IACnD,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,2EAA2D,CAAA;IAC3D,yEAAyD,CAAA;IACzD,6DAA6C,CAAA;IAC7C,2EAA2D,CAAA;IAC3D,6DAA6C,CAAA;IAC7C,qCAAqC;IACrC,mDAAmC,CAAA;IACnC,qCAAqC;IACrC,qDAAqC,CAAA;IACrC,qCAAqC;IACrC,qDAAqC,CAAA;IACrC,qCAAqC;IACrC,+CAA+B,CAAA;IAC/B,qCAAqC;IACrC,iDAAiC,CAAA;AACnC,CAAC,EApCW,YAAY,KAAZ,YAAY,QAoCvB;AAED,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,gDAA2B,CAAA;IAC3B,kDAA6B,CAAA;AAC/B,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AAkED,MAAM,CAAN,IAAY,WAiCX;AAjCD,WAAY,WAAW;IACrB,8DAA8D;IAC9D,0CAA2B,CAAA;IAC3B,oBAAoB;IACpB,0BAAW,CAAA;IACX,oFAAoF;IACpF,0BAAW,CAAA;IACX,yGAAyG;IACzG,4BAAa,CAAA;IACb,6GAA6G;IAC7G,gCAAiB,CAAA;IACjB,4BAA4B;IAC5B,gDAAiC,CAAA;IACjC,kFAAkF;IAClF,8CAA+B,CAAA;IAC/B,mRAAmR;IACnR,4CAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAA2C,CAAA;IAC3C,0BAA0B;IAC1B,4BAAa,CAAA;IACb,oIAAoI;IACpI,wCAAyB,CAAA;IACzB,8BAA8B;IAC9B,oCAAqB,CAAA;IACrB,gGAAgG;IAChG,oCAAqB,CAAA;IACrB,kHAAkH;IAClH,4BAAa,CAAA;IACb,sHAAsH;IACtH,gCAAiB,CAAA;IACjB,6IAA6I;IAC7I,sCAAuB,CAAA;AACzB,CAAC,EAjCW,WAAW,KAAX,WAAW,QAiCtB;AAiMD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAqPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Draft Order main entity.
|
|
4
|
+
* A temporary version of an order, allowing modifications before finalization.
|
|
5
|
+
*/
|
|
3
6
|
export interface DraftOrder {
|
|
4
7
|
/**
|
|
5
8
|
* Draft order ID.
|
|
@@ -617,6 +620,11 @@ export interface SubscriptionInfo {
|
|
|
617
620
|
* @immutable
|
|
618
621
|
*/
|
|
619
622
|
subscriptionSettings?: SubscriptionSettings;
|
|
623
|
+
/**
|
|
624
|
+
* Description of the charges that will be applied for subscription.
|
|
625
|
+
* @maxLength 1000
|
|
626
|
+
*/
|
|
627
|
+
chargesDescription?: string | null;
|
|
620
628
|
}
|
|
621
629
|
export interface SubscriptionTitle {
|
|
622
630
|
/**
|
|
@@ -754,6 +762,63 @@ export interface ExtendedFields {
|
|
|
754
762
|
*/
|
|
755
763
|
namespaces?: Record<string, Record<string, any>>;
|
|
756
764
|
}
|
|
765
|
+
export interface ModifierGroup {
|
|
766
|
+
/**
|
|
767
|
+
* Modifier group id.
|
|
768
|
+
* @minLength 1
|
|
769
|
+
* @maxLength 36
|
|
770
|
+
*/
|
|
771
|
+
_id?: string;
|
|
772
|
+
/** Modifier group name. */
|
|
773
|
+
name?: TranslatableString;
|
|
774
|
+
/**
|
|
775
|
+
* List of modifiers in this group.
|
|
776
|
+
* @minSize 1
|
|
777
|
+
* @maxSize 10
|
|
778
|
+
*/
|
|
779
|
+
modifiers?: ItemModifier[];
|
|
780
|
+
}
|
|
781
|
+
export interface TranslatableString {
|
|
782
|
+
/**
|
|
783
|
+
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
784
|
+
*
|
|
785
|
+
* Min: 1 character.
|
|
786
|
+
* Max: 200 characters.
|
|
787
|
+
* @minLength 1
|
|
788
|
+
* @maxLength 200
|
|
789
|
+
*/
|
|
790
|
+
original?: string;
|
|
791
|
+
/**
|
|
792
|
+
* String translated into the buyer's language.
|
|
793
|
+
*
|
|
794
|
+
* Min: 1 character.
|
|
795
|
+
* Max: 400 characters.
|
|
796
|
+
* Default: Same as `original`.
|
|
797
|
+
* @minLength 1
|
|
798
|
+
* @maxLength 400
|
|
799
|
+
*/
|
|
800
|
+
translated?: string | null;
|
|
801
|
+
}
|
|
802
|
+
export interface ItemModifier {
|
|
803
|
+
/**
|
|
804
|
+
* Modifier ID.
|
|
805
|
+
* @minLength 1
|
|
806
|
+
* @maxLength 36
|
|
807
|
+
*/
|
|
808
|
+
_id?: string;
|
|
809
|
+
/**
|
|
810
|
+
* The quantity of this modifier.
|
|
811
|
+
* @min 1
|
|
812
|
+
* @max 100000
|
|
813
|
+
*/
|
|
814
|
+
quantity?: number | null;
|
|
815
|
+
/** Primary display label for the modifier. */
|
|
816
|
+
label?: TranslatableString;
|
|
817
|
+
/** Optional additional details or clarification for the modifier. */
|
|
818
|
+
details?: TranslatableString;
|
|
819
|
+
/** The price of the modifier. */
|
|
820
|
+
price?: Price;
|
|
821
|
+
}
|
|
757
822
|
export interface ItemChangedDetails {
|
|
758
823
|
/**
|
|
759
824
|
* Line item quantity before change.
|
|
@@ -1091,7 +1156,7 @@ export interface AdditionalFeeDetails {
|
|
|
1091
1156
|
* Supported values:
|
|
1092
1157
|
* + `ORIGINAL_ORDER`: This additional fee is part of the original order.
|
|
1093
1158
|
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1094
|
-
* + `CUSTOM`: This additional fee was created by the
|
|
1159
|
+
* + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
|
|
1095
1160
|
*/
|
|
1096
1161
|
source?: SourceType;
|
|
1097
1162
|
/** Whether this additional fee is applied to the order. */
|
|
@@ -1161,7 +1226,7 @@ export interface DiscountDetails {
|
|
|
1161
1226
|
*
|
|
1162
1227
|
* Supported values:
|
|
1163
1228
|
* + `ORIGINAL_ORDER`: This discount is part of the original order.
|
|
1164
|
-
* + `CUSTOM`: This discount was created by the
|
|
1229
|
+
* + `CUSTOM`: This discount was created by the Create Custom Discounts method.
|
|
1165
1230
|
*/
|
|
1166
1231
|
source?: SourceType;
|
|
1167
1232
|
/** Whether this discount is applied to the order. */
|
|
@@ -1657,7 +1722,9 @@ export interface PickupDetails {
|
|
|
1657
1722
|
}
|
|
1658
1723
|
export declare enum PickupMethod {
|
|
1659
1724
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1725
|
+
/** Store pickup. */
|
|
1660
1726
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1727
|
+
/** Pickup point. */
|
|
1661
1728
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1662
1729
|
}
|
|
1663
1730
|
export interface DeliveryTimeSlot {
|
|
@@ -3736,12 +3803,126 @@ export declare enum WebhookIdentityType {
|
|
|
3736
3803
|
WIX_USER = "WIX_USER",
|
|
3737
3804
|
APP = "APP"
|
|
3738
3805
|
}
|
|
3806
|
+
export interface BaseEventMetadata {
|
|
3807
|
+
/**
|
|
3808
|
+
* App instance ID.
|
|
3809
|
+
* @format GUID
|
|
3810
|
+
*/
|
|
3811
|
+
instanceId?: string | null;
|
|
3812
|
+
/**
|
|
3813
|
+
* Event type.
|
|
3814
|
+
* @maxLength 150
|
|
3815
|
+
*/
|
|
3816
|
+
eventType?: string;
|
|
3817
|
+
/** The identification type and identity data. */
|
|
3818
|
+
identity?: IdentificationData;
|
|
3819
|
+
}
|
|
3820
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
3821
|
+
/**
|
|
3822
|
+
* Unique event ID.
|
|
3823
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3824
|
+
*/
|
|
3825
|
+
_id?: string;
|
|
3826
|
+
/**
|
|
3827
|
+
* Assumes actions are also always typed to an entity_type
|
|
3828
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3829
|
+
*/
|
|
3830
|
+
entityFqdn?: string;
|
|
3831
|
+
/**
|
|
3832
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3833
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3834
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3835
|
+
*/
|
|
3836
|
+
slug?: string;
|
|
3837
|
+
/** ID of the entity associated with the event. */
|
|
3838
|
+
entityId?: string;
|
|
3839
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3840
|
+
eventTime?: Date | null;
|
|
3841
|
+
/**
|
|
3842
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3843
|
+
* (for example, GDPR).
|
|
3844
|
+
*/
|
|
3845
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3846
|
+
/** If present, indicates the action that triggered the event. */
|
|
3847
|
+
originatedFrom?: string | null;
|
|
3848
|
+
/**
|
|
3849
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3850
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3851
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3852
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3853
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3854
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3855
|
+
*/
|
|
3856
|
+
entityEventSequence?: string | null;
|
|
3857
|
+
}
|
|
3858
|
+
export interface DraftOrderCreatedEnvelope {
|
|
3859
|
+
entity: DraftOrder;
|
|
3860
|
+
metadata: EventMetadata;
|
|
3861
|
+
}
|
|
3862
|
+
/**
|
|
3863
|
+
* Triggered when a draft order is created.
|
|
3864
|
+
* @permissionScope Manage Stores - all permissions
|
|
3865
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3866
|
+
* @permissionScope Manage Stores
|
|
3867
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3868
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3869
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3870
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3871
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3872
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
3873
|
+
* @webhook
|
|
3874
|
+
* @eventType wix.ecom.v1.draft_order_created
|
|
3875
|
+
* @slug created
|
|
3876
|
+
* @documentationMaturity preview
|
|
3877
|
+
*/
|
|
3878
|
+
export declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
3879
|
+
export interface DraftOrderDeletedEnvelope {
|
|
3880
|
+
metadata: EventMetadata;
|
|
3881
|
+
}
|
|
3882
|
+
/**
|
|
3883
|
+
* Triggered when a draft order is deleted.
|
|
3884
|
+
* @permissionScope Manage Stores - all permissions
|
|
3885
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3886
|
+
* @permissionScope Manage Stores
|
|
3887
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3888
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3889
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3890
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3891
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3892
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
3893
|
+
* @webhook
|
|
3894
|
+
* @eventType wix.ecom.v1.draft_order_deleted
|
|
3895
|
+
* @slug deleted
|
|
3896
|
+
* @documentationMaturity preview
|
|
3897
|
+
*/
|
|
3898
|
+
export declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
3899
|
+
export interface DraftOrderUpdatedEnvelope {
|
|
3900
|
+
entity: DraftOrder;
|
|
3901
|
+
metadata: EventMetadata;
|
|
3902
|
+
}
|
|
3903
|
+
/**
|
|
3904
|
+
* Triggered when a draft order is updated.
|
|
3905
|
+
* @permissionScope Manage Stores - all permissions
|
|
3906
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3907
|
+
* @permissionScope Manage Stores
|
|
3908
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3909
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3910
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3911
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3912
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3913
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
3914
|
+
* @webhook
|
|
3915
|
+
* @eventType wix.ecom.v1.draft_order_updated
|
|
3916
|
+
* @slug updated
|
|
3917
|
+
* @documentationMaturity preview
|
|
3918
|
+
*/
|
|
3919
|
+
export declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
3739
3920
|
type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `lineItems.${number}.changedDetails.priceBeforeChange.amount` | `lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `lineItems.${number}.removed` | `lineItems.${number}.lineItem._id` | `lineItems.${number}.lineItem.productName.original` | `lineItems.${number}.lineItem.catalogReference.catalogItemId` | `lineItems.${number}.lineItem.catalogReference.appId` | `lineItems.${number}.lineItem.quantity` | `lineItems.${number}.lineItem.physicalProperties.shippable` | `lineItems.${number}.lineItem.itemType.preset` | `lineItems.${number}.lineItem.itemType.custom` | `lineItems.${number}.lineItem.paymentOption` | `lineItems.${number}.lineItem.taxDetails.taxRate` | `lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `lineItems.${number}.lineItem.digitalFile.fileId` | `lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.lineItem.taxableAddress.addressType` | `shippingInfo.added` | `shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.amount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.formattedAmount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.taxDetails.taxRate` | `shippingInfo.removed` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.additionalFee.name` | `additionalFees.${number}.additionalFee.price.amount` | `additionalFees.${number}.additionalFee.price.formattedAmount` | `additionalFees.${number}.additionalFee.taxDetails.taxRate` | `additionalFees.${number}.additionalFee._id` | `additionalFees.${number}.taxDetails.taxable` | `additionalFees.${number}.source` | `additionalFees.${number}.applied` | `discounts` | `discounts.${number}.discount.coupon._id` | `discounts.${number}.discount.coupon.code` | `discounts.${number}.discount.coupon.name` | `discounts.${number}.discount.coupon.amount.amount` | `discounts.${number}.discount.coupon.amount.formattedAmount` | `discounts.${number}.discount.merchantDiscount.discountReason` | `discounts.${number}.discount.discountRule._id` | `discounts.${number}.discount.discountRule.name.original` | `discounts.${number}.discount.discountType` | `discounts.${number}.source` | `discounts.${number}.applied` | `createdBy.userId` | `createdBy.appId` | `status` | `weightUnit` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `commitSettings.updateInventory` | `commitSettings.updateInventory.${number}.lineItemId` | `recipientInfo.added` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.number` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.name` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId._id` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId.type` | `recipientInfo.removed` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `buyerDetails.added` | `buyerDetails.changedDetails.buyerInfoBeforeChange.visitorId` | `buyerDetails.changedDetails.buyerInfoBeforeChange.memberId` | `buyerDetails.removed` | `billingDetails.added` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.number` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.name` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId._id` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId.type` | `billingDetails.removed` | `businessLocationDetails.added` | `businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `businessLocationDetails.removed`;
|
|
3740
3921
|
/**
|
|
3741
|
-
* Creates or
|
|
3922
|
+
* Creates or retrieves a draft order based on the specified order ID.
|
|
3742
3923
|
*
|
|
3743
|
-
* When passing the ID of an order that is already in draft, the existing draft order
|
|
3744
|
-
* To complete a draft and update the order, call Commit Draft Order
|
|
3924
|
+
* When passing the ID of an order that is already in draft, the existing draft order is returned.
|
|
3925
|
+
* To complete a draft and update the original order, call Commit Draft Order.
|
|
3745
3926
|
* @param orderId - ID of the order to create a draft for.
|
|
3746
3927
|
* @public
|
|
3747
3928
|
* @documentationMaturity preview
|
|
@@ -3751,6 +3932,8 @@ type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `l
|
|
|
3751
3932
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3752
3933
|
* @permissionScope Manage Stores - all permissions
|
|
3753
3934
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3935
|
+
* @permissionScope Manage Stores
|
|
3936
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3754
3937
|
* @permissionScope Manage Restaurants - all permissions
|
|
3755
3938
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3756
3939
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3763,6 +3946,8 @@ export declare function createDraftOrder(orderId: string): Promise<NonNullablePa
|
|
|
3763
3946
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3764
3947
|
/**
|
|
3765
3948
|
* Creates an empty draft order.
|
|
3949
|
+
*
|
|
3950
|
+
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
3766
3951
|
* @public
|
|
3767
3952
|
* @documentationMaturity preview
|
|
3768
3953
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
@@ -3770,6 +3955,8 @@ export declare function createDraftOrder(orderId: string): Promise<NonNullablePa
|
|
|
3770
3955
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3771
3956
|
* @permissionScope Manage Stores - all permissions
|
|
3772
3957
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3958
|
+
* @permissionScope Manage Stores
|
|
3959
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3773
3960
|
* @permissionScope Manage Restaurants - all permissions
|
|
3774
3961
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3775
3962
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3790,6 +3977,8 @@ export declare function createEmptyDraftOrder(): Promise<NonNullablePaths<Create
|
|
|
3790
3977
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
3791
3978
|
* @permissionScope Manage Stores - all permissions
|
|
3792
3979
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3980
|
+
* @permissionScope Manage Stores
|
|
3981
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3793
3982
|
* @permissionScope Manage Restaurants - all permissions
|
|
3794
3983
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3795
3984
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3817,11 +4006,11 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3817
4006
|
/**
|
|
3818
4007
|
* Updates a draft order's line items.
|
|
3819
4008
|
*
|
|
3820
|
-
*
|
|
4009
|
+
* You can update a line item's quantity, price, and description.
|
|
3821
4010
|
* > **Notes:**
|
|
3822
|
-
* > +
|
|
4011
|
+
* > + Specifying a quantity of `0` will remove the line item.
|
|
3823
4012
|
* > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
|
|
3824
|
-
* > + Quantity cannot be decreased fulfilled line items. To
|
|
4013
|
+
* > + Quantity cannot be decreased for fulfilled line items. To retrieve fulfillment information, specify the order ID when calling List Fulfillments For Single Order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-fulfillments/list-fulfillments-for-single-order) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order)).
|
|
3825
4014
|
* @param draftOrderId - Draft order ID.
|
|
3826
4015
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
3827
4016
|
* @public
|
|
@@ -3832,6 +4021,8 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3832
4021
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
3833
4022
|
* @permissionScope Manage Stores - all permissions
|
|
3834
4023
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4024
|
+
* @permissionScope Manage Stores
|
|
4025
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3835
4026
|
* @permissionScope Manage Restaurants - all permissions
|
|
3836
4027
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3837
4028
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3860,6 +4051,8 @@ export declare function updateLineItems(draftOrderId: string, lineItemChanges: N
|
|
|
3860
4051
|
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
3861
4052
|
* @permissionScope Manage Stores - all permissions
|
|
3862
4053
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4054
|
+
* @permissionScope Manage Stores
|
|
4055
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3863
4056
|
* @permissionScope Manage Restaurants - all permissions
|
|
3864
4057
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3865
4058
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3874,7 +4067,7 @@ export declare function setDiscounts(draftOrderId: string, discounts: NonNullabl
|
|
|
3874
4067
|
* Creates custom discounts.
|
|
3875
4068
|
*
|
|
3876
4069
|
* Newly created discounts are unapplied by default.
|
|
3877
|
-
* To apply them, use Set Discounts
|
|
4070
|
+
* To apply them, use Set Discounts.
|
|
3878
4071
|
* @param draftOrderId - Draft order ID.
|
|
3879
4072
|
* @public
|
|
3880
4073
|
* @documentationMaturity preview
|
|
@@ -3885,6 +4078,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: NonNullabl
|
|
|
3885
4078
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
3886
4079
|
* @permissionScope Manage Stores - all permissions
|
|
3887
4080
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4081
|
+
* @permissionScope Manage Stores
|
|
4082
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3888
4083
|
* @permissionScope Manage Restaurants - all permissions
|
|
3889
4084
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3890
4085
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3916,6 +4111,8 @@ export interface CreateCustomDiscountsOptions {
|
|
|
3916
4111
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
3917
4112
|
* @permissionScope Manage Stores - all permissions
|
|
3918
4113
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4114
|
+
* @permissionScope Manage Stores
|
|
4115
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3919
4116
|
* @permissionScope Manage Restaurants - all permissions
|
|
3920
4117
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3921
4118
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3944,6 +4141,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
3944
4141
|
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
3945
4142
|
* @permissionScope Manage Stores - all permissions
|
|
3946
4143
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4144
|
+
* @permissionScope Manage Stores
|
|
4145
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3947
4146
|
* @permissionScope Manage Restaurants - all permissions
|
|
3948
4147
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3949
4148
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3958,7 +4157,7 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
3958
4157
|
* Creates custom additional fees on a draft order.
|
|
3959
4158
|
*
|
|
3960
4159
|
* Newly created additional fees are not applied by default.
|
|
3961
|
-
* To apply them, use Set Additional Fees
|
|
4160
|
+
* To apply them, use Set Additional Fees.
|
|
3962
4161
|
* @param draftOrderId - Draft order ID.
|
|
3963
4162
|
* @public
|
|
3964
4163
|
* @documentationMaturity preview
|
|
@@ -3969,6 +4168,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
3969
4168
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
3970
4169
|
* @permissionScope Manage Stores - all permissions
|
|
3971
4170
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4171
|
+
* @permissionScope Manage Stores
|
|
4172
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3972
4173
|
* @permissionScope Manage Restaurants - all permissions
|
|
3973
4174
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3974
4175
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4000,6 +4201,8 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
4000
4201
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4001
4202
|
* @permissionScope Manage Stores - all permissions
|
|
4002
4203
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4204
|
+
* @permissionScope Manage Stores
|
|
4205
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4003
4206
|
* @permissionScope Manage Restaurants - all permissions
|
|
4004
4207
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4005
4208
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4019,6 +4222,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
4019
4222
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4020
4223
|
* @permissionScope Manage Stores - all permissions
|
|
4021
4224
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4225
|
+
* @permissionScope Manage Stores
|
|
4226
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4022
4227
|
* @permissionScope Manage Restaurants - all permissions
|
|
4023
4228
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4024
4229
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4046,6 +4251,8 @@ export interface SetShippingInfoOptions {
|
|
|
4046
4251
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4047
4252
|
* @permissionScope Manage Stores - all permissions
|
|
4048
4253
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4254
|
+
* @permissionScope Manage Stores
|
|
4255
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4049
4256
|
* @permissionScope Manage Restaurants - all permissions
|
|
4050
4257
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4051
4258
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4073,6 +4280,8 @@ export interface SetBuyerInfoOptions {
|
|
|
4073
4280
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4074
4281
|
* @permissionScope Manage Stores - all permissions
|
|
4075
4282
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4283
|
+
* @permissionScope Manage Stores
|
|
4284
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4076
4285
|
* @permissionScope Manage Restaurants - all permissions
|
|
4077
4286
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4078
4287
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4100,6 +4309,8 @@ export interface SetRecipientInfoOptions {
|
|
|
4100
4309
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4101
4310
|
* @permissionScope Manage Stores - all permissions
|
|
4102
4311
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4312
|
+
* @permissionScope Manage Stores
|
|
4313
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4103
4314
|
* @permissionScope Manage Restaurants - all permissions
|
|
4104
4315
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4105
4316
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4135,6 +4346,8 @@ export interface SetBillingInfoOptions {
|
|
|
4135
4346
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4136
4347
|
* @permissionScope Manage Stores - all permissions
|
|
4137
4348
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4349
|
+
* @permissionScope Manage Stores
|
|
4350
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4138
4351
|
* @permissionScope Manage Restaurants - all permissions
|
|
4139
4352
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4140
4353
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4154,6 +4367,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<NonNullable
|
|
|
4154
4367
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4155
4368
|
* @permissionScope Manage Stores - all permissions
|
|
4156
4369
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4370
|
+
* @permissionScope Manage Stores
|
|
4371
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4157
4372
|
* @permissionScope Manage Restaurants - all permissions
|
|
4158
4373
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4159
4374
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4178,6 +4393,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Non
|
|
|
4178
4393
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4179
4394
|
* @permissionScope Manage Stores - all permissions
|
|
4180
4395
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4396
|
+
* @permissionScope Manage Stores
|
|
4397
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4181
4398
|
* @permissionScope Manage Restaurants - all permissions
|
|
4182
4399
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4183
4400
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4212,6 +4429,8 @@ export interface CommitDraftOrderOptions {
|
|
|
4212
4429
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4213
4430
|
* @permissionScope Manage Stores - all permissions
|
|
4214
4431
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4432
|
+
* @permissionScope Manage Stores
|
|
4433
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4215
4434
|
* @permissionScope Manage Restaurants - all permissions
|
|
4216
4435
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4217
4436
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4245,6 +4464,8 @@ export interface CreateOrderFromDraftOptions {
|
|
|
4245
4464
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4246
4465
|
* @permissionScope Manage Stores - all permissions
|
|
4247
4466
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4467
|
+
* @permissionScope Manage Stores
|
|
4468
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4248
4469
|
* @permissionScope Manage Restaurants - all permissions
|
|
4249
4470
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4250
4471
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4269,6 +4490,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
|
|
|
4269
4490
|
* @documentationMaturity preview
|
|
4270
4491
|
* @permissionScope Manage Stores - all permissions
|
|
4271
4492
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4493
|
+
* @permissionScope Manage Stores
|
|
4494
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4272
4495
|
* @permissionScope Manage Restaurants - all permissions
|
|
4273
4496
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4274
4497
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4369,12 +4592,16 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4369
4592
|
* @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4370
4593
|
* @permissionScope Manage Stores - all permissions
|
|
4371
4594
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4595
|
+
* @permissionScope Manage Stores
|
|
4596
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4372
4597
|
* @permissionScope Manage Restaurants - all permissions
|
|
4373
4598
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4374
4599
|
* @permissionScope Manage eCommerce - all permissions
|
|
4375
4600
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4376
4601
|
* @permissionScope Manage Stores - all permissions
|
|
4377
4602
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4603
|
+
* @permissionScope Manage Stores
|
|
4604
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4378
4605
|
* @permissionScope Manage Restaurants - all permissions
|
|
4379
4606
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4380
4607
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4404,6 +4631,8 @@ export interface UpdateExtendedFieldsOptions {
|
|
|
4404
4631
|
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4405
4632
|
* @permissionScope Manage Stores - all permissions
|
|
4406
4633
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4634
|
+
* @permissionScope Manage Stores
|
|
4635
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4407
4636
|
* @permissionScope Manage Restaurants - all permissions
|
|
4408
4637
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4409
4638
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4434,6 +4663,8 @@ export interface SetTaxExemptionOptions {
|
|
|
4434
4663
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4435
4664
|
* @permissionScope Manage Stores - all permissions
|
|
4436
4665
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4666
|
+
* @permissionScope Manage Stores
|
|
4667
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4437
4668
|
* @permissionScope Manage Restaurants - all permissions
|
|
4438
4669
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4439
4670
|
* @permissionScope Manage eCommerce - all permissions
|