@wix/ecom 1.0.506 → 1.0.508
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-order.context.d.ts +1 -2
- package/build/cjs/src/ecom-v1-order.context.js +1 -12
- package/build/cjs/src/ecom-v1-order.context.js.map +1 -1
- package/build/cjs/src/ecom-v1-order.http.d.ts +1 -2
- package/build/cjs/src/ecom-v1-order.http.js +1 -89
- package/build/cjs/src/ecom-v1-order.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-order.meta.d.ts +0 -1
- package/build/cjs/src/ecom-v1-order.meta.js +1 -20
- package/build/cjs/src/ecom-v1-order.meta.js.map +1 -1
- package/build/cjs/src/ecom-v1-order.public.d.ts +57 -4
- package/build/cjs/src/ecom-v1-order.public.js +2 -7
- package/build/cjs/src/ecom-v1-order.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-order.types.d.ts +163 -548
- package/build/cjs/src/ecom-v1-order.types.js +11 -1
- package/build/cjs/src/ecom-v1-order.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-order.universal.d.ts +174 -312
- package/build/cjs/src/ecom-v1-order.universal.js +12 -86
- package/build/cjs/src/ecom-v1-order.universal.js.map +1 -1
- package/build/es/src/ecom-v1-order.context.d.ts +1 -2
- package/build/es/src/ecom-v1-order.context.js +1 -11
- package/build/es/src/ecom-v1-order.context.js.map +1 -1
- package/build/es/src/ecom-v1-order.http.d.ts +1 -2
- package/build/es/src/ecom-v1-order.http.js +0 -87
- package/build/es/src/ecom-v1-order.http.js.map +1 -1
- package/build/es/src/ecom-v1-order.meta.d.ts +0 -1
- package/build/es/src/ecom-v1-order.meta.js +0 -18
- package/build/es/src/ecom-v1-order.meta.js.map +1 -1
- package/build/es/src/ecom-v1-order.public.d.ts +57 -4
- package/build/es/src/ecom-v1-order.public.js +2 -7
- package/build/es/src/ecom-v1-order.public.js.map +1 -1
- package/build/es/src/ecom-v1-order.types.d.ts +163 -548
- package/build/es/src/ecom-v1-order.types.js +10 -0
- package/build/es/src/ecom-v1-order.types.js.map +1 -1
- package/build/es/src/ecom-v1-order.universal.d.ts +174 -312
- package/build/es/src/ecom-v1-order.universal.js +11 -84
- package/build/es/src/ecom-v1-order.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -93,6 +93,16 @@ export var OrderStatus;
|
|
|
93
93
|
OrderStatus["APPROVED"] = "APPROVED";
|
|
94
94
|
OrderStatus["CANCELED"] = "CANCELED";
|
|
95
95
|
})(OrderStatus || (OrderStatus = {}));
|
|
96
|
+
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
97
|
+
export var JurisdictionType;
|
|
98
|
+
(function (JurisdictionType) {
|
|
99
|
+
JurisdictionType["UNDEFINED"] = "UNDEFINED";
|
|
100
|
+
JurisdictionType["COUNTRY"] = "COUNTRY";
|
|
101
|
+
JurisdictionType["STATE"] = "STATE";
|
|
102
|
+
JurisdictionType["COUNTY"] = "COUNTY";
|
|
103
|
+
JurisdictionType["CITY"] = "CITY";
|
|
104
|
+
JurisdictionType["SPECIAL"] = "SPECIAL";
|
|
105
|
+
})(JurisdictionType || (JurisdictionType = {}));
|
|
96
106
|
export var DiscountType;
|
|
97
107
|
(function (DiscountType) {
|
|
98
108
|
DiscountType["GLOBAL"] = "GLOBAL";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-v1-order.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-order.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ecom-v1-order.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-order.types.ts"],"names":[],"mappings":"AAsUA,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,oDAA6B,CAAA;IAC7B,gDAAyB,CAAA;IACzB,sCAAe,CAAA;AACjB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAkDD,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,0IAA0I;IAC1I,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AA+CD,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;AA0CD,MAAM,CAAN,IAAY,aAcX;AAdD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,oBAAoB;IACpB,8BAAa,CAAA;IACb,oEAAoE;IACpE,0DAAyC,CAAA;IACzC,0CAA0C;IAC1C,kDAAiC,CAAA;IACjC,sEAAsE;IACtE,oCAAmB,CAAA;IACnB,4FAA4F;IAC5F,kDAAiC,CAAA;AACnC,CAAC,EAdW,aAAa,KAAb,aAAa,QAcxB;AAED,MAAM,CAAN,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IAC3B,wFAAwF;IACxF,oDAA+B,CAAA;IAC/B;;;OAGG;IACH,4CAAuB,CAAA;IACvB,yDAAyD;IACzD,gEAA2C,CAAA;AAC7C,CAAC,EAVW,iBAAiB,KAAjB,iBAAiB,QAU5B;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,gBAAgB;IAChB,uBAAS,CAAA;IACT,aAAa;IACb,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AA8FD,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;AA8ED,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAoCD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,0CAA2B,CAAA;IAC3B,oCAAqB,CAAA;IACrB,oCAAqB,CAAA;AACvB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAoCD,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;AAgCD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,iDAAiC,CAAA;IACjC,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAsCD,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,qDAAmC,CAAA;AACrC,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAuJD,MAAM,CAAN,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,uEAAyC,CAAA;IACzC,uEAAyC,CAAA;AAC3C,CAAC,EAHW,0BAA0B,KAA1B,0BAA0B,QAGrC;AA+DD,MAAM,CAAN,IAAY,YAyBX;AAzBD,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;AAC7D,CAAC,EAzBW,YAAY,KAAZ,YAAY,QAyBvB;AAED,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,gDAA2B,CAAA;IAC3B,kDAA6B,CAAA;AAC/B,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AAwCD,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,0CAA2B,CAAA;IAC3B,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,gDAAiC,CAAA;IACjC,8CAA+B,CAAA;IAC/B,4CAA6B,CAAA;IAC7B,0DAA2C,CAAA;IAC3C,4BAAa,CAAA;IACb,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;AACvB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AA2SD;;;GAGG;AACH,MAAM,CAAN,IAAY,KAUX;AAVD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,kCAAkC;IAClC,4BAAmB,CAAA;IACnB,oEAAoE;IACpE,8BAAqB,CAAA;IACrB,4GAA4G;IAC5G,8BAAqB,CAAA;IACrB,2GAA2G;IAC3G,4BAAmB,CAAA;AACrB,CAAC,EAVW,KAAK,KAAL,KAAK,QAUhB;AAED,MAAM,CAAN,IAAY,SA2DX;AA3DD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;AACjC,CAAC,EA3DW,SAAS,KAAT,SAAS,QA2DpB;AA0JD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAgID,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,0DAAqC,CAAA;IACrC,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,8DAAyC,CAAA;IACzC,8CAAyB,CAAA;IACzB,sCAAiB,CAAA;AACnB,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAkCD,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,oCAAoC;IACpC,8CAAmB,CAAA;IACnB,yGAAyG;IACzG,0DAA+B,CAAA;AACjC,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAyCD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACnB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAwGD,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,0DAA0D;IAC1D,qCAAmB,CAAA;IACnB,uDAAuD;IACvD,+CAA6B,CAAA;IAC7B,8DAA8D;IAC9D,uDAAqC,CAAA;AACvC,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAwKD,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,qDAAiC,CAAA;IACjC,mDAA+B,CAAA;IAC/B,qEAAiD,CAAA;AACnD,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAsGD,MAAM,CAAN,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,kDAAmB,CAAA;IACnB,0DAA2B,CAAA;IAC3B,sGAAuE,CAAA;IACvE,4FAA6D,CAAA;IAC7D,8GAA+E,CAAA;AACjF,CAAC,EANW,2BAA2B,KAA3B,2BAA2B,QAMtC;AAkHD,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,qDAAiC,CAAA;IACjC,qCAAiB,CAAA;IACjB,6CAAyB,CAAA;AAC3B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,4DAAqC,CAAA;IACrC,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;IACjC,4CAAqB,CAAA;IACrB,sDAA+B,CAAA;IAC/B,gDAAyB,CAAA;IACzB,oEAA6C,CAAA;IAC7C,wDAAiC,CAAA;IACjC,8CAAuB,CAAA;IACvB,sEAA+C,CAAA;AACjD,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED,MAAM,CAAN,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,2DAA+B,CAAA;IAC/B,+CAAmB,CAAA;AACrB,CAAC,EAJW,wBAAwB,KAAxB,wBAAwB,QAInC;AA4GD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,wCAAyB,CAAA;AAC3B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAyVD,uDAAuD;AACvD,MAAM,CAAN,IAAY,sBAUX;AAVD,WAAY,sBAAsB;IAChC,iBAAiB;IACjB,2EAAiD,CAAA;IACjD,wEAAwE;IACxE,uEAA6C,CAAA;IAC7C;;;OAGG;IACH,mEAAyC,CAAA;AAC3C,CAAC,EAVW,sBAAsB,KAAtB,sBAAsB,QAUjC;AA2DD,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wBAAwB;IACxB,sCAAmB,CAAA;IACnB,iEAAiE;IACjE,wCAAqB,CAAA;AACvB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AA41BD,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AA4CD,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAyDD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,6BAAe,CAAA;IACf,6BAAe,CAAA;AACjB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAmHD,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,6EAAyD,CAAA;IACzD,yDAAqC,CAAA;IACrC,yDAAqC,CAAA;IACrC,yCAAqB,CAAA;IACrB,qCAAiB,CAAA;IACjB,mCAAe,CAAA;AACjB,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AAOD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,sDAAyC,CAAA;IACzC,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;AACnB,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAeD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,wCAAyB,CAAA;AAC3B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,0CAAyB,CAAA;IACzB,8BAAa,CAAA;IACb,oCAAmB,CAAA;IACnB,8BAAa,CAAA;IACb,oCAAmB,CAAA;IACnB,gDAA+B,CAAA;IAC/B,wDAAuC,CAAA;AACzC,CAAC,EAVW,aAAa,KAAb,aAAa,QAUxB"}
|
|
@@ -102,6 +102,11 @@ export interface Order {
|
|
|
102
102
|
checkoutId?: string | null;
|
|
103
103
|
/** Custom fields. */
|
|
104
104
|
customFields?: CustomField[];
|
|
105
|
+
/**
|
|
106
|
+
* Order balance summary.
|
|
107
|
+
* @readonly
|
|
108
|
+
*/
|
|
109
|
+
balanceSummary?: BalanceSummary;
|
|
105
110
|
/** Additional fees applied to the order. */
|
|
106
111
|
additionalFees?: AdditionalFee[];
|
|
107
112
|
/**
|
|
@@ -156,6 +161,11 @@ export interface OrderLineItem {
|
|
|
156
161
|
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
|
|
157
162
|
*/
|
|
158
163
|
fulfillerId?: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* Number of items that was already refunded
|
|
166
|
+
* @readonly
|
|
167
|
+
*/
|
|
168
|
+
refundQuantity?: number | null;
|
|
159
169
|
/**
|
|
160
170
|
* quantity of inventory requested to be returned. Whether to restock or ignore the request is up the vertical.
|
|
161
171
|
* @readonly
|
|
@@ -197,6 +207,8 @@ export interface OrderLineItem {
|
|
|
197
207
|
* @readonly
|
|
198
208
|
*/
|
|
199
209
|
depositAmount?: Price;
|
|
210
|
+
/** Total price **after** catalog-defined discount and line item discounts. */
|
|
211
|
+
lineItemPrice?: Price;
|
|
200
212
|
}
|
|
201
213
|
export interface ProductName {
|
|
202
214
|
/**
|
|
@@ -378,6 +390,8 @@ export interface SubscriptionInfo {
|
|
|
378
390
|
export interface SubscriptionSettings {
|
|
379
391
|
/** Frequency of recurring payment. */
|
|
380
392
|
frequency?: SubscriptionFrequency;
|
|
393
|
+
/** Interval of recurring payment */
|
|
394
|
+
interval?: number | null;
|
|
381
395
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
382
396
|
autoRenewal?: boolean;
|
|
383
397
|
/** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
|
|
@@ -653,6 +667,39 @@ export interface TaxSummary {
|
|
|
653
667
|
*/
|
|
654
668
|
totalTax?: Price;
|
|
655
669
|
}
|
|
670
|
+
export interface OrderTaxInfo {
|
|
671
|
+
/** Calculated tax, added from line items. */
|
|
672
|
+
totalTax?: Price;
|
|
673
|
+
/** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
|
|
674
|
+
taxBreakdown?: OrderTaxBreakdown[];
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
678
|
+
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
679
|
+
*/
|
|
680
|
+
export interface OrderTaxBreakdown {
|
|
681
|
+
/** The name of the tax against which this tax amount was calculated. */
|
|
682
|
+
taxName?: string;
|
|
683
|
+
/** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
|
|
684
|
+
taxType?: string;
|
|
685
|
+
/** The name of the jurisdiction in which this tax detail applies. */
|
|
686
|
+
jurisdiction?: string;
|
|
687
|
+
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
688
|
+
jurisdictionType?: JurisdictionType;
|
|
689
|
+
/** The rate at which this tax detail was calculated. */
|
|
690
|
+
rate?: string;
|
|
691
|
+
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
692
|
+
aggregatedTaxAmount?: Price;
|
|
693
|
+
}
|
|
694
|
+
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
695
|
+
export declare enum JurisdictionType {
|
|
696
|
+
UNDEFINED = "UNDEFINED",
|
|
697
|
+
COUNTRY = "COUNTRY",
|
|
698
|
+
STATE = "STATE",
|
|
699
|
+
COUNTY = "COUNTY",
|
|
700
|
+
CITY = "CITY",
|
|
701
|
+
SPECIAL = "SPECIAL"
|
|
702
|
+
}
|
|
656
703
|
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
657
704
|
/** Applied coupon info. */
|
|
658
705
|
coupon?: Coupon;
|
|
@@ -1014,6 +1061,17 @@ export interface BalanceSummary {
|
|
|
1014
1061
|
* @readonly
|
|
1015
1062
|
*/
|
|
1016
1063
|
balance?: Balance;
|
|
1064
|
+
/**
|
|
1065
|
+
* Sum of all historically approved (succeeded) payments
|
|
1066
|
+
* including those which had been subsequently refunded or partially refunded
|
|
1067
|
+
* @readonly
|
|
1068
|
+
*/
|
|
1069
|
+
paid?: Price;
|
|
1070
|
+
/**
|
|
1071
|
+
* Sum of all refunded payments ( with status success )
|
|
1072
|
+
* @readonly
|
|
1073
|
+
*/
|
|
1074
|
+
refunded?: Price;
|
|
1017
1075
|
}
|
|
1018
1076
|
/**
|
|
1019
1077
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -2430,7 +2488,7 @@ export interface UpdateOrderResponse {
|
|
|
2430
2488
|
}
|
|
2431
2489
|
export interface BulkUpdateOrderRequest {
|
|
2432
2490
|
/** Orders to be updated. */
|
|
2433
|
-
orders
|
|
2491
|
+
orders?: MaskedOrder[];
|
|
2434
2492
|
/** Set to `true` if you wish to receive back the updated orders in the response */
|
|
2435
2493
|
returnEntity?: boolean;
|
|
2436
2494
|
}
|
|
@@ -2439,7 +2497,9 @@ export interface MaskedOrder {
|
|
|
2439
2497
|
order?: Order;
|
|
2440
2498
|
}
|
|
2441
2499
|
export interface BulkUpdateOrderResponse {
|
|
2500
|
+
/** Bulk action results. */
|
|
2442
2501
|
results?: BulkOrderResult[];
|
|
2502
|
+
/** Bulk action metadata. */
|
|
2443
2503
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2444
2504
|
}
|
|
2445
2505
|
export interface CommitDeltasRequest {
|
|
@@ -2553,6 +2613,8 @@ export interface OrderLineItemChangedDetails {
|
|
|
2553
2613
|
taxDetails?: ItemTaxFullDetails;
|
|
2554
2614
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2555
2615
|
priceDescription?: PriceDescription;
|
|
2616
|
+
/** Total price **after** catalog-defined discount and line item discounts. */
|
|
2617
|
+
lineItemPrice?: Price;
|
|
2556
2618
|
/** Total price after all discounts excluding tax. */
|
|
2557
2619
|
totalPriceBeforeTax?: Price;
|
|
2558
2620
|
}
|
|
@@ -3238,6 +3300,21 @@ export interface RestockItem {
|
|
|
3238
3300
|
/** Line item quantity being restocked. */
|
|
3239
3301
|
quantity?: number;
|
|
3240
3302
|
}
|
|
3303
|
+
export interface BulkUpdateOrderTagsRequest {
|
|
3304
|
+
/** IDs of orders to update tags for. */
|
|
3305
|
+
orderIds?: string[];
|
|
3306
|
+
/** Tags to be added to orders */
|
|
3307
|
+
assignTags?: Tags;
|
|
3308
|
+
/** Tags to be removed from orders */
|
|
3309
|
+
unassignTags?: Tags;
|
|
3310
|
+
}
|
|
3311
|
+
export interface BulkUpdateOrderTagsResponse {
|
|
3312
|
+
results?: BulkUpdateOrderTagsResult[];
|
|
3313
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3314
|
+
}
|
|
3315
|
+
export interface BulkUpdateOrderTagsResult {
|
|
3316
|
+
itemMetadata?: ItemMetadata;
|
|
3317
|
+
}
|
|
3241
3318
|
/** Triggered when the the order status changes to approved */
|
|
3242
3319
|
export interface OrderApproved {
|
|
3243
3320
|
/** The order that was updated */
|
|
@@ -3725,6 +3802,10 @@ export interface GetOrderResponseNonNullableFields {
|
|
|
3725
3802
|
amount: string;
|
|
3726
3803
|
formattedAmount: string;
|
|
3727
3804
|
};
|
|
3805
|
+
lineItemPrice?: {
|
|
3806
|
+
amount: string;
|
|
3807
|
+
formattedAmount: string;
|
|
3808
|
+
};
|
|
3728
3809
|
}[];
|
|
3729
3810
|
buyerInfo?: {
|
|
3730
3811
|
visitorId: string;
|
|
@@ -3881,6 +3962,20 @@ export interface GetOrderResponseNonNullableFields {
|
|
|
3881
3962
|
customFields: {
|
|
3882
3963
|
title: string;
|
|
3883
3964
|
}[];
|
|
3965
|
+
balanceSummary?: {
|
|
3966
|
+
balance?: {
|
|
3967
|
+
amount: string;
|
|
3968
|
+
formattedAmount: string;
|
|
3969
|
+
};
|
|
3970
|
+
paid?: {
|
|
3971
|
+
amount: string;
|
|
3972
|
+
formattedAmount: string;
|
|
3973
|
+
};
|
|
3974
|
+
refunded?: {
|
|
3975
|
+
amount: string;
|
|
3976
|
+
formattedAmount: string;
|
|
3977
|
+
};
|
|
3978
|
+
};
|
|
3884
3979
|
additionalFees: {
|
|
3885
3980
|
name: string;
|
|
3886
3981
|
price?: {
|
|
@@ -4002,6 +4097,10 @@ export interface SearchOrdersResponseNonNullableFields {
|
|
|
4002
4097
|
amount: string;
|
|
4003
4098
|
formattedAmount: string;
|
|
4004
4099
|
};
|
|
4100
|
+
lineItemPrice?: {
|
|
4101
|
+
amount: string;
|
|
4102
|
+
formattedAmount: string;
|
|
4103
|
+
};
|
|
4005
4104
|
}[];
|
|
4006
4105
|
buyerInfo?: {
|
|
4007
4106
|
visitorId: string;
|
|
@@ -4158,6 +4257,20 @@ export interface SearchOrdersResponseNonNullableFields {
|
|
|
4158
4257
|
customFields: {
|
|
4159
4258
|
title: string;
|
|
4160
4259
|
}[];
|
|
4260
|
+
balanceSummary?: {
|
|
4261
|
+
balance?: {
|
|
4262
|
+
amount: string;
|
|
4263
|
+
formattedAmount: string;
|
|
4264
|
+
};
|
|
4265
|
+
paid?: {
|
|
4266
|
+
amount: string;
|
|
4267
|
+
formattedAmount: string;
|
|
4268
|
+
};
|
|
4269
|
+
refunded?: {
|
|
4270
|
+
amount: string;
|
|
4271
|
+
formattedAmount: string;
|
|
4272
|
+
};
|
|
4273
|
+
};
|
|
4161
4274
|
additionalFees: {
|
|
4162
4275
|
name: string;
|
|
4163
4276
|
price?: {
|
|
@@ -4279,6 +4392,10 @@ export interface CreateOrderResponseNonNullableFields {
|
|
|
4279
4392
|
amount: string;
|
|
4280
4393
|
formattedAmount: string;
|
|
4281
4394
|
};
|
|
4395
|
+
lineItemPrice?: {
|
|
4396
|
+
amount: string;
|
|
4397
|
+
formattedAmount: string;
|
|
4398
|
+
};
|
|
4282
4399
|
}[];
|
|
4283
4400
|
buyerInfo?: {
|
|
4284
4401
|
visitorId: string;
|
|
@@ -4435,6 +4552,20 @@ export interface CreateOrderResponseNonNullableFields {
|
|
|
4435
4552
|
customFields: {
|
|
4436
4553
|
title: string;
|
|
4437
4554
|
}[];
|
|
4555
|
+
balanceSummary?: {
|
|
4556
|
+
balance?: {
|
|
4557
|
+
amount: string;
|
|
4558
|
+
formattedAmount: string;
|
|
4559
|
+
};
|
|
4560
|
+
paid?: {
|
|
4561
|
+
amount: string;
|
|
4562
|
+
formattedAmount: string;
|
|
4563
|
+
};
|
|
4564
|
+
refunded?: {
|
|
4565
|
+
amount: string;
|
|
4566
|
+
formattedAmount: string;
|
|
4567
|
+
};
|
|
4568
|
+
};
|
|
4438
4569
|
additionalFees: {
|
|
4439
4570
|
name: string;
|
|
4440
4571
|
price?: {
|
|
@@ -4556,6 +4687,10 @@ export interface UpdateOrderResponseNonNullableFields {
|
|
|
4556
4687
|
amount: string;
|
|
4557
4688
|
formattedAmount: string;
|
|
4558
4689
|
};
|
|
4690
|
+
lineItemPrice?: {
|
|
4691
|
+
amount: string;
|
|
4692
|
+
formattedAmount: string;
|
|
4693
|
+
};
|
|
4559
4694
|
}[];
|
|
4560
4695
|
buyerInfo?: {
|
|
4561
4696
|
visitorId: string;
|
|
@@ -4712,6 +4847,20 @@ export interface UpdateOrderResponseNonNullableFields {
|
|
|
4712
4847
|
customFields: {
|
|
4713
4848
|
title: string;
|
|
4714
4849
|
}[];
|
|
4850
|
+
balanceSummary?: {
|
|
4851
|
+
balance?: {
|
|
4852
|
+
amount: string;
|
|
4853
|
+
formattedAmount: string;
|
|
4854
|
+
};
|
|
4855
|
+
paid?: {
|
|
4856
|
+
amount: string;
|
|
4857
|
+
formattedAmount: string;
|
|
4858
|
+
};
|
|
4859
|
+
refunded?: {
|
|
4860
|
+
amount: string;
|
|
4861
|
+
formattedAmount: string;
|
|
4862
|
+
};
|
|
4863
|
+
};
|
|
4715
4864
|
additionalFees: {
|
|
4716
4865
|
name: string;
|
|
4717
4866
|
price?: {
|
|
@@ -4754,298 +4903,6 @@ export interface UpdateOrderResponseNonNullableFields {
|
|
|
4754
4903
|
};
|
|
4755
4904
|
};
|
|
4756
4905
|
}
|
|
4757
|
-
export interface BulkUpdateOrderResponseNonNullableFields {
|
|
4758
|
-
results: {
|
|
4759
|
-
itemMetadata?: {
|
|
4760
|
-
originalIndex: number;
|
|
4761
|
-
success: boolean;
|
|
4762
|
-
error?: {
|
|
4763
|
-
code: string;
|
|
4764
|
-
description: string;
|
|
4765
|
-
};
|
|
4766
|
-
};
|
|
4767
|
-
item?: {
|
|
4768
|
-
number: string;
|
|
4769
|
-
lineItems: {
|
|
4770
|
-
_id: string;
|
|
4771
|
-
productName?: {
|
|
4772
|
-
original: string;
|
|
4773
|
-
};
|
|
4774
|
-
catalogReference?: {
|
|
4775
|
-
catalogItemId: string;
|
|
4776
|
-
appId: string;
|
|
4777
|
-
};
|
|
4778
|
-
quantity: number;
|
|
4779
|
-
totalDiscount?: {
|
|
4780
|
-
amount: string;
|
|
4781
|
-
formattedAmount: string;
|
|
4782
|
-
};
|
|
4783
|
-
descriptionLines: {
|
|
4784
|
-
plainText?: {
|
|
4785
|
-
original: string;
|
|
4786
|
-
};
|
|
4787
|
-
colorInfo?: {
|
|
4788
|
-
original: string;
|
|
4789
|
-
};
|
|
4790
|
-
name?: {
|
|
4791
|
-
original: string;
|
|
4792
|
-
};
|
|
4793
|
-
}[];
|
|
4794
|
-
image: string;
|
|
4795
|
-
physicalProperties?: {
|
|
4796
|
-
shippable: boolean;
|
|
4797
|
-
};
|
|
4798
|
-
itemType?: {
|
|
4799
|
-
preset: ItemTypeItemType;
|
|
4800
|
-
custom: string;
|
|
4801
|
-
};
|
|
4802
|
-
price?: {
|
|
4803
|
-
amount: string;
|
|
4804
|
-
formattedAmount: string;
|
|
4805
|
-
};
|
|
4806
|
-
priceBeforeDiscounts?: {
|
|
4807
|
-
amount: string;
|
|
4808
|
-
formattedAmount: string;
|
|
4809
|
-
};
|
|
4810
|
-
totalPriceBeforeTax?: {
|
|
4811
|
-
amount: string;
|
|
4812
|
-
formattedAmount: string;
|
|
4813
|
-
};
|
|
4814
|
-
totalPriceAfterTax?: {
|
|
4815
|
-
amount: string;
|
|
4816
|
-
formattedAmount: string;
|
|
4817
|
-
};
|
|
4818
|
-
paymentOption: PaymentOptionType;
|
|
4819
|
-
taxDetails?: {
|
|
4820
|
-
taxableAmount?: {
|
|
4821
|
-
amount: string;
|
|
4822
|
-
formattedAmount: string;
|
|
4823
|
-
};
|
|
4824
|
-
taxRate: string;
|
|
4825
|
-
totalTax?: {
|
|
4826
|
-
amount: string;
|
|
4827
|
-
formattedAmount: string;
|
|
4828
|
-
};
|
|
4829
|
-
};
|
|
4830
|
-
subscriptionInfo?: {
|
|
4831
|
-
cycleNumber: number;
|
|
4832
|
-
subscriptionOptionTitle: string;
|
|
4833
|
-
subscriptionSettings?: {
|
|
4834
|
-
frequency: SubscriptionFrequency;
|
|
4835
|
-
autoRenewal: boolean;
|
|
4836
|
-
};
|
|
4837
|
-
};
|
|
4838
|
-
priceDescription?: {
|
|
4839
|
-
original: string;
|
|
4840
|
-
};
|
|
4841
|
-
depositAmount?: {
|
|
4842
|
-
amount: string;
|
|
4843
|
-
formattedAmount: string;
|
|
4844
|
-
};
|
|
4845
|
-
}[];
|
|
4846
|
-
buyerInfo?: {
|
|
4847
|
-
visitorId: string;
|
|
4848
|
-
memberId: string;
|
|
4849
|
-
};
|
|
4850
|
-
paymentStatus: PaymentStatus;
|
|
4851
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
4852
|
-
weightUnit: WeightUnit;
|
|
4853
|
-
taxIncludedInPrices: boolean;
|
|
4854
|
-
priceSummary?: {
|
|
4855
|
-
subtotal?: {
|
|
4856
|
-
amount: string;
|
|
4857
|
-
formattedAmount: string;
|
|
4858
|
-
};
|
|
4859
|
-
shipping?: {
|
|
4860
|
-
amount: string;
|
|
4861
|
-
formattedAmount: string;
|
|
4862
|
-
};
|
|
4863
|
-
tax?: {
|
|
4864
|
-
amount: string;
|
|
4865
|
-
formattedAmount: string;
|
|
4866
|
-
};
|
|
4867
|
-
discount?: {
|
|
4868
|
-
amount: string;
|
|
4869
|
-
formattedAmount: string;
|
|
4870
|
-
};
|
|
4871
|
-
total?: {
|
|
4872
|
-
amount: string;
|
|
4873
|
-
formattedAmount: string;
|
|
4874
|
-
};
|
|
4875
|
-
totalAdditionalFees?: {
|
|
4876
|
-
amount: string;
|
|
4877
|
-
formattedAmount: string;
|
|
4878
|
-
};
|
|
4879
|
-
};
|
|
4880
|
-
billingInfo?: {
|
|
4881
|
-
contactDetails?: {
|
|
4882
|
-
vatId?: {
|
|
4883
|
-
_id: string;
|
|
4884
|
-
type: VatType;
|
|
4885
|
-
};
|
|
4886
|
-
};
|
|
4887
|
-
};
|
|
4888
|
-
shippingInfo?: {
|
|
4889
|
-
title: string;
|
|
4890
|
-
logistics?: {
|
|
4891
|
-
shippingDestination?: {
|
|
4892
|
-
contactDetails?: {
|
|
4893
|
-
vatId?: {
|
|
4894
|
-
_id: string;
|
|
4895
|
-
type: VatType;
|
|
4896
|
-
};
|
|
4897
|
-
};
|
|
4898
|
-
};
|
|
4899
|
-
pickupDetails?: {
|
|
4900
|
-
pickupMethod: PickupMethod;
|
|
4901
|
-
};
|
|
4902
|
-
};
|
|
4903
|
-
cost?: {
|
|
4904
|
-
price?: {
|
|
4905
|
-
amount: string;
|
|
4906
|
-
formattedAmount: string;
|
|
4907
|
-
};
|
|
4908
|
-
totalPriceBeforeTax?: {
|
|
4909
|
-
amount: string;
|
|
4910
|
-
formattedAmount: string;
|
|
4911
|
-
};
|
|
4912
|
-
totalPriceAfterTax?: {
|
|
4913
|
-
amount: string;
|
|
4914
|
-
formattedAmount: string;
|
|
4915
|
-
};
|
|
4916
|
-
taxDetails?: {
|
|
4917
|
-
taxableAmount?: {
|
|
4918
|
-
amount: string;
|
|
4919
|
-
formattedAmount: string;
|
|
4920
|
-
};
|
|
4921
|
-
taxRate: string;
|
|
4922
|
-
totalTax?: {
|
|
4923
|
-
amount: string;
|
|
4924
|
-
formattedAmount: string;
|
|
4925
|
-
};
|
|
4926
|
-
};
|
|
4927
|
-
discount?: {
|
|
4928
|
-
amount: string;
|
|
4929
|
-
formattedAmount: string;
|
|
4930
|
-
};
|
|
4931
|
-
};
|
|
4932
|
-
};
|
|
4933
|
-
status: OrderStatus;
|
|
4934
|
-
taxSummary?: {
|
|
4935
|
-
totalTax?: {
|
|
4936
|
-
amount: string;
|
|
4937
|
-
formattedAmount: string;
|
|
4938
|
-
};
|
|
4939
|
-
};
|
|
4940
|
-
appliedDiscounts: {
|
|
4941
|
-
coupon?: {
|
|
4942
|
-
_id: string;
|
|
4943
|
-
code: string;
|
|
4944
|
-
name: string;
|
|
4945
|
-
amount?: {
|
|
4946
|
-
amount: string;
|
|
4947
|
-
formattedAmount: string;
|
|
4948
|
-
};
|
|
4949
|
-
};
|
|
4950
|
-
merchantDiscount?: {
|
|
4951
|
-
discountReason: DiscountReason;
|
|
4952
|
-
amount?: {
|
|
4953
|
-
amount: string;
|
|
4954
|
-
formattedAmount: string;
|
|
4955
|
-
};
|
|
4956
|
-
};
|
|
4957
|
-
discountRule?: {
|
|
4958
|
-
_id: string;
|
|
4959
|
-
name?: {
|
|
4960
|
-
original: string;
|
|
4961
|
-
};
|
|
4962
|
-
amount?: {
|
|
4963
|
-
amount: string;
|
|
4964
|
-
formattedAmount: string;
|
|
4965
|
-
};
|
|
4966
|
-
};
|
|
4967
|
-
discountType: DiscountType;
|
|
4968
|
-
lineItemIds: string[];
|
|
4969
|
-
}[];
|
|
4970
|
-
activities: {
|
|
4971
|
-
customActivity?: {
|
|
4972
|
-
appId: string;
|
|
4973
|
-
type: string;
|
|
4974
|
-
};
|
|
4975
|
-
merchantComment?: {
|
|
4976
|
-
message: string;
|
|
4977
|
-
};
|
|
4978
|
-
orderRefunded?: {
|
|
4979
|
-
manual: boolean;
|
|
4980
|
-
amount?: {
|
|
4981
|
-
amount: string;
|
|
4982
|
-
formattedAmount: string;
|
|
4983
|
-
};
|
|
4984
|
-
reason: string;
|
|
4985
|
-
};
|
|
4986
|
-
type: ActivityType;
|
|
4987
|
-
}[];
|
|
4988
|
-
attributionSource: AttributionSource;
|
|
4989
|
-
createdBy?: {
|
|
4990
|
-
userId: string;
|
|
4991
|
-
memberId: string;
|
|
4992
|
-
visitorId: string;
|
|
4993
|
-
appId: string;
|
|
4994
|
-
};
|
|
4995
|
-
channelInfo?: {
|
|
4996
|
-
type: ChannelType;
|
|
4997
|
-
};
|
|
4998
|
-
customFields: {
|
|
4999
|
-
title: string;
|
|
5000
|
-
}[];
|
|
5001
|
-
additionalFees: {
|
|
5002
|
-
name: string;
|
|
5003
|
-
price?: {
|
|
5004
|
-
amount: string;
|
|
5005
|
-
formattedAmount: string;
|
|
5006
|
-
};
|
|
5007
|
-
taxDetails?: {
|
|
5008
|
-
taxableAmount?: {
|
|
5009
|
-
amount: string;
|
|
5010
|
-
formattedAmount: string;
|
|
5011
|
-
};
|
|
5012
|
-
taxRate: string;
|
|
5013
|
-
totalTax?: {
|
|
5014
|
-
amount: string;
|
|
5015
|
-
formattedAmount: string;
|
|
5016
|
-
};
|
|
5017
|
-
};
|
|
5018
|
-
priceBeforeTax?: {
|
|
5019
|
-
amount: string;
|
|
5020
|
-
formattedAmount: string;
|
|
5021
|
-
};
|
|
5022
|
-
_id: string;
|
|
5023
|
-
lineItemIds: string[];
|
|
5024
|
-
}[];
|
|
5025
|
-
recipientInfo?: {
|
|
5026
|
-
contactDetails?: {
|
|
5027
|
-
vatId?: {
|
|
5028
|
-
_id: string;
|
|
5029
|
-
type: VatType;
|
|
5030
|
-
};
|
|
5031
|
-
};
|
|
5032
|
-
};
|
|
5033
|
-
tags?: {
|
|
5034
|
-
privateTags?: {
|
|
5035
|
-
tagIds: string[];
|
|
5036
|
-
};
|
|
5037
|
-
tags?: {
|
|
5038
|
-
tagIds: string[];
|
|
5039
|
-
};
|
|
5040
|
-
};
|
|
5041
|
-
};
|
|
5042
|
-
}[];
|
|
5043
|
-
bulkActionMetadata?: {
|
|
5044
|
-
totalSuccesses: number;
|
|
5045
|
-
totalFailures: number;
|
|
5046
|
-
undetailedFailures: number;
|
|
5047
|
-
};
|
|
5048
|
-
}
|
|
5049
4906
|
export interface CancelOrderResponseNonNullableFields {
|
|
5050
4907
|
order?: {
|
|
5051
4908
|
number: string;
|
|
@@ -5125,6 +4982,10 @@ export interface CancelOrderResponseNonNullableFields {
|
|
|
5125
4982
|
amount: string;
|
|
5126
4983
|
formattedAmount: string;
|
|
5127
4984
|
};
|
|
4985
|
+
lineItemPrice?: {
|
|
4986
|
+
amount: string;
|
|
4987
|
+
formattedAmount: string;
|
|
4988
|
+
};
|
|
5128
4989
|
}[];
|
|
5129
4990
|
buyerInfo?: {
|
|
5130
4991
|
visitorId: string;
|
|
@@ -5281,6 +5142,20 @@ export interface CancelOrderResponseNonNullableFields {
|
|
|
5281
5142
|
customFields: {
|
|
5282
5143
|
title: string;
|
|
5283
5144
|
}[];
|
|
5145
|
+
balanceSummary?: {
|
|
5146
|
+
balance?: {
|
|
5147
|
+
amount: string;
|
|
5148
|
+
formattedAmount: string;
|
|
5149
|
+
};
|
|
5150
|
+
paid?: {
|
|
5151
|
+
amount: string;
|
|
5152
|
+
formattedAmount: string;
|
|
5153
|
+
};
|
|
5154
|
+
refunded?: {
|
|
5155
|
+
amount: string;
|
|
5156
|
+
formattedAmount: string;
|
|
5157
|
+
};
|
|
5158
|
+
};
|
|
5284
5159
|
additionalFees: {
|
|
5285
5160
|
name: string;
|
|
5286
5161
|
price?: {
|
|
@@ -5406,6 +5281,7 @@ export interface SearchOrdersOptions {
|
|
|
5406
5281
|
* @requiredField order.lineItems.price
|
|
5407
5282
|
* @requiredField order.lineItems.productName
|
|
5408
5283
|
* @requiredField order.lineItems.productName.original
|
|
5284
|
+
* @requiredField order.lineItems.subscriptionInfo.subscriptionSettings.interval
|
|
5409
5285
|
* @requiredField order.lineItems.taxDetails
|
|
5410
5286
|
* @requiredField order.priceSummary
|
|
5411
5287
|
* @permissionScope Manage Stores - all permissions
|
|
@@ -5553,6 +5429,11 @@ export interface UpdateOrder {
|
|
|
5553
5429
|
checkoutId?: string | null;
|
|
5554
5430
|
/** Custom fields. */
|
|
5555
5431
|
customFields?: CustomField[];
|
|
5432
|
+
/**
|
|
5433
|
+
* Order balance summary.
|
|
5434
|
+
* @readonly
|
|
5435
|
+
*/
|
|
5436
|
+
balanceSummary?: BalanceSummary;
|
|
5556
5437
|
/** Additional fees applied to the order. */
|
|
5557
5438
|
additionalFees?: AdditionalFee[];
|
|
5558
5439
|
/**
|
|
@@ -5574,25 +5455,6 @@ export interface UpdateOrder {
|
|
|
5574
5455
|
/** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
|
|
5575
5456
|
tags?: Tags;
|
|
5576
5457
|
}
|
|
5577
|
-
/** @param orders - Orders to be updated.
|
|
5578
|
-
* @public
|
|
5579
|
-
* @documentationMaturity preview
|
|
5580
|
-
* @requiredField orders
|
|
5581
|
-
* @requiredField orders.order
|
|
5582
|
-
* @requiredField orders.order._id
|
|
5583
|
-
* @permissionScope Manage Stores - all permissions
|
|
5584
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5585
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
5586
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
5587
|
-
* @permissionScope Manage Orders
|
|
5588
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
5589
|
-
* @applicableIdentity APP
|
|
5590
|
-
*/
|
|
5591
|
-
export declare function bulkUpdateOrder(orders: MaskedOrder[], options?: BulkUpdateOrderOptions): Promise<BulkUpdateOrderResponse & BulkUpdateOrderResponseNonNullableFields>;
|
|
5592
|
-
export interface BulkUpdateOrderOptions {
|
|
5593
|
-
/** Set to `true` if you wish to receive back the updated orders in the response */
|
|
5594
|
-
returnEntity?: boolean;
|
|
5595
|
-
}
|
|
5596
5458
|
/**
|
|
5597
5459
|
* Cancels an order.
|
|
5598
5460
|
*
|