@wix/auto_sdk_ecom_draft-orders 1.0.17 → 1.0.19
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/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.mts} +423 -831
- package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts} +423 -831
- package/build/index.d.mts +232 -0
- package/build/index.d.ts +232 -0
- package/build/index.js +4593 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +4520 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.mts} +885 -1096
- package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts} +885 -1096
- package/build/internal/index.d.mts +232 -0
- package/build/internal/index.d.ts +232 -0
- package/build/internal/index.js +4593 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +4520 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2751 -0
- package/build/internal/meta.d.ts +2751 -0
- package/build/internal/meta.js +3323 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +3275 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2751 -0
- package/build/meta.d.ts +2751 -0
- package/build/meta.js +3323 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +3275 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
|
|
2
|
-
|
|
2
|
+
interface DraftOrder {
|
|
3
3
|
/**
|
|
4
4
|
* Draft order ID.
|
|
5
5
|
* @format GUID
|
|
6
6
|
* @readonly
|
|
7
7
|
*/
|
|
8
|
-
|
|
8
|
+
_id?: string | null;
|
|
9
9
|
/**
|
|
10
10
|
* ID of the order this draft commits to.
|
|
11
11
|
* @format GUID
|
|
@@ -53,12 +53,12 @@ export interface DraftOrder {
|
|
|
53
53
|
* Date and time the draft order was created.
|
|
54
54
|
* @readonly
|
|
55
55
|
*/
|
|
56
|
-
|
|
56
|
+
_createdDate?: Date | null;
|
|
57
57
|
/**
|
|
58
58
|
* Date and time the draft order was updated.
|
|
59
59
|
* @readonly
|
|
60
60
|
*/
|
|
61
|
-
|
|
61
|
+
_updatedDate?: Date | null;
|
|
62
62
|
/**
|
|
63
63
|
* Identity of the draft order's initiator.
|
|
64
64
|
* @readonly
|
|
@@ -116,13 +116,25 @@ export interface DraftOrder {
|
|
|
116
116
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
117
117
|
*/
|
|
118
118
|
extendedFields?: ExtendedFields;
|
|
119
|
+
/**
|
|
120
|
+
* Buyer information.
|
|
121
|
+
* Includes details about changes when relevant.
|
|
122
|
+
* @internal
|
|
123
|
+
*/
|
|
124
|
+
buyerDetails?: BuyerDetails;
|
|
125
|
+
/**
|
|
126
|
+
* Billing address and contact details.
|
|
127
|
+
* Includes details about changes when relevant.
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
130
|
+
billingDetails?: BillingDetails;
|
|
119
131
|
/**
|
|
120
132
|
* Order business location
|
|
121
133
|
* Includes details about changes when relevant.
|
|
122
134
|
*/
|
|
123
135
|
businessLocationDetails?: BusinessLocationDetails;
|
|
124
136
|
}
|
|
125
|
-
|
|
137
|
+
interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
126
138
|
/** Whether the line item was added as part of the draft. */
|
|
127
139
|
added?: boolean;
|
|
128
140
|
/** Line item fields before the change. */
|
|
@@ -133,7 +145,7 @@ export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
|
133
145
|
lineItem?: OrderLineItem;
|
|
134
146
|
}
|
|
135
147
|
/** @oneof */
|
|
136
|
-
|
|
148
|
+
interface ItemDetailsChangeTypeOneOf {
|
|
137
149
|
/** Whether the line item was added as part of the draft. */
|
|
138
150
|
added?: boolean;
|
|
139
151
|
/** Line item fields before the change. */
|
|
@@ -141,7 +153,7 @@ export interface ItemDetailsChangeTypeOneOf {
|
|
|
141
153
|
/** Whether the line item was removed as part of the draft. */
|
|
142
154
|
removed?: boolean;
|
|
143
155
|
}
|
|
144
|
-
|
|
156
|
+
interface Price {
|
|
145
157
|
/**
|
|
146
158
|
* Amount.
|
|
147
159
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -153,7 +165,7 @@ export interface Price {
|
|
|
153
165
|
*/
|
|
154
166
|
formattedAmount?: string;
|
|
155
167
|
}
|
|
156
|
-
|
|
168
|
+
interface PriceDescription {
|
|
157
169
|
/**
|
|
158
170
|
* __Required.__ Price description 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).
|
|
159
171
|
* @minLength 1
|
|
@@ -169,12 +181,12 @@ export interface PriceDescription {
|
|
|
169
181
|
*/
|
|
170
182
|
translated?: string | null;
|
|
171
183
|
}
|
|
172
|
-
|
|
184
|
+
interface OrderLineItem {
|
|
173
185
|
/**
|
|
174
186
|
* Line item ID.
|
|
175
187
|
* @immutable
|
|
176
188
|
*/
|
|
177
|
-
|
|
189
|
+
_id?: string;
|
|
178
190
|
/**
|
|
179
191
|
* Item name.
|
|
180
192
|
* + Stores - `product.name`
|
|
@@ -204,7 +216,7 @@ export interface OrderLineItem {
|
|
|
204
216
|
*/
|
|
205
217
|
descriptionLines?: DescriptionLine[];
|
|
206
218
|
/** Line item image. */
|
|
207
|
-
image?:
|
|
219
|
+
image?: string;
|
|
208
220
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
209
221
|
physicalProperties?: PhysicalProperties;
|
|
210
222
|
/** Item type. Either a preset type or custom. */
|
|
@@ -279,6 +291,17 @@ export interface OrderLineItem {
|
|
|
279
291
|
* @maxSize 5
|
|
280
292
|
*/
|
|
281
293
|
locations?: LocationAndQuantity[];
|
|
294
|
+
/**
|
|
295
|
+
* Address used for tax calculation.
|
|
296
|
+
* @internal
|
|
297
|
+
*/
|
|
298
|
+
taxableAddress?: TaxableAddress;
|
|
299
|
+
/**
|
|
300
|
+
* ID of the app managing the inventory.
|
|
301
|
+
* @internal
|
|
302
|
+
* @format GUID
|
|
303
|
+
*/
|
|
304
|
+
inventoryAppId?: string | null;
|
|
282
305
|
/**
|
|
283
306
|
* Custom extended fields for the line item object.
|
|
284
307
|
*
|
|
@@ -286,7 +309,7 @@ export interface OrderLineItem {
|
|
|
286
309
|
*/
|
|
287
310
|
extendedFields?: ExtendedFields;
|
|
288
311
|
}
|
|
289
|
-
|
|
312
|
+
interface ProductName {
|
|
290
313
|
/**
|
|
291
314
|
* __Required.__ Item name 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).
|
|
292
315
|
*
|
|
@@ -308,7 +331,7 @@ export interface ProductName {
|
|
|
308
331
|
translated?: string | null;
|
|
309
332
|
}
|
|
310
333
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
311
|
-
|
|
334
|
+
interface CatalogReference {
|
|
312
335
|
/**
|
|
313
336
|
* ID of the item within the catalog it belongs to.
|
|
314
337
|
* @minLength 1
|
|
@@ -334,7 +357,7 @@ export interface CatalogReference {
|
|
|
334
357
|
*/
|
|
335
358
|
options?: Record<string, any> | null;
|
|
336
359
|
}
|
|
337
|
-
|
|
360
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
338
361
|
/** Description line plain text value. */
|
|
339
362
|
plainText?: PlainTextValue;
|
|
340
363
|
/** Description line color value. */
|
|
@@ -343,16 +366,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
343
366
|
name?: DescriptionLineName;
|
|
344
367
|
}
|
|
345
368
|
/** @oneof */
|
|
346
|
-
|
|
369
|
+
interface DescriptionLineValueOneOf {
|
|
347
370
|
/** Description line plain text value. */
|
|
348
371
|
plainText?: PlainTextValue;
|
|
349
372
|
/** Description line color value. */
|
|
350
373
|
colorInfo?: Color;
|
|
351
374
|
}
|
|
352
375
|
/** @oneof */
|
|
353
|
-
|
|
376
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
354
377
|
}
|
|
355
|
-
|
|
378
|
+
interface DescriptionLineName {
|
|
356
379
|
/**
|
|
357
380
|
* Description line name 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).
|
|
358
381
|
* @maxLength 100
|
|
@@ -366,7 +389,7 @@ export interface DescriptionLineName {
|
|
|
366
389
|
*/
|
|
367
390
|
translated?: string | null;
|
|
368
391
|
}
|
|
369
|
-
|
|
392
|
+
interface PlainTextValue {
|
|
370
393
|
/**
|
|
371
394
|
* Description line plain text value 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).
|
|
372
395
|
* @maxLength 600
|
|
@@ -380,7 +403,7 @@ export interface PlainTextValue {
|
|
|
380
403
|
*/
|
|
381
404
|
translated?: string | null;
|
|
382
405
|
}
|
|
383
|
-
|
|
406
|
+
interface Color {
|
|
384
407
|
/**
|
|
385
408
|
* Description line color name 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).
|
|
386
409
|
* @maxLength 500
|
|
@@ -396,7 +419,7 @@ export interface Color {
|
|
|
396
419
|
/** HEX or RGB color code for display. */
|
|
397
420
|
code?: string | null;
|
|
398
421
|
}
|
|
399
|
-
|
|
422
|
+
declare enum DescriptionLineType {
|
|
400
423
|
/** Unrecognized type. */
|
|
401
424
|
UNRECOGNISED = "UNRECOGNISED",
|
|
402
425
|
/** Plain text type. */
|
|
@@ -404,30 +427,7 @@ export declare enum DescriptionLineType {
|
|
|
404
427
|
/** Color type. */
|
|
405
428
|
COLOR = "COLOR"
|
|
406
429
|
}
|
|
407
|
-
|
|
408
|
-
/** WixMedia image ID. */
|
|
409
|
-
id?: string;
|
|
410
|
-
/** Image URL. */
|
|
411
|
-
url?: string;
|
|
412
|
-
/**
|
|
413
|
-
* Original image height.
|
|
414
|
-
* @readonly
|
|
415
|
-
*/
|
|
416
|
-
height?: number;
|
|
417
|
-
/**
|
|
418
|
-
* Original image width.
|
|
419
|
-
* @readonly
|
|
420
|
-
*/
|
|
421
|
-
width?: number;
|
|
422
|
-
/** Image alt text. */
|
|
423
|
-
altText?: string | null;
|
|
424
|
-
/**
|
|
425
|
-
* Image filename.
|
|
426
|
-
* @readonly
|
|
427
|
-
*/
|
|
428
|
-
filename?: string | null;
|
|
429
|
-
}
|
|
430
|
-
export interface FocalPoint {
|
|
430
|
+
interface FocalPoint {
|
|
431
431
|
/** X-coordinate of the focal point. */
|
|
432
432
|
x?: number;
|
|
433
433
|
/** Y-coordinate of the focal point. */
|
|
@@ -437,7 +437,7 @@ export interface FocalPoint {
|
|
|
437
437
|
/** crop by width */
|
|
438
438
|
width?: number | null;
|
|
439
439
|
}
|
|
440
|
-
|
|
440
|
+
interface PhysicalProperties {
|
|
441
441
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
442
442
|
weight?: number | null;
|
|
443
443
|
/**
|
|
@@ -448,20 +448,20 @@ export interface PhysicalProperties {
|
|
|
448
448
|
/** Whether this line item is shippable. */
|
|
449
449
|
shippable?: boolean;
|
|
450
450
|
}
|
|
451
|
-
|
|
451
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
452
452
|
/** Preset item type. */
|
|
453
453
|
preset?: ItemTypeItemType;
|
|
454
454
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
455
455
|
custom?: string;
|
|
456
456
|
}
|
|
457
457
|
/** @oneof */
|
|
458
|
-
|
|
458
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
459
459
|
/** Preset item type. */
|
|
460
460
|
preset?: ItemTypeItemType;
|
|
461
461
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
462
462
|
custom?: string;
|
|
463
463
|
}
|
|
464
|
-
|
|
464
|
+
declare enum ItemTypeItemType {
|
|
465
465
|
UNRECOGNISED = "UNRECOGNISED",
|
|
466
466
|
PHYSICAL = "PHYSICAL",
|
|
467
467
|
DIGITAL = "DIGITAL",
|
|
@@ -469,7 +469,7 @@ export declare enum ItemTypeItemType {
|
|
|
469
469
|
SERVICE = "SERVICE"
|
|
470
470
|
}
|
|
471
471
|
/** Type of selected payment option for catalog item */
|
|
472
|
-
|
|
472
|
+
declare enum PaymentOptionType {
|
|
473
473
|
/** The entire payment for this item happens as part of the checkout. */
|
|
474
474
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
475
475
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -481,7 +481,7 @@ export declare enum PaymentOptionType {
|
|
|
481
481
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
482
482
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
483
483
|
}
|
|
484
|
-
|
|
484
|
+
interface ItemTaxFullDetails {
|
|
485
485
|
/** Taxable amount of this line item. */
|
|
486
486
|
taxableAmount?: Price;
|
|
487
487
|
/**
|
|
@@ -492,7 +492,7 @@ export interface ItemTaxFullDetails {
|
|
|
492
492
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
493
493
|
totalTax?: Price;
|
|
494
494
|
}
|
|
495
|
-
|
|
495
|
+
interface LineItemTaxInfo {
|
|
496
496
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
497
497
|
taxAmount?: Price;
|
|
498
498
|
/** Amount for which tax is calculated. */
|
|
@@ -520,7 +520,7 @@ export interface LineItemTaxInfo {
|
|
|
520
520
|
* TaxBreakdown represents tax information for a line item.
|
|
521
521
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
522
522
|
*/
|
|
523
|
-
|
|
523
|
+
interface LineItemTaxBreakdown {
|
|
524
524
|
/**
|
|
525
525
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
526
526
|
* @maxLength 200
|
|
@@ -553,7 +553,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
553
|
taxableAmount?: Price;
|
|
554
554
|
}
|
|
555
555
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
556
|
-
|
|
556
|
+
declare enum JurisdictionType {
|
|
557
557
|
UNDEFINED = "UNDEFINED",
|
|
558
558
|
COUNTRY = "COUNTRY",
|
|
559
559
|
STATE = "STATE",
|
|
@@ -561,7 +561,7 @@ export declare enum JurisdictionType {
|
|
|
561
561
|
CITY = "CITY",
|
|
562
562
|
SPECIAL = "SPECIAL"
|
|
563
563
|
}
|
|
564
|
-
|
|
564
|
+
interface DigitalFile {
|
|
565
565
|
/**
|
|
566
566
|
* ID of the secure file in media.
|
|
567
567
|
* @minLength 1
|
|
@@ -581,12 +581,12 @@ export interface DigitalFile {
|
|
|
581
581
|
*/
|
|
582
582
|
expirationDate?: Date | null;
|
|
583
583
|
}
|
|
584
|
-
|
|
584
|
+
interface SubscriptionInfo {
|
|
585
585
|
/**
|
|
586
586
|
* Subscription ID.
|
|
587
587
|
* @format GUID
|
|
588
588
|
*/
|
|
589
|
-
|
|
589
|
+
_id?: string | null;
|
|
590
590
|
/**
|
|
591
591
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
592
592
|
* @min 1
|
|
@@ -600,6 +600,11 @@ export interface SubscriptionInfo {
|
|
|
600
600
|
* @targetRemovalDate 2025-10-01
|
|
601
601
|
*/
|
|
602
602
|
subscriptionOptionTitle?: string;
|
|
603
|
+
/**
|
|
604
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
605
|
+
* @internal
|
|
606
|
+
*/
|
|
607
|
+
title?: SubscriptionTitle;
|
|
603
608
|
/**
|
|
604
609
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
605
610
|
* @maxLength 60
|
|
@@ -608,13 +613,29 @@ export interface SubscriptionInfo {
|
|
|
608
613
|
* @targetRemovalDate 2025-10-01
|
|
609
614
|
*/
|
|
610
615
|
subscriptionOptionDescription?: string | null;
|
|
616
|
+
/**
|
|
617
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
618
|
+
* @internal
|
|
619
|
+
*/
|
|
620
|
+
description?: SubscriptionDescription;
|
|
611
621
|
/**
|
|
612
622
|
* Subscription detailed information.
|
|
613
623
|
* @immutable
|
|
614
624
|
*/
|
|
615
625
|
subscriptionSettings?: SubscriptionSettings;
|
|
626
|
+
/**
|
|
627
|
+
* Description of the charges that will be applied for subscription.
|
|
628
|
+
* @internal
|
|
629
|
+
* @maxLength 1000
|
|
630
|
+
*/
|
|
631
|
+
chargesDescription?: string | null;
|
|
632
|
+
/**
|
|
633
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
634
|
+
* @internal
|
|
635
|
+
*/
|
|
636
|
+
billingAdjustment?: BillingAdjustment;
|
|
616
637
|
}
|
|
617
|
-
|
|
638
|
+
interface SubscriptionTitle {
|
|
618
639
|
/**
|
|
619
640
|
* Subscription option name 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).
|
|
620
641
|
* @minLength 1
|
|
@@ -630,7 +651,7 @@ export interface SubscriptionTitle {
|
|
|
630
651
|
*/
|
|
631
652
|
translated?: string | null;
|
|
632
653
|
}
|
|
633
|
-
|
|
654
|
+
interface SubscriptionDescription {
|
|
634
655
|
/**
|
|
635
656
|
* Subscription option description.
|
|
636
657
|
* @maxLength 500
|
|
@@ -642,7 +663,7 @@ export interface SubscriptionDescription {
|
|
|
642
663
|
*/
|
|
643
664
|
translated?: string | null;
|
|
644
665
|
}
|
|
645
|
-
|
|
666
|
+
interface SubscriptionSettings {
|
|
646
667
|
/** Frequency of recurring payment. */
|
|
647
668
|
frequency?: SubscriptionFrequency;
|
|
648
669
|
/**
|
|
@@ -658,16 +679,31 @@ export interface SubscriptionSettings {
|
|
|
658
679
|
* @min 1
|
|
659
680
|
*/
|
|
660
681
|
billingCycles?: number | null;
|
|
682
|
+
/**
|
|
683
|
+
* Whether to allow the customer to cancel the subscription.
|
|
684
|
+
* @internal
|
|
685
|
+
*/
|
|
686
|
+
enableCustomerCancellation?: boolean;
|
|
687
|
+
/**
|
|
688
|
+
* Period until first cycle starts. If None => no free trial
|
|
689
|
+
* @internal
|
|
690
|
+
*/
|
|
691
|
+
freeTrialPeriod?: FreeTrialPeriod;
|
|
692
|
+
/**
|
|
693
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
694
|
+
* @internal
|
|
695
|
+
*/
|
|
696
|
+
startDate?: Date | null;
|
|
661
697
|
}
|
|
662
698
|
/** Frequency unit of recurring payment */
|
|
663
|
-
|
|
699
|
+
declare enum SubscriptionFrequency {
|
|
664
700
|
UNDEFINED = "UNDEFINED",
|
|
665
701
|
DAY = "DAY",
|
|
666
702
|
WEEK = "WEEK",
|
|
667
703
|
MONTH = "MONTH",
|
|
668
704
|
YEAR = "YEAR"
|
|
669
705
|
}
|
|
670
|
-
|
|
706
|
+
interface FreeTrialPeriod {
|
|
671
707
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
672
708
|
frequency?: SubscriptionFrequency;
|
|
673
709
|
/**
|
|
@@ -677,20 +713,20 @@ export interface FreeTrialPeriod {
|
|
|
677
713
|
*/
|
|
678
714
|
interval?: number;
|
|
679
715
|
}
|
|
680
|
-
|
|
716
|
+
interface BillingAdjustment {
|
|
681
717
|
/** The type of adjustment. */
|
|
682
718
|
type?: AdjustmentType;
|
|
683
719
|
/** Summary of the prorated adjustment amount. */
|
|
684
720
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
685
721
|
}
|
|
686
|
-
|
|
722
|
+
declare enum AdjustmentType {
|
|
687
723
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
688
724
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
689
725
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
690
726
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
691
727
|
CREDIT = "CREDIT"
|
|
692
728
|
}
|
|
693
|
-
|
|
729
|
+
interface BillingAdjustmentPriceSummary {
|
|
694
730
|
/** Subtotal of adjustment, before tax. */
|
|
695
731
|
subtotal?: Price;
|
|
696
732
|
/** Tax on adjustment. */
|
|
@@ -698,12 +734,12 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
698
734
|
/** Total price after tax. */
|
|
699
735
|
total?: Price;
|
|
700
736
|
}
|
|
701
|
-
|
|
737
|
+
interface LocationAndQuantity {
|
|
702
738
|
/**
|
|
703
739
|
* Location id in the associated owner app.
|
|
704
740
|
* @format GUID
|
|
705
741
|
*/
|
|
706
|
-
|
|
742
|
+
_id?: string;
|
|
707
743
|
/**
|
|
708
744
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
709
745
|
* @format GUID
|
|
@@ -724,22 +760,22 @@ export interface LocationAndQuantity {
|
|
|
724
760
|
*/
|
|
725
761
|
name?: string | null;
|
|
726
762
|
}
|
|
727
|
-
|
|
763
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
728
764
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
729
765
|
addressType?: TaxableAddressType;
|
|
730
766
|
}
|
|
731
767
|
/** @oneof */
|
|
732
|
-
|
|
768
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
733
769
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
734
770
|
addressType?: TaxableAddressType;
|
|
735
771
|
}
|
|
736
|
-
|
|
772
|
+
declare enum TaxableAddressType {
|
|
737
773
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
738
774
|
BUSINESS = "BUSINESS",
|
|
739
775
|
BILLING = "BILLING",
|
|
740
776
|
SHIPPING = "SHIPPING"
|
|
741
777
|
}
|
|
742
|
-
|
|
778
|
+
interface ExtendedFields {
|
|
743
779
|
/**
|
|
744
780
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
745
781
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -750,7 +786,7 @@ export interface ExtendedFields {
|
|
|
750
786
|
*/
|
|
751
787
|
namespaces?: Record<string, Record<string, any>>;
|
|
752
788
|
}
|
|
753
|
-
|
|
789
|
+
interface ItemChangedDetails {
|
|
754
790
|
/**
|
|
755
791
|
* Line item quantity before change.
|
|
756
792
|
* @min 1
|
|
@@ -762,7 +798,7 @@ export interface ItemChangedDetails {
|
|
|
762
798
|
/** Line item price description before change. */
|
|
763
799
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
764
800
|
}
|
|
765
|
-
|
|
801
|
+
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
766
802
|
/** Whether shipping info was added as part of the draft. */
|
|
767
803
|
added?: boolean;
|
|
768
804
|
/** Shipping info before the change. */
|
|
@@ -773,7 +809,7 @@ export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
773
809
|
shippingInfo?: V1ShippingInformation;
|
|
774
810
|
}
|
|
775
811
|
/** @oneof */
|
|
776
|
-
|
|
812
|
+
interface ShippingDetailsChangeTypeOneOf {
|
|
777
813
|
/** Whether shipping info was added as part of the draft. */
|
|
778
814
|
added?: boolean;
|
|
779
815
|
/** Shipping info before the change. */
|
|
@@ -781,7 +817,7 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
781
817
|
/** Whether shipping info was removed as part of the draft. */
|
|
782
818
|
removed?: boolean;
|
|
783
819
|
}
|
|
784
|
-
|
|
820
|
+
interface V1ShippingInformation {
|
|
785
821
|
/**
|
|
786
822
|
* App Def Id of external provider which was a source of shipping info
|
|
787
823
|
* @minLength 1
|
|
@@ -807,7 +843,7 @@ export interface V1ShippingInformation {
|
|
|
807
843
|
/** Shipping region. */
|
|
808
844
|
region?: ShippingRegion;
|
|
809
845
|
}
|
|
810
|
-
|
|
846
|
+
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
811
847
|
/** Shipping address and contact details. */
|
|
812
848
|
shippingDestination?: AddressWithContact;
|
|
813
849
|
/** Pickup details. */
|
|
@@ -831,21 +867,21 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
831
867
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
832
868
|
}
|
|
833
869
|
/** @oneof */
|
|
834
|
-
|
|
870
|
+
interface V1DeliveryLogisticsAddressOneOf {
|
|
835
871
|
/** Shipping address and contact details. */
|
|
836
872
|
shippingDestination?: AddressWithContact;
|
|
837
873
|
/** Pickup details. */
|
|
838
874
|
pickupDetails?: V1PickupDetails;
|
|
839
875
|
}
|
|
840
876
|
/** Billing Info and shipping details */
|
|
841
|
-
|
|
877
|
+
interface AddressWithContact {
|
|
842
878
|
/** Address. */
|
|
843
879
|
address?: Address;
|
|
844
880
|
/** Contact details. */
|
|
845
881
|
contactDetails?: FullAddressContactDetails;
|
|
846
882
|
}
|
|
847
883
|
/** Physical address */
|
|
848
|
-
|
|
884
|
+
interface Address {
|
|
849
885
|
/**
|
|
850
886
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
851
887
|
* @format COUNTRY
|
|
@@ -872,7 +908,7 @@ export interface Address {
|
|
|
872
908
|
* Main address line (usually street name and number).
|
|
873
909
|
* @maxLength 150
|
|
874
910
|
*/
|
|
875
|
-
|
|
911
|
+
addressLine1?: string | null;
|
|
876
912
|
/**
|
|
877
913
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
878
914
|
* @maxLength 100
|
|
@@ -889,20 +925,20 @@ export interface Address {
|
|
|
889
925
|
*/
|
|
890
926
|
subdivisionFullname?: string | null;
|
|
891
927
|
}
|
|
892
|
-
|
|
928
|
+
interface StreetAddress {
|
|
893
929
|
/** Street number. */
|
|
894
930
|
number?: string;
|
|
895
931
|
/** Street name. */
|
|
896
932
|
name?: string;
|
|
897
933
|
}
|
|
898
|
-
|
|
934
|
+
interface AddressLocation {
|
|
899
935
|
/** Address latitude. */
|
|
900
936
|
latitude?: number | null;
|
|
901
937
|
/** Address longitude. */
|
|
902
938
|
longitude?: number | null;
|
|
903
939
|
}
|
|
904
940
|
/** Full contact details for an address */
|
|
905
|
-
|
|
941
|
+
interface FullAddressContactDetails {
|
|
906
942
|
/**
|
|
907
943
|
* First name.
|
|
908
944
|
* @maxLength 100
|
|
@@ -926,9 +962,9 @@ export interface FullAddressContactDetails {
|
|
|
926
962
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
927
963
|
vatId?: VatId;
|
|
928
964
|
}
|
|
929
|
-
|
|
965
|
+
interface VatId {
|
|
930
966
|
/** Customer's tax ID. */
|
|
931
|
-
|
|
967
|
+
_id?: string;
|
|
932
968
|
/**
|
|
933
969
|
* Tax type.
|
|
934
970
|
*
|
|
@@ -939,21 +975,21 @@ export interface VatId {
|
|
|
939
975
|
type?: VatType;
|
|
940
976
|
}
|
|
941
977
|
/** tax info types */
|
|
942
|
-
|
|
978
|
+
declare enum VatType {
|
|
943
979
|
UNSPECIFIED = "UNSPECIFIED",
|
|
944
980
|
/** CPF - for individual tax payers. */
|
|
945
981
|
CPF = "CPF",
|
|
946
982
|
/** CNPJ - for corporations */
|
|
947
983
|
CNPJ = "CNPJ"
|
|
948
984
|
}
|
|
949
|
-
|
|
985
|
+
interface V1PickupDetails {
|
|
950
986
|
/** Pickup address. */
|
|
951
987
|
address?: PickupAddress;
|
|
952
988
|
/** Pickup method */
|
|
953
989
|
pickupMethod?: PickupDetailsPickupMethod;
|
|
954
990
|
}
|
|
955
991
|
/** Physical address */
|
|
956
|
-
|
|
992
|
+
interface PickupAddress {
|
|
957
993
|
/**
|
|
958
994
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
959
995
|
* @format COUNTRY
|
|
@@ -980,7 +1016,7 @@ export interface PickupAddress {
|
|
|
980
1016
|
* Main address line (usually street name and number).
|
|
981
1017
|
* @maxLength 1000
|
|
982
1018
|
*/
|
|
983
|
-
|
|
1019
|
+
addressLine1?: string | null;
|
|
984
1020
|
/**
|
|
985
1021
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
986
1022
|
* @maxLength 1000
|
|
@@ -997,18 +1033,18 @@ export interface PickupAddress {
|
|
|
997
1033
|
*/
|
|
998
1034
|
subdivisionFullname?: string | null;
|
|
999
1035
|
}
|
|
1000
|
-
|
|
1036
|
+
declare enum PickupDetailsPickupMethod {
|
|
1001
1037
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1002
1038
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1003
1039
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1004
1040
|
}
|
|
1005
|
-
|
|
1041
|
+
interface V1DeliveryTimeSlot {
|
|
1006
1042
|
/** Delivery slot starting time. */
|
|
1007
1043
|
from?: Date | null;
|
|
1008
1044
|
/** Delivery slot ending time. */
|
|
1009
1045
|
to?: Date | null;
|
|
1010
1046
|
}
|
|
1011
|
-
|
|
1047
|
+
interface V1ShippingPrice {
|
|
1012
1048
|
/** Shipping price for display purposes. */
|
|
1013
1049
|
price?: Price;
|
|
1014
1050
|
/**
|
|
@@ -1029,19 +1065,19 @@ export interface V1ShippingPrice {
|
|
|
1029
1065
|
*/
|
|
1030
1066
|
discount?: Price;
|
|
1031
1067
|
}
|
|
1032
|
-
|
|
1068
|
+
interface ShippingRegion {
|
|
1033
1069
|
/**
|
|
1034
1070
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1035
1071
|
* @maxLength 100
|
|
1036
1072
|
*/
|
|
1037
1073
|
name?: string | null;
|
|
1038
1074
|
}
|
|
1039
|
-
|
|
1075
|
+
interface ShippingChangedDetails {
|
|
1040
1076
|
/** Shipping info before the change. */
|
|
1041
1077
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1042
1078
|
}
|
|
1043
1079
|
/** Buyer Info */
|
|
1044
|
-
|
|
1080
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1045
1081
|
/**
|
|
1046
1082
|
* Visitor ID (if site visitor is not a member).
|
|
1047
1083
|
* @format GUID
|
|
@@ -1064,7 +1100,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1064
1100
|
email?: string | null;
|
|
1065
1101
|
}
|
|
1066
1102
|
/** @oneof */
|
|
1067
|
-
|
|
1103
|
+
interface BuyerInfoIdOneOf {
|
|
1068
1104
|
/**
|
|
1069
1105
|
* Visitor ID (if site visitor is not a member).
|
|
1070
1106
|
* @format GUID
|
|
@@ -1076,7 +1112,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
1076
1112
|
*/
|
|
1077
1113
|
memberId?: string;
|
|
1078
1114
|
}
|
|
1079
|
-
|
|
1115
|
+
interface AdditionalFeeDetails {
|
|
1080
1116
|
/** Additional fee. */
|
|
1081
1117
|
additionalFee?: AdditionalFee;
|
|
1082
1118
|
/** Tax details related to the additional fee. */
|
|
@@ -1092,7 +1128,7 @@ export interface AdditionalFeeDetails {
|
|
|
1092
1128
|
/** Whether this additional fee is applied to the order. */
|
|
1093
1129
|
applied?: boolean;
|
|
1094
1130
|
}
|
|
1095
|
-
|
|
1131
|
+
interface AdditionalFee {
|
|
1096
1132
|
/**
|
|
1097
1133
|
* Additional fee's unique code for future processing.
|
|
1098
1134
|
* @minLength 1
|
|
@@ -1123,15 +1159,23 @@ export interface AdditionalFee {
|
|
|
1123
1159
|
* @format GUID
|
|
1124
1160
|
* @immutable
|
|
1125
1161
|
*/
|
|
1126
|
-
|
|
1162
|
+
_id?: string;
|
|
1127
1163
|
/**
|
|
1128
1164
|
* Optional - Line items associated with this additional fee.
|
|
1129
1165
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1130
1166
|
* @format GUID
|
|
1131
1167
|
*/
|
|
1132
1168
|
lineItemIds?: string[];
|
|
1169
|
+
/**
|
|
1170
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
1171
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
1172
|
+
* @internal
|
|
1173
|
+
* @min 1
|
|
1174
|
+
* @max 999
|
|
1175
|
+
*/
|
|
1176
|
+
subscriptionCycles?: number | null;
|
|
1133
1177
|
}
|
|
1134
|
-
|
|
1178
|
+
interface TaxDetails {
|
|
1135
1179
|
/** Indication if additional fee is taxable or not */
|
|
1136
1180
|
taxable?: boolean;
|
|
1137
1181
|
/**
|
|
@@ -1140,7 +1184,7 @@ export interface TaxDetails {
|
|
|
1140
1184
|
*/
|
|
1141
1185
|
taxGroupId?: string | null;
|
|
1142
1186
|
}
|
|
1143
|
-
|
|
1187
|
+
declare enum SourceType {
|
|
1144
1188
|
/** Part of the original order */
|
|
1145
1189
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1146
1190
|
/** Added by estimate * */
|
|
@@ -1148,7 +1192,7 @@ export declare enum SourceType {
|
|
|
1148
1192
|
/** Added manually to current draft order */
|
|
1149
1193
|
CUSTOM = "CUSTOM"
|
|
1150
1194
|
}
|
|
1151
|
-
|
|
1195
|
+
interface DiscountDetails {
|
|
1152
1196
|
/** Discount details. */
|
|
1153
1197
|
discount?: AppliedDiscount;
|
|
1154
1198
|
/**
|
|
@@ -1162,7 +1206,7 @@ export interface DiscountDetails {
|
|
|
1162
1206
|
/** Whether this discount is applied to the order. */
|
|
1163
1207
|
applied?: boolean;
|
|
1164
1208
|
}
|
|
1165
|
-
|
|
1209
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1166
1210
|
/** Applied coupon info. */
|
|
1167
1211
|
coupon?: Coupon;
|
|
1168
1212
|
/** Merchant discount. */
|
|
@@ -1192,10 +1236,18 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1192
1236
|
* @format GUID
|
|
1193
1237
|
* @immutable
|
|
1194
1238
|
*/
|
|
1195
|
-
|
|
1239
|
+
_id?: string | null;
|
|
1240
|
+
/**
|
|
1241
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1242
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1243
|
+
* @internal
|
|
1244
|
+
* @min 1
|
|
1245
|
+
* @max 999
|
|
1246
|
+
*/
|
|
1247
|
+
subscriptionCycles?: number | null;
|
|
1196
1248
|
}
|
|
1197
1249
|
/** @oneof */
|
|
1198
|
-
|
|
1250
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1199
1251
|
/** Applied coupon info. */
|
|
1200
1252
|
coupon?: Coupon;
|
|
1201
1253
|
/** Merchant discount. */
|
|
@@ -1203,15 +1255,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1203
1255
|
/** Automatic Discount */
|
|
1204
1256
|
discountRule?: DiscountRule;
|
|
1205
1257
|
}
|
|
1206
|
-
|
|
1258
|
+
declare enum AppliedDiscountDiscountType {
|
|
1207
1259
|
GLOBAL = "GLOBAL",
|
|
1208
1260
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1209
1261
|
SHIPPING = "SHIPPING"
|
|
1210
1262
|
}
|
|
1211
1263
|
/** Coupon */
|
|
1212
|
-
|
|
1264
|
+
interface Coupon {
|
|
1213
1265
|
/** Coupon ID. */
|
|
1214
|
-
|
|
1266
|
+
_id?: string;
|
|
1215
1267
|
/** Coupon code. */
|
|
1216
1268
|
code?: string;
|
|
1217
1269
|
/** Coupon name. */
|
|
@@ -1219,7 +1271,7 @@ export interface Coupon {
|
|
|
1219
1271
|
/** Coupon value. */
|
|
1220
1272
|
amount?: Price;
|
|
1221
1273
|
}
|
|
1222
|
-
|
|
1274
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1223
1275
|
/**
|
|
1224
1276
|
* Pre-defined discount reason (optional).
|
|
1225
1277
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1232,9 +1284,16 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1232
1284
|
description?: string | null;
|
|
1233
1285
|
/** Discount amount. */
|
|
1234
1286
|
amount?: Price;
|
|
1287
|
+
/**
|
|
1288
|
+
* Discount percentage.
|
|
1289
|
+
* @internal
|
|
1290
|
+
* @format DECIMAL_VALUE
|
|
1291
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1292
|
+
*/
|
|
1293
|
+
percentage?: string | null;
|
|
1235
1294
|
}
|
|
1236
1295
|
/** @oneof */
|
|
1237
|
-
|
|
1296
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1238
1297
|
/**
|
|
1239
1298
|
* Pre-defined discount reason (optional).
|
|
1240
1299
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1246,23 +1305,23 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1246
1305
|
*/
|
|
1247
1306
|
description?: string | null;
|
|
1248
1307
|
}
|
|
1249
|
-
|
|
1308
|
+
declare enum DiscountReason {
|
|
1250
1309
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1251
1310
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1252
1311
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1253
1312
|
}
|
|
1254
|
-
|
|
1313
|
+
interface DiscountRule {
|
|
1255
1314
|
/**
|
|
1256
1315
|
* Discount rule ID
|
|
1257
1316
|
* @format GUID
|
|
1258
1317
|
*/
|
|
1259
|
-
|
|
1318
|
+
_id?: string;
|
|
1260
1319
|
/** Discount rule name */
|
|
1261
1320
|
name?: DiscountRuleName;
|
|
1262
1321
|
/** Discount value. */
|
|
1263
1322
|
amount?: Price;
|
|
1264
1323
|
}
|
|
1265
|
-
|
|
1324
|
+
interface DiscountRuleName {
|
|
1266
1325
|
/**
|
|
1267
1326
|
* Original discount rule name (in site's default language).
|
|
1268
1327
|
* @minLength 1
|
|
@@ -1276,16 +1335,16 @@ export interface DiscountRuleName {
|
|
|
1276
1335
|
*/
|
|
1277
1336
|
translated?: string | null;
|
|
1278
1337
|
}
|
|
1279
|
-
|
|
1338
|
+
interface LineItemDiscount {
|
|
1280
1339
|
/**
|
|
1281
1340
|
* ID of line item the discount applies to.
|
|
1282
1341
|
* @format GUID
|
|
1283
1342
|
*/
|
|
1284
|
-
|
|
1343
|
+
_id?: string;
|
|
1285
1344
|
/** Total discount for this line item. */
|
|
1286
1345
|
totalDiscount?: Price;
|
|
1287
1346
|
}
|
|
1288
|
-
|
|
1347
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1289
1348
|
/**
|
|
1290
1349
|
* User ID. When the draft order was created by a Wix user.
|
|
1291
1350
|
* @format GUID
|
|
@@ -1298,7 +1357,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1298
1357
|
appId?: string;
|
|
1299
1358
|
}
|
|
1300
1359
|
/** @oneof */
|
|
1301
|
-
|
|
1360
|
+
interface CreatedByStringOneOf {
|
|
1302
1361
|
/**
|
|
1303
1362
|
* User ID. When the draft order was created by a Wix user.
|
|
1304
1363
|
* @format GUID
|
|
@@ -1310,13 +1369,13 @@ export interface CreatedByStringOneOf {
|
|
|
1310
1369
|
*/
|
|
1311
1370
|
appId?: string;
|
|
1312
1371
|
}
|
|
1313
|
-
|
|
1372
|
+
declare enum EditingStatus {
|
|
1314
1373
|
/** DraftOrder is in draft state. */
|
|
1315
1374
|
DRAFT = "DRAFT",
|
|
1316
1375
|
/** DraftOrder is in committed state. */
|
|
1317
1376
|
COMMITTED = "COMMITTED"
|
|
1318
1377
|
}
|
|
1319
|
-
|
|
1378
|
+
declare enum WeightUnit {
|
|
1320
1379
|
/** Weight unit can't be classified due to an error. */
|
|
1321
1380
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1322
1381
|
/** Kilograms. */
|
|
@@ -1324,7 +1383,7 @@ export declare enum WeightUnit {
|
|
|
1324
1383
|
/** Pounds. */
|
|
1325
1384
|
LB = "LB"
|
|
1326
1385
|
}
|
|
1327
|
-
|
|
1386
|
+
interface PriceSummary {
|
|
1328
1387
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1329
1388
|
subtotal?: Price;
|
|
1330
1389
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1338,14 +1397,14 @@ export interface PriceSummary {
|
|
|
1338
1397
|
/** Total price of additional fees before tax. */
|
|
1339
1398
|
totalAdditionalFees?: Price;
|
|
1340
1399
|
}
|
|
1341
|
-
|
|
1400
|
+
interface TaxSummary {
|
|
1342
1401
|
/**
|
|
1343
1402
|
* Total tax.
|
|
1344
1403
|
* @readonly
|
|
1345
1404
|
*/
|
|
1346
1405
|
totalTax?: Price;
|
|
1347
1406
|
}
|
|
1348
|
-
|
|
1407
|
+
interface BalanceSummary {
|
|
1349
1408
|
/**
|
|
1350
1409
|
* Amount left to pay for order to be considered paid.
|
|
1351
1410
|
* @readonly
|
|
@@ -1364,7 +1423,7 @@ export interface BalanceSummary {
|
|
|
1364
1423
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1365
1424
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1366
1425
|
*/
|
|
1367
|
-
|
|
1426
|
+
interface Balance {
|
|
1368
1427
|
/**
|
|
1369
1428
|
* Balance amount.
|
|
1370
1429
|
*
|
|
@@ -1380,7 +1439,7 @@ export interface Balance {
|
|
|
1380
1439
|
formattedAmount?: string;
|
|
1381
1440
|
}
|
|
1382
1441
|
/** Side-effects upon committing a draft order. */
|
|
1383
|
-
|
|
1442
|
+
interface DraftOrderCommitSettings {
|
|
1384
1443
|
/**
|
|
1385
1444
|
* Whether to send notifications to the buyer.
|
|
1386
1445
|
*
|
|
@@ -1412,14 +1471,14 @@ export interface DraftOrderCommitSettings {
|
|
|
1412
1471
|
*/
|
|
1413
1472
|
updateInventory?: InventoryUpdate[];
|
|
1414
1473
|
}
|
|
1415
|
-
|
|
1474
|
+
interface InventoryUpdate {
|
|
1416
1475
|
/**
|
|
1417
1476
|
* Line item ID.
|
|
1418
1477
|
* @format GUID
|
|
1419
1478
|
*/
|
|
1420
1479
|
lineItemId?: string;
|
|
1421
1480
|
}
|
|
1422
|
-
|
|
1481
|
+
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1423
1482
|
/** Indicates that recipient information was added during draft. */
|
|
1424
1483
|
added?: boolean;
|
|
1425
1484
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1430,7 +1489,7 @@ export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneO
|
|
|
1430
1489
|
recipientInfo?: AddressWithContact;
|
|
1431
1490
|
}
|
|
1432
1491
|
/** @oneof */
|
|
1433
|
-
|
|
1492
|
+
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1434
1493
|
/** Indicates that recipient information was added during draft. */
|
|
1435
1494
|
added?: boolean;
|
|
1436
1495
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1438,11 +1497,11 @@ export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1438
1497
|
/** Indicates that recipient information was removed during draft. */
|
|
1439
1498
|
removed?: boolean;
|
|
1440
1499
|
}
|
|
1441
|
-
|
|
1500
|
+
interface RecipientInfoChangedDetails {
|
|
1442
1501
|
/** Order recipient address and contact details before draft. */
|
|
1443
1502
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1444
1503
|
}
|
|
1445
|
-
|
|
1504
|
+
interface OrderTaxInfo {
|
|
1446
1505
|
/** Calculated tax, added from line items. */
|
|
1447
1506
|
totalTax?: Price;
|
|
1448
1507
|
/**
|
|
@@ -1462,7 +1521,7 @@ export interface OrderTaxInfo {
|
|
|
1462
1521
|
* 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.
|
|
1463
1522
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1464
1523
|
*/
|
|
1465
|
-
|
|
1524
|
+
interface OrderTaxBreakdown {
|
|
1466
1525
|
/**
|
|
1467
1526
|
* The name of the tax against which this tax amount was calculated.
|
|
1468
1527
|
* @maxLength 200
|
|
@@ -1489,21 +1548,101 @@ export interface OrderTaxBreakdown {
|
|
|
1489
1548
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1490
1549
|
aggregatedTaxAmount?: Price;
|
|
1491
1550
|
}
|
|
1492
|
-
|
|
1551
|
+
interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1552
|
+
/**
|
|
1553
|
+
* Indicates that buyer information was added during draft.
|
|
1554
|
+
* @internal
|
|
1555
|
+
*/
|
|
1556
|
+
added?: boolean;
|
|
1557
|
+
/**
|
|
1558
|
+
* Indicates that buyer information was changed. Contains billing information before draft.
|
|
1559
|
+
* @internal
|
|
1560
|
+
*/
|
|
1561
|
+
changedDetails?: BuyerChangedDetails;
|
|
1562
|
+
/**
|
|
1563
|
+
* Indicates that buyer information was removed during draft.
|
|
1564
|
+
* @internal
|
|
1565
|
+
*/
|
|
1566
|
+
removed?: boolean;
|
|
1567
|
+
/**
|
|
1568
|
+
* Buyer information.
|
|
1569
|
+
* @internal
|
|
1570
|
+
*/
|
|
1571
|
+
buyerInfo?: BuyerInfo;
|
|
1493
1572
|
}
|
|
1494
1573
|
/** @oneof */
|
|
1495
|
-
|
|
1574
|
+
interface BuyerDetailsChangeTypeOneOf {
|
|
1575
|
+
/**
|
|
1576
|
+
* Indicates that buyer information was added during draft.
|
|
1577
|
+
* @internal
|
|
1578
|
+
*/
|
|
1579
|
+
added?: boolean;
|
|
1580
|
+
/**
|
|
1581
|
+
* Indicates that buyer information was changed. Contains billing information before draft.
|
|
1582
|
+
* @internal
|
|
1583
|
+
*/
|
|
1584
|
+
changedDetails?: BuyerChangedDetails;
|
|
1585
|
+
/**
|
|
1586
|
+
* Indicates that buyer information was removed during draft.
|
|
1587
|
+
* @internal
|
|
1588
|
+
*/
|
|
1589
|
+
removed?: boolean;
|
|
1496
1590
|
}
|
|
1497
|
-
|
|
1591
|
+
interface BuyerChangedDetails {
|
|
1592
|
+
/**
|
|
1593
|
+
* Buyer information before draft.
|
|
1594
|
+
* @internal
|
|
1595
|
+
*/
|
|
1596
|
+
buyerInfoBeforeChange?: BuyerInfo;
|
|
1498
1597
|
}
|
|
1499
|
-
|
|
1598
|
+
interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1599
|
+
/**
|
|
1600
|
+
* Indicates that billing information was added during draft.
|
|
1601
|
+
* @internal
|
|
1602
|
+
*/
|
|
1603
|
+
added?: boolean;
|
|
1604
|
+
/**
|
|
1605
|
+
* Indicates that billing information was changed. Contains billing information before draft.
|
|
1606
|
+
* @internal
|
|
1607
|
+
*/
|
|
1608
|
+
changedDetails?: BillingChangedDetails;
|
|
1609
|
+
/**
|
|
1610
|
+
* Indicates that billing information was removed during draft.
|
|
1611
|
+
* @internal
|
|
1612
|
+
*/
|
|
1613
|
+
removed?: boolean;
|
|
1614
|
+
/**
|
|
1615
|
+
* Billing address and contact details.
|
|
1616
|
+
* @internal
|
|
1617
|
+
*/
|
|
1618
|
+
billingInfo?: AddressWithContact;
|
|
1500
1619
|
}
|
|
1501
1620
|
/** @oneof */
|
|
1502
|
-
|
|
1621
|
+
interface BillingDetailsChangeTypeOneOf {
|
|
1622
|
+
/**
|
|
1623
|
+
* Indicates that billing information was added during draft.
|
|
1624
|
+
* @internal
|
|
1625
|
+
*/
|
|
1626
|
+
added?: boolean;
|
|
1627
|
+
/**
|
|
1628
|
+
* Indicates that billing information was changed. Contains billing information before draft.
|
|
1629
|
+
* @internal
|
|
1630
|
+
*/
|
|
1631
|
+
changedDetails?: BillingChangedDetails;
|
|
1632
|
+
/**
|
|
1633
|
+
* Indicates that billing information was removed during draft.
|
|
1634
|
+
* @internal
|
|
1635
|
+
*/
|
|
1636
|
+
removed?: boolean;
|
|
1503
1637
|
}
|
|
1504
|
-
|
|
1638
|
+
interface BillingChangedDetails {
|
|
1639
|
+
/**
|
|
1640
|
+
* Billing address and contact details before draft.
|
|
1641
|
+
* @internal
|
|
1642
|
+
*/
|
|
1643
|
+
billingInfoBeforeChange?: AddressWithContact;
|
|
1505
1644
|
}
|
|
1506
|
-
|
|
1645
|
+
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1507
1646
|
/** Indicates that business location was added during draft. */
|
|
1508
1647
|
added?: boolean;
|
|
1509
1648
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1514,7 +1653,7 @@ export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTy
|
|
|
1514
1653
|
businessLocation?: Location;
|
|
1515
1654
|
}
|
|
1516
1655
|
/** @oneof */
|
|
1517
|
-
|
|
1656
|
+
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1518
1657
|
/** Indicates that business location was added during draft. */
|
|
1519
1658
|
added?: boolean;
|
|
1520
1659
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1522,13 +1661,13 @@ export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1522
1661
|
/** Indicates that business location was removed during draft. */
|
|
1523
1662
|
removed?: boolean;
|
|
1524
1663
|
}
|
|
1525
|
-
|
|
1664
|
+
interface Location {
|
|
1526
1665
|
/**
|
|
1527
1666
|
* Location ID.
|
|
1528
1667
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1529
1668
|
* @format GUID
|
|
1530
1669
|
*/
|
|
1531
|
-
|
|
1670
|
+
_id?: string;
|
|
1532
1671
|
/**
|
|
1533
1672
|
* Location name.
|
|
1534
1673
|
* @minLength 1
|
|
@@ -1537,22 +1676,27 @@ export interface Location {
|
|
|
1537
1676
|
*/
|
|
1538
1677
|
name?: string;
|
|
1539
1678
|
}
|
|
1540
|
-
|
|
1679
|
+
interface BusinessLocationChangedDetails {
|
|
1541
1680
|
/** Business location before draft. */
|
|
1542
1681
|
businessLocationBeforeChange?: Location;
|
|
1543
1682
|
}
|
|
1544
|
-
|
|
1683
|
+
interface CreateDraftOrderRequest {
|
|
1545
1684
|
/**
|
|
1546
1685
|
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1547
1686
|
* @format GUID
|
|
1548
1687
|
*/
|
|
1549
1688
|
orderId: string | null;
|
|
1550
1689
|
}
|
|
1551
|
-
|
|
1690
|
+
interface CreateDraftOrderResponse {
|
|
1552
1691
|
/** The draft order details calculated with latest content */
|
|
1553
1692
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1693
|
+
/**
|
|
1694
|
+
* Whether the draft order already exists.
|
|
1695
|
+
* @internal
|
|
1696
|
+
*/
|
|
1697
|
+
preexistingDraftOrder?: boolean | null;
|
|
1554
1698
|
}
|
|
1555
|
-
|
|
1699
|
+
interface CalculatedDraftOrder {
|
|
1556
1700
|
/**
|
|
1557
1701
|
* The draft order full details with calculations based on it's content.
|
|
1558
1702
|
* Discount and additional fee options are also included.
|
|
@@ -1563,7 +1707,7 @@ export interface CalculatedDraftOrder {
|
|
|
1563
1707
|
/** Errors that occurred during calculation. */
|
|
1564
1708
|
calculationErrors?: CalculationErrors;
|
|
1565
1709
|
}
|
|
1566
|
-
|
|
1710
|
+
interface ShippingOption {
|
|
1567
1711
|
/**
|
|
1568
1712
|
* This carrier's unique ID
|
|
1569
1713
|
* @format GUID
|
|
@@ -1578,7 +1722,7 @@ export interface ShippingOption {
|
|
|
1578
1722
|
/** Shipping cost. */
|
|
1579
1723
|
cost?: ShippingPrice;
|
|
1580
1724
|
}
|
|
1581
|
-
|
|
1725
|
+
interface DeliveryLogistics {
|
|
1582
1726
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1583
1727
|
deliveryTime?: string | null;
|
|
1584
1728
|
/** Instructions for caller, e.g for pickup: "Ensure to come during Opening Hours, and please don't park in disabled-spot" */
|
|
@@ -1588,7 +1732,7 @@ export interface DeliveryLogistics {
|
|
|
1588
1732
|
/** Expected delivery time slot (from and to time stamps representation) */
|
|
1589
1733
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1590
1734
|
}
|
|
1591
|
-
|
|
1735
|
+
interface PickupDetails {
|
|
1592
1736
|
/** Pickup address */
|
|
1593
1737
|
address?: Address;
|
|
1594
1738
|
/**
|
|
@@ -1600,18 +1744,18 @@ export interface PickupDetails {
|
|
|
1600
1744
|
*/
|
|
1601
1745
|
pickupMethod?: PickupMethod;
|
|
1602
1746
|
}
|
|
1603
|
-
|
|
1747
|
+
declare enum PickupMethod {
|
|
1604
1748
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1605
1749
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1606
1750
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1607
1751
|
}
|
|
1608
|
-
|
|
1752
|
+
interface DeliveryTimeSlot {
|
|
1609
1753
|
/** starting time of the delivery time slot */
|
|
1610
1754
|
from?: Date | null;
|
|
1611
1755
|
/** ending time of the delivery time slot */
|
|
1612
1756
|
to?: Date | null;
|
|
1613
1757
|
}
|
|
1614
|
-
|
|
1758
|
+
interface ShippingPrice {
|
|
1615
1759
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1616
1760
|
price?: Price;
|
|
1617
1761
|
/**
|
|
@@ -1620,7 +1764,7 @@ export interface ShippingPrice {
|
|
|
1620
1764
|
*/
|
|
1621
1765
|
currency?: string;
|
|
1622
1766
|
}
|
|
1623
|
-
|
|
1767
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1624
1768
|
/** General shipping calculation error. */
|
|
1625
1769
|
generalShippingCalculationError?: Details;
|
|
1626
1770
|
/** Carrier errors. */
|
|
@@ -1631,13 +1775,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1631
1775
|
orderValidationErrors?: ApplicationError[];
|
|
1632
1776
|
}
|
|
1633
1777
|
/** @oneof */
|
|
1634
|
-
|
|
1778
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1635
1779
|
/** General shipping calculation error. */
|
|
1636
1780
|
generalShippingCalculationError?: Details;
|
|
1637
1781
|
/** Carrier errors. */
|
|
1638
1782
|
carrierErrors?: CarrierErrors;
|
|
1639
1783
|
}
|
|
1640
|
-
|
|
1784
|
+
interface Details extends DetailsKindOneOf {
|
|
1641
1785
|
applicationError?: ApplicationError;
|
|
1642
1786
|
validationError?: ValidationError;
|
|
1643
1787
|
systemError?: SystemError;
|
|
@@ -1648,12 +1792,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1648
1792
|
tracing?: Record<string, string>;
|
|
1649
1793
|
}
|
|
1650
1794
|
/** @oneof */
|
|
1651
|
-
|
|
1795
|
+
interface DetailsKindOneOf {
|
|
1652
1796
|
applicationError?: ApplicationError;
|
|
1653
1797
|
validationError?: ValidationError;
|
|
1654
1798
|
systemError?: SystemError;
|
|
1655
1799
|
}
|
|
1656
|
-
|
|
1800
|
+
interface ApplicationError {
|
|
1657
1801
|
/** Error code. */
|
|
1658
1802
|
code?: string;
|
|
1659
1803
|
/** Description of the error. */
|
|
@@ -1693,10 +1837,10 @@ export interface ApplicationError {
|
|
|
1693
1837
|
* ]
|
|
1694
1838
|
* }
|
|
1695
1839
|
*/
|
|
1696
|
-
|
|
1840
|
+
interface ValidationError {
|
|
1697
1841
|
fieldViolations?: FieldViolation[];
|
|
1698
1842
|
}
|
|
1699
|
-
|
|
1843
|
+
declare enum RuleType {
|
|
1700
1844
|
VALIDATION = "VALIDATION",
|
|
1701
1845
|
OTHER = "OTHER",
|
|
1702
1846
|
MAX = "MAX",
|
|
@@ -1719,7 +1863,7 @@ export declare enum RuleType {
|
|
|
1719
1863
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1720
1864
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1721
1865
|
}
|
|
1722
|
-
|
|
1866
|
+
interface FieldViolation {
|
|
1723
1867
|
field?: string;
|
|
1724
1868
|
description?: string;
|
|
1725
1869
|
violatedRule?: RuleType;
|
|
@@ -1727,27 +1871,27 @@ export interface FieldViolation {
|
|
|
1727
1871
|
ruleName?: string | null;
|
|
1728
1872
|
data?: Record<string, any> | null;
|
|
1729
1873
|
}
|
|
1730
|
-
|
|
1874
|
+
interface SystemError {
|
|
1731
1875
|
/** Error code. */
|
|
1732
1876
|
errorCode?: string | null;
|
|
1733
1877
|
}
|
|
1734
|
-
|
|
1878
|
+
interface CarrierErrors {
|
|
1735
1879
|
/** Carrier errors. */
|
|
1736
1880
|
errors?: CarrierError[];
|
|
1737
1881
|
}
|
|
1738
|
-
|
|
1882
|
+
interface CarrierError {
|
|
1739
1883
|
/** Carrier ID. */
|
|
1740
1884
|
carrierId?: string;
|
|
1741
1885
|
/** Error details. */
|
|
1742
1886
|
error?: Details;
|
|
1743
1887
|
}
|
|
1744
|
-
|
|
1888
|
+
interface CreateEmptyDraftOrderRequest {
|
|
1745
1889
|
}
|
|
1746
|
-
|
|
1890
|
+
interface CreateEmptyDraftOrderResponse {
|
|
1747
1891
|
/** The draft order details calculated with latest content */
|
|
1748
1892
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1749
1893
|
}
|
|
1750
|
-
|
|
1894
|
+
interface AddLineItemsToDraftOrderRequest {
|
|
1751
1895
|
/**
|
|
1752
1896
|
* The draft order id
|
|
1753
1897
|
* @format GUID
|
|
@@ -1764,7 +1908,7 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1764
1908
|
*/
|
|
1765
1909
|
customLineItems?: CustomLineItem[];
|
|
1766
1910
|
}
|
|
1767
|
-
|
|
1911
|
+
interface CatalogReferenceLineItem {
|
|
1768
1912
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
1769
1913
|
catalogReference?: CatalogReference;
|
|
1770
1914
|
/**
|
|
@@ -1783,12 +1927,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1783
1927
|
*/
|
|
1784
1928
|
locations?: LocationAndQuantity[];
|
|
1785
1929
|
}
|
|
1786
|
-
|
|
1930
|
+
interface CustomLineItem {
|
|
1787
1931
|
/**
|
|
1788
1932
|
* Line item ID.
|
|
1789
1933
|
* @format GUID
|
|
1790
1934
|
*/
|
|
1791
|
-
|
|
1935
|
+
_id?: string | null;
|
|
1792
1936
|
/**
|
|
1793
1937
|
* Item quantity.
|
|
1794
1938
|
*
|
|
@@ -1808,7 +1952,7 @@ export interface CustomLineItem {
|
|
|
1808
1952
|
*/
|
|
1809
1953
|
productName?: ProductName;
|
|
1810
1954
|
/** URL to the item's page on the site. */
|
|
1811
|
-
url?:
|
|
1955
|
+
url?: string;
|
|
1812
1956
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
1813
1957
|
price?: Price;
|
|
1814
1958
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -1820,7 +1964,7 @@ export interface CustomLineItem {
|
|
|
1820
1964
|
/** Line item description lines. Used for display purposes for order. */
|
|
1821
1965
|
descriptionLines?: DescriptionLine[];
|
|
1822
1966
|
/** Line item image details. */
|
|
1823
|
-
media?:
|
|
1967
|
+
media?: string;
|
|
1824
1968
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
1825
1969
|
physicalProperties?: PhysicalProperties;
|
|
1826
1970
|
/** Item type. Either a preset type or custom. */
|
|
@@ -1840,19 +1984,13 @@ export interface CustomLineItem {
|
|
|
1840
1984
|
*/
|
|
1841
1985
|
locations?: LocationAndQuantity[];
|
|
1842
1986
|
}
|
|
1843
|
-
|
|
1844
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
1845
|
-
relativePath?: string;
|
|
1846
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
1847
|
-
url?: string | null;
|
|
1848
|
-
}
|
|
1849
|
-
export interface SecuredMedia {
|
|
1987
|
+
interface SecuredMedia {
|
|
1850
1988
|
/**
|
|
1851
1989
|
* Media ID in Wix Media Manager.
|
|
1852
1990
|
* @minLength 1
|
|
1853
1991
|
* @maxLength 100
|
|
1854
1992
|
*/
|
|
1855
|
-
|
|
1993
|
+
_id?: string;
|
|
1856
1994
|
/**
|
|
1857
1995
|
* Original filename.
|
|
1858
1996
|
* @minLength 1
|
|
@@ -1862,7 +2000,7 @@ export interface SecuredMedia {
|
|
|
1862
2000
|
/** File type. */
|
|
1863
2001
|
fileType?: FileType;
|
|
1864
2002
|
}
|
|
1865
|
-
|
|
2003
|
+
declare enum FileType {
|
|
1866
2004
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1867
2005
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
1868
2006
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -1870,11 +2008,11 @@ export declare enum FileType {
|
|
|
1870
2008
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
1871
2009
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
1872
2010
|
}
|
|
1873
|
-
|
|
2011
|
+
interface AddLineItemsToDraftOrderResponse {
|
|
1874
2012
|
/** The draft order details calculated with latest content */
|
|
1875
2013
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1876
2014
|
}
|
|
1877
|
-
|
|
2015
|
+
interface UpdateLineItemsRequest {
|
|
1878
2016
|
/**
|
|
1879
2017
|
* The draft order id
|
|
1880
2018
|
* @format GUID
|
|
@@ -1887,7 +2025,7 @@ export interface UpdateLineItemsRequest {
|
|
|
1887
2025
|
*/
|
|
1888
2026
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1889
2027
|
}
|
|
1890
|
-
|
|
2028
|
+
interface LineItemChangeDetails {
|
|
1891
2029
|
/**
|
|
1892
2030
|
* The line item id to change
|
|
1893
2031
|
* @format GUID
|
|
@@ -1906,11 +2044,11 @@ export interface LineItemChangeDetails {
|
|
|
1906
2044
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1907
2045
|
newPriceDescription?: PriceDescription;
|
|
1908
2046
|
}
|
|
1909
|
-
|
|
2047
|
+
interface UpdateLineItemsResponse {
|
|
1910
2048
|
/** The draft order details calculated with latest content */
|
|
1911
2049
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1912
2050
|
}
|
|
1913
|
-
|
|
2051
|
+
interface SetDiscountsRequest {
|
|
1914
2052
|
/**
|
|
1915
2053
|
* The draft order id
|
|
1916
2054
|
* @format GUID
|
|
@@ -1922,17 +2060,17 @@ export interface SetDiscountsRequest {
|
|
|
1922
2060
|
*/
|
|
1923
2061
|
discounts: IdAndApplied[];
|
|
1924
2062
|
}
|
|
1925
|
-
|
|
2063
|
+
interface IdAndApplied {
|
|
1926
2064
|
/** Discount ID. */
|
|
1927
|
-
|
|
2065
|
+
_id?: string;
|
|
1928
2066
|
/** Whether to apply the discount to the draft order. */
|
|
1929
2067
|
applied?: boolean;
|
|
1930
2068
|
}
|
|
1931
|
-
|
|
2069
|
+
interface SetDiscountsResponse {
|
|
1932
2070
|
/** The draft order details calculated with latest content */
|
|
1933
2071
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1934
2072
|
}
|
|
1935
|
-
|
|
2073
|
+
interface CreateCustomDiscountsRequest {
|
|
1936
2074
|
/**
|
|
1937
2075
|
* The draft order id
|
|
1938
2076
|
* @format GUID
|
|
@@ -1945,7 +2083,19 @@ export interface CreateCustomDiscountsRequest {
|
|
|
1945
2083
|
*/
|
|
1946
2084
|
discounts?: DiscountOption[];
|
|
1947
2085
|
}
|
|
1948
|
-
|
|
2086
|
+
interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2087
|
+
/**
|
|
2088
|
+
* Discount price amount.
|
|
2089
|
+
* @internal
|
|
2090
|
+
*/
|
|
2091
|
+
priceAmount?: Price;
|
|
2092
|
+
/**
|
|
2093
|
+
* Discount percentage amount.
|
|
2094
|
+
* @internal
|
|
2095
|
+
* @format DECIMAL_VALUE
|
|
2096
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
2097
|
+
*/
|
|
2098
|
+
percentage?: string | null;
|
|
1949
2099
|
/**
|
|
1950
2100
|
* Discount type.
|
|
1951
2101
|
* * `"GLOBAL"` - discount applies to entire order.
|
|
@@ -1980,19 +2130,31 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1980
2130
|
applyToDraftOrder?: boolean | null;
|
|
1981
2131
|
}
|
|
1982
2132
|
/** @oneof */
|
|
1983
|
-
|
|
2133
|
+
interface DiscountOptionDiscountAmountOneOf {
|
|
2134
|
+
/**
|
|
2135
|
+
* Discount price amount.
|
|
2136
|
+
* @internal
|
|
2137
|
+
*/
|
|
2138
|
+
priceAmount?: Price;
|
|
2139
|
+
/**
|
|
2140
|
+
* Discount percentage amount.
|
|
2141
|
+
* @internal
|
|
2142
|
+
* @format DECIMAL_VALUE
|
|
2143
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
2144
|
+
*/
|
|
2145
|
+
percentage?: string | null;
|
|
1984
2146
|
}
|
|
1985
|
-
|
|
2147
|
+
declare enum DiscountType {
|
|
1986
2148
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1987
2149
|
GLOBAL = "GLOBAL",
|
|
1988
2150
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1989
2151
|
SHIPPING = "SHIPPING"
|
|
1990
2152
|
}
|
|
1991
|
-
|
|
2153
|
+
interface CreateCustomDiscountsResponse {
|
|
1992
2154
|
/** The draft order details with the added discounts */
|
|
1993
2155
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1994
2156
|
}
|
|
1995
|
-
|
|
2157
|
+
interface DeleteCustomDiscountsRequest {
|
|
1996
2158
|
/**
|
|
1997
2159
|
* The draft order id
|
|
1998
2160
|
* @format GUID
|
|
@@ -2006,11 +2168,11 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
2006
2168
|
*/
|
|
2007
2169
|
discountIds: string[];
|
|
2008
2170
|
}
|
|
2009
|
-
|
|
2171
|
+
interface DeleteCustomDiscountsResponse {
|
|
2010
2172
|
/** The draft order details calculated with latest content */
|
|
2011
2173
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2012
2174
|
}
|
|
2013
|
-
|
|
2175
|
+
interface SetAdditionalFeesRequest {
|
|
2014
2176
|
/**
|
|
2015
2177
|
* The draft order id
|
|
2016
2178
|
* @format GUID
|
|
@@ -2023,11 +2185,11 @@ export interface SetAdditionalFeesRequest {
|
|
|
2023
2185
|
*/
|
|
2024
2186
|
additionalFees: IdAndApplied[];
|
|
2025
2187
|
}
|
|
2026
|
-
|
|
2188
|
+
interface SetAdditionalFeesResponse {
|
|
2027
2189
|
/** The draft order details calculated with modified additional fees */
|
|
2028
2190
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2029
2191
|
}
|
|
2030
|
-
|
|
2192
|
+
interface CreateCustomAdditionalFeesRequest {
|
|
2031
2193
|
/**
|
|
2032
2194
|
* The draft order id
|
|
2033
2195
|
* @format GUID
|
|
@@ -2040,7 +2202,7 @@ export interface CreateCustomAdditionalFeesRequest {
|
|
|
2040
2202
|
*/
|
|
2041
2203
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2042
2204
|
}
|
|
2043
|
-
|
|
2205
|
+
interface AdditionalFeeOption {
|
|
2044
2206
|
/**
|
|
2045
2207
|
* Translated additional fee's name
|
|
2046
2208
|
* @minLength 1
|
|
@@ -2063,11 +2225,11 @@ export interface AdditionalFeeOption {
|
|
|
2063
2225
|
*/
|
|
2064
2226
|
code?: string | null;
|
|
2065
2227
|
}
|
|
2066
|
-
|
|
2228
|
+
interface CreateCustomAdditionalFeesResponse {
|
|
2067
2229
|
/** The draft order details with added custom additional fees */
|
|
2068
2230
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2069
2231
|
}
|
|
2070
|
-
|
|
2232
|
+
interface DeleteCustomAdditionalFeesRequest {
|
|
2071
2233
|
/**
|
|
2072
2234
|
* The draft order id
|
|
2073
2235
|
* @format GUID
|
|
@@ -2081,27 +2243,91 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2081
2243
|
*/
|
|
2082
2244
|
customAdditionalFees: string[];
|
|
2083
2245
|
}
|
|
2084
|
-
|
|
2246
|
+
interface DeleteCustomAdditionalFeesResponse {
|
|
2085
2247
|
/** The draft order details calculated with latest content */
|
|
2086
2248
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2087
2249
|
}
|
|
2088
|
-
|
|
2250
|
+
interface SetShippingInfoRequest {
|
|
2251
|
+
/**
|
|
2252
|
+
* The draft order id
|
|
2253
|
+
* @internal
|
|
2254
|
+
* @format GUID
|
|
2255
|
+
*/
|
|
2256
|
+
draftOrderId: string;
|
|
2257
|
+
/**
|
|
2258
|
+
* The shipping info to be set. If passed empty value - value will be reset
|
|
2259
|
+
* @internal
|
|
2260
|
+
*/
|
|
2261
|
+
shippingInfo?: V1ShippingInformation;
|
|
2089
2262
|
}
|
|
2090
|
-
|
|
2263
|
+
interface SetShippingInfoResponse {
|
|
2264
|
+
/**
|
|
2265
|
+
* The draft order details calculated with updated shipping info
|
|
2266
|
+
* @internal
|
|
2267
|
+
*/
|
|
2268
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2091
2269
|
}
|
|
2092
|
-
|
|
2270
|
+
interface SetBuyerInfoRequest {
|
|
2271
|
+
/**
|
|
2272
|
+
* The draft order id
|
|
2273
|
+
* @internal
|
|
2274
|
+
* @format GUID
|
|
2275
|
+
*/
|
|
2276
|
+
draftOrderId: string;
|
|
2277
|
+
/**
|
|
2278
|
+
* Buyer information. If passed empty value - value will be reset
|
|
2279
|
+
* @internal
|
|
2280
|
+
*/
|
|
2281
|
+
buyerInfo?: BuyerInfo;
|
|
2093
2282
|
}
|
|
2094
|
-
|
|
2283
|
+
interface SetBuyerInfoResponse {
|
|
2284
|
+
/**
|
|
2285
|
+
* The draft order details calculated with updated buyer info
|
|
2286
|
+
* @internal
|
|
2287
|
+
*/
|
|
2288
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2095
2289
|
}
|
|
2096
|
-
|
|
2290
|
+
interface SetRecipientInfoRequest {
|
|
2291
|
+
/**
|
|
2292
|
+
* The draft order id
|
|
2293
|
+
* @internal
|
|
2294
|
+
* @format GUID
|
|
2295
|
+
*/
|
|
2296
|
+
draftOrderId: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* Order recipient address and contact details. If passed empty value - value will be reset
|
|
2299
|
+
* @internal
|
|
2300
|
+
*/
|
|
2301
|
+
recipientInfo?: AddressWithContact;
|
|
2097
2302
|
}
|
|
2098
|
-
|
|
2303
|
+
interface SetRecipientInfoResponse {
|
|
2304
|
+
/**
|
|
2305
|
+
* The draft order details calculated with updated recipient info
|
|
2306
|
+
* @internal
|
|
2307
|
+
*/
|
|
2308
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2099
2309
|
}
|
|
2100
|
-
|
|
2310
|
+
interface SetBillingInfoRequest {
|
|
2311
|
+
/**
|
|
2312
|
+
* The draft order id
|
|
2313
|
+
* @internal
|
|
2314
|
+
* @format GUID
|
|
2315
|
+
*/
|
|
2316
|
+
draftOrderId: string;
|
|
2317
|
+
/**
|
|
2318
|
+
* Billing address and contact details. If passed empty value - value will be reset
|
|
2319
|
+
* @internal
|
|
2320
|
+
*/
|
|
2321
|
+
billingInfo?: AddressWithContact;
|
|
2101
2322
|
}
|
|
2102
|
-
|
|
2323
|
+
interface SetBillingInfoResponse {
|
|
2324
|
+
/**
|
|
2325
|
+
* The draft order details calculated with updated billing info
|
|
2326
|
+
* @internal
|
|
2327
|
+
*/
|
|
2328
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2103
2329
|
}
|
|
2104
|
-
|
|
2330
|
+
interface UpdateShippingInfoRequest {
|
|
2105
2331
|
/**
|
|
2106
2332
|
* The draft order id
|
|
2107
2333
|
* @format GUID
|
|
@@ -2110,22 +2336,22 @@ export interface UpdateShippingInfoRequest {
|
|
|
2110
2336
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
2111
2337
|
shippingOption?: ShippingOption;
|
|
2112
2338
|
}
|
|
2113
|
-
|
|
2339
|
+
interface UpdateShippingInfoResponse {
|
|
2114
2340
|
/** The draft order details calculated with de/selected shipping info */
|
|
2115
2341
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2116
2342
|
}
|
|
2117
|
-
|
|
2343
|
+
interface GetDraftOrderRequest {
|
|
2118
2344
|
/**
|
|
2119
2345
|
* The draft order id
|
|
2120
2346
|
* @format GUID
|
|
2121
2347
|
*/
|
|
2122
2348
|
draftOrderId: string;
|
|
2123
2349
|
}
|
|
2124
|
-
|
|
2350
|
+
interface GetDraftOrderResponse {
|
|
2125
2351
|
/** The draft order details calculated with latest content */
|
|
2126
2352
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2127
2353
|
}
|
|
2128
|
-
|
|
2354
|
+
interface GetOrderDraftabilityStatusRequest {
|
|
2129
2355
|
/**
|
|
2130
2356
|
* Order ID.
|
|
2131
2357
|
* @minLength 1
|
|
@@ -2133,7 +2359,7 @@ export interface GetOrderDraftabilityStatusRequest {
|
|
|
2133
2359
|
*/
|
|
2134
2360
|
orderId: string;
|
|
2135
2361
|
}
|
|
2136
|
-
|
|
2362
|
+
interface GetOrderDraftabilityStatusResponse {
|
|
2137
2363
|
/**
|
|
2138
2364
|
* Order ID.
|
|
2139
2365
|
* @minLength 1
|
|
@@ -2148,7 +2374,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2148
2374
|
*/
|
|
2149
2375
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2150
2376
|
}
|
|
2151
|
-
|
|
2377
|
+
declare enum NonDraftableReason {
|
|
2152
2378
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2153
2379
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2154
2380
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
@@ -2162,7 +2388,7 @@ export declare enum NonDraftableReason {
|
|
|
2162
2388
|
UNSUPPORTED_CATALOG_ITEM = "UNSUPPORTED_CATALOG_ITEM",
|
|
2163
2389
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2164
2390
|
}
|
|
2165
|
-
|
|
2391
|
+
interface CommitDraftOrderRequest {
|
|
2166
2392
|
/**
|
|
2167
2393
|
* The draft order id
|
|
2168
2394
|
* @format GUID
|
|
@@ -2176,19 +2402,19 @@ export interface CommitDraftOrderRequest {
|
|
|
2176
2402
|
*/
|
|
2177
2403
|
reason?: string | null;
|
|
2178
2404
|
}
|
|
2179
|
-
|
|
2405
|
+
interface CommitDraftOrderResponse {
|
|
2180
2406
|
/** The draft order after commit. */
|
|
2181
2407
|
committedDraftOrder?: DraftOrder;
|
|
2182
2408
|
/** The updated order after commit. */
|
|
2183
2409
|
orderAfterCommit?: Order;
|
|
2184
2410
|
}
|
|
2185
|
-
|
|
2411
|
+
interface Order {
|
|
2186
2412
|
/**
|
|
2187
2413
|
* Order ID.
|
|
2188
2414
|
* @format GUID
|
|
2189
2415
|
* @readonly
|
|
2190
2416
|
*/
|
|
2191
|
-
|
|
2417
|
+
_id?: string | null;
|
|
2192
2418
|
/**
|
|
2193
2419
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2194
2420
|
* @readonly
|
|
@@ -2199,12 +2425,12 @@ export interface Order {
|
|
|
2199
2425
|
* @readonly
|
|
2200
2426
|
* @immutable
|
|
2201
2427
|
*/
|
|
2202
|
-
|
|
2428
|
+
_createdDate?: Date | null;
|
|
2203
2429
|
/**
|
|
2204
2430
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2205
2431
|
* @readonly
|
|
2206
2432
|
*/
|
|
2207
|
-
|
|
2433
|
+
_updatedDate?: Date | null;
|
|
2208
2434
|
/**
|
|
2209
2435
|
* Order line items.
|
|
2210
2436
|
* @minSize 1
|
|
@@ -2349,8 +2575,14 @@ export interface Order {
|
|
|
2349
2575
|
purchasedDate?: Date | null;
|
|
2350
2576
|
/** Order Location */
|
|
2351
2577
|
businessLocation?: Location;
|
|
2578
|
+
/**
|
|
2579
|
+
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
2580
|
+
* @internal
|
|
2581
|
+
* @readonly
|
|
2582
|
+
*/
|
|
2583
|
+
payAfterFreeTrial?: PriceSummary;
|
|
2352
2584
|
}
|
|
2353
|
-
|
|
2585
|
+
declare enum PaymentStatus {
|
|
2354
2586
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2355
2587
|
/**
|
|
2356
2588
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2391,7 +2623,7 @@ export declare enum PaymentStatus {
|
|
|
2391
2623
|
*/
|
|
2392
2624
|
DECLINED = "DECLINED"
|
|
2393
2625
|
}
|
|
2394
|
-
|
|
2626
|
+
declare enum FulfillmentStatus {
|
|
2395
2627
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2396
2628
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2397
2629
|
/**
|
|
@@ -2402,7 +2634,7 @@ export declare enum FulfillmentStatus {
|
|
|
2402
2634
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2403
2635
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2404
2636
|
}
|
|
2405
|
-
|
|
2637
|
+
interface CurrencyConversionDetails {
|
|
2406
2638
|
/**
|
|
2407
2639
|
* Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
2408
2640
|
* @readonly
|
|
@@ -2418,7 +2650,7 @@ export interface CurrencyConversionDetails {
|
|
|
2418
2650
|
*/
|
|
2419
2651
|
conversionRate?: string | null;
|
|
2420
2652
|
}
|
|
2421
|
-
|
|
2653
|
+
declare enum OrderStatus {
|
|
2422
2654
|
/** Order created, but not yet approved or canceled. */
|
|
2423
2655
|
INITIALIZED = "INITIALIZED",
|
|
2424
2656
|
/**
|
|
@@ -2443,19 +2675,73 @@ export declare enum OrderStatus {
|
|
|
2443
2675
|
*/
|
|
2444
2676
|
REJECTED = "REJECTED"
|
|
2445
2677
|
}
|
|
2446
|
-
|
|
2678
|
+
interface Activity extends ActivityContentOneOf {
|
|
2447
2679
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2448
2680
|
customActivity?: CustomActivity;
|
|
2449
2681
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2450
2682
|
merchantComment?: MerchantComment;
|
|
2451
2683
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2452
2684
|
orderRefunded?: OrderRefunded;
|
|
2685
|
+
/**
|
|
2686
|
+
* Details of an initiated refund process.
|
|
2687
|
+
*
|
|
2688
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2689
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2690
|
+
* @internal
|
|
2691
|
+
*/
|
|
2692
|
+
refundInitiated?: RefundInitiated;
|
|
2693
|
+
/**
|
|
2694
|
+
* Details of a refunded payment.
|
|
2695
|
+
*
|
|
2696
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2697
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2698
|
+
* @internal
|
|
2699
|
+
*/
|
|
2700
|
+
paymentRefunded?: PaymentRefunded;
|
|
2701
|
+
/**
|
|
2702
|
+
* Details of a failed payment refund.
|
|
2703
|
+
*
|
|
2704
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2705
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2706
|
+
* @internal
|
|
2707
|
+
*/
|
|
2708
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2709
|
+
/**
|
|
2710
|
+
* Details of refund to store credit.
|
|
2711
|
+
* @internal
|
|
2712
|
+
*/
|
|
2713
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2714
|
+
/**
|
|
2715
|
+
* Details of a pending payment
|
|
2716
|
+
* @internal
|
|
2717
|
+
*/
|
|
2718
|
+
paymentPending?: PaymentPending;
|
|
2719
|
+
/**
|
|
2720
|
+
* Details of a canceled payment
|
|
2721
|
+
* @internal
|
|
2722
|
+
*/
|
|
2723
|
+
paymentCanceled?: PaymentCanceled;
|
|
2724
|
+
/**
|
|
2725
|
+
* Details of a declined payment
|
|
2726
|
+
* @internal
|
|
2727
|
+
*/
|
|
2728
|
+
paymentDeclined?: PaymentDeclined;
|
|
2729
|
+
/**
|
|
2730
|
+
* Receipt was added for associated payment
|
|
2731
|
+
* @internal
|
|
2732
|
+
*/
|
|
2733
|
+
receiptCreated?: ReceiptCreated;
|
|
2734
|
+
/**
|
|
2735
|
+
* Receipt sent to customer
|
|
2736
|
+
* @internal
|
|
2737
|
+
*/
|
|
2738
|
+
receiptSent?: ReceiptSent;
|
|
2453
2739
|
/**
|
|
2454
2740
|
* Activity ID.
|
|
2455
2741
|
* @format GUID
|
|
2456
2742
|
* @readonly
|
|
2457
2743
|
*/
|
|
2458
|
-
|
|
2744
|
+
_id?: string | null;
|
|
2459
2745
|
/**
|
|
2460
2746
|
* Activity author's email.
|
|
2461
2747
|
* @format EMAIL
|
|
@@ -2466,20 +2752,74 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2466
2752
|
* Activity creation date and time.
|
|
2467
2753
|
* @readonly
|
|
2468
2754
|
*/
|
|
2469
|
-
|
|
2755
|
+
_createdDate?: Date | null;
|
|
2470
2756
|
/** Activity type. */
|
|
2471
2757
|
type?: ActivityType;
|
|
2472
2758
|
}
|
|
2473
2759
|
/** @oneof */
|
|
2474
|
-
|
|
2760
|
+
interface ActivityContentOneOf {
|
|
2475
2761
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2476
2762
|
customActivity?: CustomActivity;
|
|
2477
2763
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2478
2764
|
merchantComment?: MerchantComment;
|
|
2479
2765
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2480
2766
|
orderRefunded?: OrderRefunded;
|
|
2767
|
+
/**
|
|
2768
|
+
* Details of an initiated refund process.
|
|
2769
|
+
*
|
|
2770
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2771
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2772
|
+
* @internal
|
|
2773
|
+
*/
|
|
2774
|
+
refundInitiated?: RefundInitiated;
|
|
2775
|
+
/**
|
|
2776
|
+
* Details of a refunded payment.
|
|
2777
|
+
*
|
|
2778
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2779
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2780
|
+
* @internal
|
|
2781
|
+
*/
|
|
2782
|
+
paymentRefunded?: PaymentRefunded;
|
|
2783
|
+
/**
|
|
2784
|
+
* Details of a failed payment refund.
|
|
2785
|
+
*
|
|
2786
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2787
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2788
|
+
* @internal
|
|
2789
|
+
*/
|
|
2790
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2791
|
+
/**
|
|
2792
|
+
* Details of refund to store credit.
|
|
2793
|
+
* @internal
|
|
2794
|
+
*/
|
|
2795
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2796
|
+
/**
|
|
2797
|
+
* Details of a pending payment
|
|
2798
|
+
* @internal
|
|
2799
|
+
*/
|
|
2800
|
+
paymentPending?: PaymentPending;
|
|
2801
|
+
/**
|
|
2802
|
+
* Details of a canceled payment
|
|
2803
|
+
* @internal
|
|
2804
|
+
*/
|
|
2805
|
+
paymentCanceled?: PaymentCanceled;
|
|
2806
|
+
/**
|
|
2807
|
+
* Details of a declined payment
|
|
2808
|
+
* @internal
|
|
2809
|
+
*/
|
|
2810
|
+
paymentDeclined?: PaymentDeclined;
|
|
2811
|
+
/**
|
|
2812
|
+
* Receipt was added for associated payment
|
|
2813
|
+
* @internal
|
|
2814
|
+
*/
|
|
2815
|
+
receiptCreated?: ReceiptCreated;
|
|
2816
|
+
/**
|
|
2817
|
+
* Receipt sent to customer
|
|
2818
|
+
* @internal
|
|
2819
|
+
*/
|
|
2820
|
+
receiptSent?: ReceiptSent;
|
|
2481
2821
|
}
|
|
2482
|
-
|
|
2822
|
+
interface CustomActivity {
|
|
2483
2823
|
/**
|
|
2484
2824
|
* ID of the app that created the custom activity.
|
|
2485
2825
|
* @format GUID
|
|
@@ -2494,7 +2834,7 @@ export interface CustomActivity {
|
|
|
2494
2834
|
additionalData?: Record<string, string>;
|
|
2495
2835
|
}
|
|
2496
2836
|
/** Store owner added a comment */
|
|
2497
|
-
|
|
2837
|
+
interface MerchantComment {
|
|
2498
2838
|
/**
|
|
2499
2839
|
* Merchant comment message.
|
|
2500
2840
|
* @minLength 1
|
|
@@ -2502,7 +2842,7 @@ export interface MerchantComment {
|
|
|
2502
2842
|
*/
|
|
2503
2843
|
message?: string;
|
|
2504
2844
|
}
|
|
2505
|
-
|
|
2845
|
+
interface OrderRefunded {
|
|
2506
2846
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2507
2847
|
manual?: boolean;
|
|
2508
2848
|
/** Refund amount. */
|
|
@@ -2513,14 +2853,14 @@ export interface OrderRefunded {
|
|
|
2513
2853
|
*/
|
|
2514
2854
|
reason?: string;
|
|
2515
2855
|
}
|
|
2516
|
-
|
|
2856
|
+
interface OrderCreatedFromExchange {
|
|
2517
2857
|
/**
|
|
2518
2858
|
* ID of the original order for which the exchange happened.
|
|
2519
2859
|
* @format GUID
|
|
2520
2860
|
*/
|
|
2521
2861
|
originalOrderId?: string;
|
|
2522
2862
|
}
|
|
2523
|
-
|
|
2863
|
+
interface NewExchangeOrderCreated {
|
|
2524
2864
|
/**
|
|
2525
2865
|
* ID of the new order created as a result of an exchange of items.
|
|
2526
2866
|
* @format GUID
|
|
@@ -2533,7 +2873,7 @@ export interface NewExchangeOrderCreated {
|
|
|
2533
2873
|
*/
|
|
2534
2874
|
lineItems?: LineItemExchangeData[];
|
|
2535
2875
|
}
|
|
2536
|
-
|
|
2876
|
+
interface LineItemExchangeData {
|
|
2537
2877
|
/**
|
|
2538
2878
|
* ID of the exchanged line item.
|
|
2539
2879
|
* @format GUID
|
|
@@ -2546,7 +2886,7 @@ export interface LineItemExchangeData {
|
|
|
2546
2886
|
*/
|
|
2547
2887
|
quantity?: number;
|
|
2548
2888
|
}
|
|
2549
|
-
|
|
2889
|
+
interface DraftOrderChangesApplied {
|
|
2550
2890
|
/** Draft order id. */
|
|
2551
2891
|
draftOrderId?: string;
|
|
2552
2892
|
/**
|
|
@@ -2557,7 +2897,7 @@ export interface DraftOrderChangesApplied {
|
|
|
2557
2897
|
/** Changes applied to order. */
|
|
2558
2898
|
changes?: OrderChange[];
|
|
2559
2899
|
}
|
|
2560
|
-
|
|
2900
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
2561
2901
|
lineItemChanged?: LineItemChanges;
|
|
2562
2902
|
lineItemAdded?: ManagedLineItem;
|
|
2563
2903
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2569,7 +2909,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2569
2909
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2570
2910
|
}
|
|
2571
2911
|
/** @oneof */
|
|
2572
|
-
|
|
2912
|
+
interface OrderChangeValueOneOf {
|
|
2573
2913
|
lineItemChanged?: LineItemChanges;
|
|
2574
2914
|
lineItemAdded?: ManagedLineItem;
|
|
2575
2915
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2580,12 +2920,12 @@ export interface OrderChangeValueOneOf {
|
|
|
2580
2920
|
totalPriceChanged?: TotalPriceChange;
|
|
2581
2921
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2582
2922
|
}
|
|
2583
|
-
|
|
2923
|
+
interface LineItemChanges {
|
|
2584
2924
|
/**
|
|
2585
2925
|
* Line item ID.
|
|
2586
2926
|
* @format GUID
|
|
2587
2927
|
*/
|
|
2588
|
-
|
|
2928
|
+
_id?: string;
|
|
2589
2929
|
/** Item name. */
|
|
2590
2930
|
name?: ProductName;
|
|
2591
2931
|
/** Item quantity change. */
|
|
@@ -2593,7 +2933,7 @@ export interface LineItemChanges {
|
|
|
2593
2933
|
/** Item price change. */
|
|
2594
2934
|
price?: LineItemPriceChange;
|
|
2595
2935
|
}
|
|
2596
|
-
|
|
2936
|
+
interface LineItemQuantityChange {
|
|
2597
2937
|
/**
|
|
2598
2938
|
* Item quantity before update.
|
|
2599
2939
|
* @max 1000000
|
|
@@ -2613,24 +2953,24 @@ export interface LineItemQuantityChange {
|
|
|
2613
2953
|
/** Type of quantity change: increase or decrease. */
|
|
2614
2954
|
deltaType?: LineItemQuantityChangeType;
|
|
2615
2955
|
}
|
|
2616
|
-
|
|
2956
|
+
declare enum LineItemQuantityChangeType {
|
|
2617
2957
|
/** Quantity increased. */
|
|
2618
2958
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2619
2959
|
/** Quantity decreased. */
|
|
2620
2960
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2621
2961
|
}
|
|
2622
|
-
|
|
2962
|
+
interface LineItemPriceChange {
|
|
2623
2963
|
/** Item price before update. */
|
|
2624
2964
|
originalPrice?: Price;
|
|
2625
2965
|
/** Item price after update. */
|
|
2626
2966
|
newPrice?: Price;
|
|
2627
2967
|
}
|
|
2628
|
-
|
|
2968
|
+
interface ManagedLineItem {
|
|
2629
2969
|
/**
|
|
2630
2970
|
* Line item ID.
|
|
2631
2971
|
* @format GUID
|
|
2632
2972
|
*/
|
|
2633
|
-
|
|
2973
|
+
_id?: string;
|
|
2634
2974
|
/** Item name. */
|
|
2635
2975
|
name?: ProductName;
|
|
2636
2976
|
/**
|
|
@@ -2640,12 +2980,12 @@ export interface ManagedLineItem {
|
|
|
2640
2980
|
*/
|
|
2641
2981
|
quantity?: number;
|
|
2642
2982
|
}
|
|
2643
|
-
|
|
2983
|
+
interface ManagedDiscount {
|
|
2644
2984
|
/**
|
|
2645
2985
|
* Discount id.
|
|
2646
2986
|
* @format GUID
|
|
2647
2987
|
*/
|
|
2648
|
-
|
|
2988
|
+
_id?: string;
|
|
2649
2989
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2650
2990
|
name?: TranslatedValue;
|
|
2651
2991
|
/** Line items discount applies to. */
|
|
@@ -2653,7 +2993,7 @@ export interface ManagedDiscount {
|
|
|
2653
2993
|
/** Discount amount. */
|
|
2654
2994
|
totalAmount?: Price;
|
|
2655
2995
|
}
|
|
2656
|
-
|
|
2996
|
+
interface TranslatedValue {
|
|
2657
2997
|
/**
|
|
2658
2998
|
* Value in site default language.
|
|
2659
2999
|
* @minLength 1
|
|
@@ -2665,23 +3005,23 @@ export interface TranslatedValue {
|
|
|
2665
3005
|
*/
|
|
2666
3006
|
translated?: string | null;
|
|
2667
3007
|
}
|
|
2668
|
-
|
|
3008
|
+
interface LineItemAmount {
|
|
2669
3009
|
/**
|
|
2670
3010
|
* Order line item id
|
|
2671
3011
|
* @format GUID
|
|
2672
3012
|
*/
|
|
2673
|
-
|
|
3013
|
+
_id?: string;
|
|
2674
3014
|
/** Item name. */
|
|
2675
3015
|
name?: ProductName;
|
|
2676
3016
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
2677
3017
|
amount?: Price;
|
|
2678
3018
|
}
|
|
2679
|
-
|
|
3019
|
+
interface ManagedAdditionalFee {
|
|
2680
3020
|
/**
|
|
2681
3021
|
* Additional fee id.
|
|
2682
3022
|
* @format GUID
|
|
2683
3023
|
*/
|
|
2684
|
-
|
|
3024
|
+
_id?: string;
|
|
2685
3025
|
/** Additional fee name. */
|
|
2686
3026
|
name?: TranslatedValue;
|
|
2687
3027
|
/** Line items additional fee applies to. */
|
|
@@ -2689,19 +3029,19 @@ export interface ManagedAdditionalFee {
|
|
|
2689
3029
|
/** Additional fee amount. */
|
|
2690
3030
|
totalAmount?: Price;
|
|
2691
3031
|
}
|
|
2692
|
-
|
|
3032
|
+
interface TotalPriceChange {
|
|
2693
3033
|
/** Order’s total price after discounts and tax. Before update */
|
|
2694
3034
|
originalTotal?: Price;
|
|
2695
3035
|
/** Order’s total price after discounts and tax. After update */
|
|
2696
3036
|
newTotal?: Price;
|
|
2697
3037
|
}
|
|
2698
|
-
|
|
3038
|
+
interface ShippingInformationChange {
|
|
2699
3039
|
/** Order’s Shipping Information. Before update */
|
|
2700
3040
|
originalShippingInfo?: ShippingInformation;
|
|
2701
3041
|
/** Order’s Shipping Information. After update */
|
|
2702
3042
|
newShippingInfo?: ShippingInformation;
|
|
2703
3043
|
}
|
|
2704
|
-
|
|
3044
|
+
interface ShippingInformation {
|
|
2705
3045
|
/** Order’s shipping price. */
|
|
2706
3046
|
total?: Price;
|
|
2707
3047
|
/**
|
|
@@ -2711,7 +3051,7 @@ export interface ShippingInformation {
|
|
|
2711
3051
|
shippingTitle?: string;
|
|
2712
3052
|
}
|
|
2713
3053
|
/** Payment method is saved for order */
|
|
2714
|
-
|
|
3054
|
+
interface SavedPaymentMethod {
|
|
2715
3055
|
/**
|
|
2716
3056
|
* Payment method name
|
|
2717
3057
|
* @minLength 1
|
|
@@ -2725,7 +3065,7 @@ export interface SavedPaymentMethod {
|
|
|
2725
3065
|
*/
|
|
2726
3066
|
description?: string | null;
|
|
2727
3067
|
}
|
|
2728
|
-
|
|
3068
|
+
interface AuthorizedPaymentCreated {
|
|
2729
3069
|
/**
|
|
2730
3070
|
* Payment ID of payment associated with this activity
|
|
2731
3071
|
* @format GUID
|
|
@@ -2744,7 +3084,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
2744
3084
|
*/
|
|
2745
3085
|
brand?: string | null;
|
|
2746
3086
|
}
|
|
2747
|
-
|
|
3087
|
+
interface AuthorizedPaymentCaptured {
|
|
2748
3088
|
/**
|
|
2749
3089
|
* Payment ID of payment associated with this activity
|
|
2750
3090
|
* @format GUID
|
|
@@ -2763,7 +3103,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
2763
3103
|
*/
|
|
2764
3104
|
brand?: string | null;
|
|
2765
3105
|
}
|
|
2766
|
-
|
|
3106
|
+
interface AuthorizedPaymentVoided {
|
|
2767
3107
|
/**
|
|
2768
3108
|
* Payment ID of payment associated with this activity
|
|
2769
3109
|
* @format GUID
|
|
@@ -2782,7 +3122,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
2782
3122
|
*/
|
|
2783
3123
|
brand?: string | null;
|
|
2784
3124
|
}
|
|
2785
|
-
|
|
3125
|
+
interface RefundInitiated {
|
|
2786
3126
|
/**
|
|
2787
3127
|
* Refund ID.
|
|
2788
3128
|
* @format GUID
|
|
@@ -2802,7 +3142,7 @@ export interface RefundInitiated {
|
|
|
2802
3142
|
*/
|
|
2803
3143
|
reason?: string | null;
|
|
2804
3144
|
}
|
|
2805
|
-
|
|
3145
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
2806
3146
|
/** Regular payment refund. */
|
|
2807
3147
|
regular?: RegularPaymentRefund;
|
|
2808
3148
|
/** Gift card payment refund. */
|
|
@@ -2818,7 +3158,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2818
3158
|
externalRefund?: boolean;
|
|
2819
3159
|
}
|
|
2820
3160
|
/** @oneof */
|
|
2821
|
-
|
|
3161
|
+
interface RefundedPaymentKindOneOf {
|
|
2822
3162
|
/** Regular payment refund. */
|
|
2823
3163
|
regular?: RegularPaymentRefund;
|
|
2824
3164
|
/** Gift card payment refund. */
|
|
@@ -2826,7 +3166,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
2826
3166
|
/** Membership payment refund. */
|
|
2827
3167
|
membership?: MembershipPaymentRefund;
|
|
2828
3168
|
}
|
|
2829
|
-
|
|
3169
|
+
interface RegularPaymentRefund {
|
|
2830
3170
|
/** Refund amount */
|
|
2831
3171
|
amount?: Price;
|
|
2832
3172
|
/**
|
|
@@ -2840,7 +3180,7 @@ export interface RegularPaymentRefund {
|
|
|
2840
3180
|
*/
|
|
2841
3181
|
brand?: string | null;
|
|
2842
3182
|
}
|
|
2843
|
-
|
|
3183
|
+
interface GiftCardPaymentRefund {
|
|
2844
3184
|
/**
|
|
2845
3185
|
* Gift card payment ID
|
|
2846
3186
|
* @minLength 1
|
|
@@ -2850,7 +3190,7 @@ export interface GiftCardPaymentRefund {
|
|
|
2850
3190
|
/** Refund amount */
|
|
2851
3191
|
amount?: Price;
|
|
2852
3192
|
}
|
|
2853
|
-
|
|
3193
|
+
interface MembershipPaymentRefund {
|
|
2854
3194
|
/**
|
|
2855
3195
|
* Membership ID
|
|
2856
3196
|
* @minLength 1
|
|
@@ -2858,7 +3198,7 @@ export interface MembershipPaymentRefund {
|
|
|
2858
3198
|
*/
|
|
2859
3199
|
membershipId?: string | null;
|
|
2860
3200
|
}
|
|
2861
|
-
|
|
3201
|
+
interface PaymentRefunded {
|
|
2862
3202
|
/**
|
|
2863
3203
|
* Refund ID.
|
|
2864
3204
|
* @format GUID
|
|
@@ -2867,7 +3207,7 @@ export interface PaymentRefunded {
|
|
|
2867
3207
|
/** Details about the refunded payment. */
|
|
2868
3208
|
payment?: RefundedPayment;
|
|
2869
3209
|
}
|
|
2870
|
-
|
|
3210
|
+
interface PaymentRefundFailed {
|
|
2871
3211
|
/**
|
|
2872
3212
|
* Refund ID.
|
|
2873
3213
|
* @format GUID
|
|
@@ -2876,7 +3216,7 @@ export interface PaymentRefundFailed {
|
|
|
2876
3216
|
/** Details about the failed payment refund. */
|
|
2877
3217
|
payment?: RefundedPayment;
|
|
2878
3218
|
}
|
|
2879
|
-
|
|
3219
|
+
interface RefundedAsStoreCredit {
|
|
2880
3220
|
/** Refund amount */
|
|
2881
3221
|
amount?: Price;
|
|
2882
3222
|
/**
|
|
@@ -2885,7 +3225,7 @@ export interface RefundedAsStoreCredit {
|
|
|
2885
3225
|
*/
|
|
2886
3226
|
reason?: string | null;
|
|
2887
3227
|
}
|
|
2888
|
-
|
|
3228
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2889
3229
|
/** Regular payment. */
|
|
2890
3230
|
regular?: RegularPayment;
|
|
2891
3231
|
/**
|
|
@@ -2895,22 +3235,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
2895
3235
|
paymentId?: string;
|
|
2896
3236
|
}
|
|
2897
3237
|
/** @oneof */
|
|
2898
|
-
|
|
3238
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
2899
3239
|
/** Regular payment. */
|
|
2900
3240
|
regular?: RegularPayment;
|
|
2901
3241
|
}
|
|
2902
|
-
|
|
3242
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
2903
3243
|
/** Whether regular card used */
|
|
2904
3244
|
creditCardDetails?: CreditCardDetails;
|
|
2905
3245
|
/** Payment amount */
|
|
2906
3246
|
amount?: Price;
|
|
2907
3247
|
}
|
|
2908
3248
|
/** @oneof */
|
|
2909
|
-
|
|
3249
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
2910
3250
|
/** Whether regular card used */
|
|
2911
3251
|
creditCardDetails?: CreditCardDetails;
|
|
2912
3252
|
}
|
|
2913
|
-
|
|
3253
|
+
interface CreditCardDetails {
|
|
2914
3254
|
/**
|
|
2915
3255
|
* The last 4 digits of the card number.
|
|
2916
3256
|
* @maxLength 4
|
|
@@ -2922,7 +3262,7 @@ export interface CreditCardDetails {
|
|
|
2922
3262
|
*/
|
|
2923
3263
|
brand?: string | null;
|
|
2924
3264
|
}
|
|
2925
|
-
|
|
3265
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2926
3266
|
/** Regular payment. */
|
|
2927
3267
|
regular?: RegularPayment;
|
|
2928
3268
|
/**
|
|
@@ -2932,11 +3272,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
2932
3272
|
paymentId?: string;
|
|
2933
3273
|
}
|
|
2934
3274
|
/** @oneof */
|
|
2935
|
-
|
|
3275
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
2936
3276
|
/** Regular payment. */
|
|
2937
3277
|
regular?: RegularPayment;
|
|
2938
3278
|
}
|
|
2939
|
-
|
|
3279
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2940
3280
|
/** Regular payment. */
|
|
2941
3281
|
regular?: RegularPayment;
|
|
2942
3282
|
/**
|
|
@@ -2946,11 +3286,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
2946
3286
|
paymentId?: string;
|
|
2947
3287
|
}
|
|
2948
3288
|
/** @oneof */
|
|
2949
|
-
|
|
3289
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
2950
3290
|
/** Regular payment. */
|
|
2951
3291
|
regular?: RegularPayment;
|
|
2952
3292
|
}
|
|
2953
|
-
|
|
3293
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
2954
3294
|
/** Receipt created by Wix */
|
|
2955
3295
|
wixReceipt?: WixReceipt;
|
|
2956
3296
|
/** Receipt created by an external system. */
|
|
@@ -2962,13 +3302,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2962
3302
|
paymentId?: string;
|
|
2963
3303
|
}
|
|
2964
3304
|
/** @oneof */
|
|
2965
|
-
|
|
3305
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
2966
3306
|
/** Receipt created by Wix */
|
|
2967
3307
|
wixReceipt?: WixReceipt;
|
|
2968
3308
|
/** Receipt created by an external system. */
|
|
2969
3309
|
externalReceipt?: ExternalReceipt;
|
|
2970
3310
|
}
|
|
2971
|
-
|
|
3311
|
+
interface WixReceipt {
|
|
2972
3312
|
/**
|
|
2973
3313
|
* Receipt ID
|
|
2974
3314
|
* @format GUID
|
|
@@ -2981,7 +3321,7 @@ export interface WixReceipt {
|
|
|
2981
3321
|
*/
|
|
2982
3322
|
displayNumber?: string | null;
|
|
2983
3323
|
}
|
|
2984
|
-
|
|
3324
|
+
interface ExternalReceipt {
|
|
2985
3325
|
/**
|
|
2986
3326
|
* Receipt ID
|
|
2987
3327
|
* @maxLength 100
|
|
@@ -2994,7 +3334,7 @@ export interface ExternalReceipt {
|
|
|
2994
3334
|
*/
|
|
2995
3335
|
displayNumber?: string | null;
|
|
2996
3336
|
}
|
|
2997
|
-
|
|
3337
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2998
3338
|
/** Receipt created by Wix */
|
|
2999
3339
|
wixReceipt?: WixReceipt;
|
|
3000
3340
|
/** Receipt created by an external system. */
|
|
@@ -3006,13 +3346,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
3006
3346
|
paymentId?: string;
|
|
3007
3347
|
}
|
|
3008
3348
|
/** @oneof */
|
|
3009
|
-
|
|
3349
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
3010
3350
|
/** Receipt created by Wix */
|
|
3011
3351
|
wixReceipt?: WixReceipt;
|
|
3012
3352
|
/** Receipt created by an external system. */
|
|
3013
3353
|
externalReceipt?: ExternalReceipt;
|
|
3014
3354
|
}
|
|
3015
|
-
|
|
3355
|
+
declare enum ActivityType {
|
|
3016
3356
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3017
3357
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3018
3358
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3049,11 +3389,11 @@ export declare enum ActivityType {
|
|
|
3049
3389
|
/** @documentationMaturity preview */
|
|
3050
3390
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3051
3391
|
}
|
|
3052
|
-
|
|
3392
|
+
declare enum AttributionSource {
|
|
3053
3393
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3054
3394
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3055
3395
|
}
|
|
3056
|
-
|
|
3396
|
+
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3057
3397
|
/**
|
|
3058
3398
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3059
3399
|
* For example, via POS (point of service).
|
|
@@ -3077,7 +3417,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3077
3417
|
appId?: string;
|
|
3078
3418
|
}
|
|
3079
3419
|
/** @oneof */
|
|
3080
|
-
|
|
3420
|
+
interface V1CreatedByStringOneOf {
|
|
3081
3421
|
/**
|
|
3082
3422
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3083
3423
|
* For example, via POS (point of service).
|
|
@@ -3100,7 +3440,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3100
3440
|
*/
|
|
3101
3441
|
appId?: string;
|
|
3102
3442
|
}
|
|
3103
|
-
|
|
3443
|
+
interface ChannelInfo {
|
|
3104
3444
|
/** Sales channel that submitted the order. */
|
|
3105
3445
|
type?: ChannelType;
|
|
3106
3446
|
/**
|
|
@@ -3114,7 +3454,7 @@ export interface ChannelInfo {
|
|
|
3114
3454
|
*/
|
|
3115
3455
|
externalOrderUrl?: string | null;
|
|
3116
3456
|
}
|
|
3117
|
-
|
|
3457
|
+
declare enum ChannelType {
|
|
3118
3458
|
/** Unspecified sales channel. This value is not supported. */
|
|
3119
3459
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3120
3460
|
/** A web client. */
|
|
@@ -3148,7 +3488,7 @@ export declare enum ChannelType {
|
|
|
3148
3488
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3149
3489
|
FAIRE_COM = "FAIRE_COM"
|
|
3150
3490
|
}
|
|
3151
|
-
|
|
3491
|
+
interface CustomField {
|
|
3152
3492
|
/** Custom field value. */
|
|
3153
3493
|
value?: any;
|
|
3154
3494
|
/**
|
|
@@ -3164,7 +3504,7 @@ export interface CustomField {
|
|
|
3164
3504
|
*/
|
|
3165
3505
|
translatedTitle?: string | null;
|
|
3166
3506
|
}
|
|
3167
|
-
|
|
3507
|
+
interface V1BalanceSummary {
|
|
3168
3508
|
/**
|
|
3169
3509
|
* Current amount left to pay.
|
|
3170
3510
|
* @readonly
|
|
@@ -3187,13 +3527,19 @@ export interface V1BalanceSummary {
|
|
|
3187
3527
|
* @readonly
|
|
3188
3528
|
*/
|
|
3189
3529
|
authorized?: Price;
|
|
3530
|
+
/**
|
|
3531
|
+
* Sum of all pending refund transactions.
|
|
3532
|
+
* @internal
|
|
3533
|
+
* @readonly
|
|
3534
|
+
*/
|
|
3535
|
+
pendingRefund?: Price;
|
|
3190
3536
|
/**
|
|
3191
3537
|
* Sum of all pending transactions.
|
|
3192
3538
|
* @readonly
|
|
3193
3539
|
*/
|
|
3194
3540
|
pending?: Price;
|
|
3195
3541
|
}
|
|
3196
|
-
|
|
3542
|
+
interface FulfillmentStatusesAggregate {
|
|
3197
3543
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3198
3544
|
statuses?: string[] | null;
|
|
3199
3545
|
}
|
|
@@ -3219,13 +3565,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
3219
3565
|
* }
|
|
3220
3566
|
* }
|
|
3221
3567
|
*/
|
|
3222
|
-
|
|
3568
|
+
interface Tags {
|
|
3223
3569
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3224
3570
|
privateTags?: TagList;
|
|
3225
3571
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3226
3572
|
tags?: TagList;
|
|
3227
3573
|
}
|
|
3228
|
-
|
|
3574
|
+
interface TagList {
|
|
3229
3575
|
/**
|
|
3230
3576
|
* List of tag IDs
|
|
3231
3577
|
* @maxSize 100
|
|
@@ -3233,28 +3579,79 @@ export interface TagList {
|
|
|
3233
3579
|
*/
|
|
3234
3580
|
tagIds?: string[];
|
|
3235
3581
|
}
|
|
3236
|
-
|
|
3582
|
+
interface CreateOrderFromDraftRequest {
|
|
3583
|
+
/**
|
|
3584
|
+
* The draft order id
|
|
3585
|
+
* @internal
|
|
3586
|
+
* @format GUID
|
|
3587
|
+
*/
|
|
3588
|
+
draftOrderId: string;
|
|
3589
|
+
/**
|
|
3590
|
+
* Optional side effects to trigger
|
|
3591
|
+
* @internal
|
|
3592
|
+
*/
|
|
3593
|
+
createSettings?: OrderCreateSettings;
|
|
3594
|
+
/**
|
|
3595
|
+
* Reason for order creation, given by user (optional).
|
|
3596
|
+
* @internal
|
|
3597
|
+
* @maxLength 200
|
|
3598
|
+
*/
|
|
3599
|
+
reason?: string | null;
|
|
3600
|
+
/**
|
|
3601
|
+
* Information about the sales channel that submitted this order
|
|
3602
|
+
* @internal
|
|
3603
|
+
*/
|
|
3604
|
+
channelInfo?: ChannelInfo;
|
|
3237
3605
|
}
|
|
3238
|
-
|
|
3606
|
+
interface OrderCreateSettings {
|
|
3607
|
+
/**
|
|
3608
|
+
* Notification settings to be applied on order creation
|
|
3609
|
+
* @internal
|
|
3610
|
+
*/
|
|
3611
|
+
notifications?: OrderCreateNotifications;
|
|
3239
3612
|
}
|
|
3240
|
-
|
|
3613
|
+
interface OrderCreateNotifications {
|
|
3614
|
+
/**
|
|
3615
|
+
* Whether to send notification to the buyer.
|
|
3616
|
+
*
|
|
3617
|
+
* Default: `true`
|
|
3618
|
+
* @internal
|
|
3619
|
+
*/
|
|
3620
|
+
sendNotificationToBuyer?: boolean | null;
|
|
3621
|
+
/**
|
|
3622
|
+
* Whether to send notifications to the business.
|
|
3623
|
+
*
|
|
3624
|
+
* Default: `true`
|
|
3625
|
+
* @internal
|
|
3626
|
+
*/
|
|
3627
|
+
sendNotificationsToBusiness?: boolean | null;
|
|
3241
3628
|
}
|
|
3242
|
-
|
|
3629
|
+
interface CreateOrderFromDraftResponse {
|
|
3630
|
+
/**
|
|
3631
|
+
* The draft order after commit.
|
|
3632
|
+
* @internal
|
|
3633
|
+
*/
|
|
3634
|
+
committedDraftOrder?: DraftOrder;
|
|
3635
|
+
/**
|
|
3636
|
+
* Created order
|
|
3637
|
+
* @internal
|
|
3638
|
+
*/
|
|
3639
|
+
createdOrder?: Order;
|
|
3243
3640
|
}
|
|
3244
|
-
|
|
3641
|
+
interface DeleteDraftOrderRequest {
|
|
3245
3642
|
/**
|
|
3246
3643
|
* The draft order id
|
|
3247
3644
|
* @format GUID
|
|
3248
3645
|
*/
|
|
3249
3646
|
draftOrderId: string;
|
|
3250
3647
|
}
|
|
3251
|
-
|
|
3648
|
+
interface DeleteDraftOrderResponse {
|
|
3252
3649
|
}
|
|
3253
|
-
|
|
3650
|
+
interface QueryDraftOrdersRequest {
|
|
3254
3651
|
/** WQL expression */
|
|
3255
3652
|
query?: CursorQuery;
|
|
3256
3653
|
}
|
|
3257
|
-
|
|
3654
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3258
3655
|
/**
|
|
3259
3656
|
* Cursor paging options.
|
|
3260
3657
|
*
|
|
@@ -3276,7 +3673,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3276
3673
|
sort?: Sorting[];
|
|
3277
3674
|
}
|
|
3278
3675
|
/** @oneof */
|
|
3279
|
-
|
|
3676
|
+
interface CursorQueryPagingMethodOneOf {
|
|
3280
3677
|
/**
|
|
3281
3678
|
* Cursor paging options.
|
|
3282
3679
|
*
|
|
@@ -3284,7 +3681,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3284
3681
|
*/
|
|
3285
3682
|
cursorPaging?: CursorPaging;
|
|
3286
3683
|
}
|
|
3287
|
-
|
|
3684
|
+
interface Sorting {
|
|
3288
3685
|
/**
|
|
3289
3686
|
* Name of the field to sort by.
|
|
3290
3687
|
* @maxLength 512
|
|
@@ -3293,11 +3690,11 @@ export interface Sorting {
|
|
|
3293
3690
|
/** Sort order. */
|
|
3294
3691
|
order?: SortOrder;
|
|
3295
3692
|
}
|
|
3296
|
-
|
|
3693
|
+
declare enum SortOrder {
|
|
3297
3694
|
ASC = "ASC",
|
|
3298
3695
|
DESC = "DESC"
|
|
3299
3696
|
}
|
|
3300
|
-
|
|
3697
|
+
interface CursorPaging {
|
|
3301
3698
|
/**
|
|
3302
3699
|
* Maximum number of items to return in the results.
|
|
3303
3700
|
* @max 100
|
|
@@ -3312,13 +3709,13 @@ export interface CursorPaging {
|
|
|
3312
3709
|
*/
|
|
3313
3710
|
cursor?: string | null;
|
|
3314
3711
|
}
|
|
3315
|
-
|
|
3712
|
+
interface QueryDraftOrdersResponse {
|
|
3316
3713
|
/** list of edits per order */
|
|
3317
3714
|
draftOrders?: DraftOrder[];
|
|
3318
3715
|
/** Paging metadata. */
|
|
3319
3716
|
pagingMetadata?: CursorPagingMetadata;
|
|
3320
3717
|
}
|
|
3321
|
-
|
|
3718
|
+
interface CursorPagingMetadata {
|
|
3322
3719
|
/** Number of items returned in current page. */
|
|
3323
3720
|
count?: number | null;
|
|
3324
3721
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3331,7 +3728,7 @@ export interface CursorPagingMetadata {
|
|
|
3331
3728
|
*/
|
|
3332
3729
|
hasNext?: boolean | null;
|
|
3333
3730
|
}
|
|
3334
|
-
|
|
3731
|
+
interface Cursors {
|
|
3335
3732
|
/**
|
|
3336
3733
|
* Cursor string pointing to the next page in the list of results.
|
|
3337
3734
|
* @maxLength 16000
|
|
@@ -3343,30 +3740,48 @@ export interface Cursors {
|
|
|
3343
3740
|
*/
|
|
3344
3741
|
prev?: string | null;
|
|
3345
3742
|
}
|
|
3346
|
-
|
|
3743
|
+
interface UpdateExtendedFieldsRequest {
|
|
3347
3744
|
/** ID of the entity to update. */
|
|
3348
|
-
|
|
3745
|
+
_id?: string;
|
|
3349
3746
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3350
3747
|
namespace?: string;
|
|
3351
3748
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3352
3749
|
namespaceData?: Record<string, any> | null;
|
|
3353
3750
|
}
|
|
3354
|
-
|
|
3751
|
+
interface UpdateExtendedFieldsResponse {
|
|
3355
3752
|
/** Updated DraftOrder */
|
|
3356
3753
|
draftOrder?: DraftOrder;
|
|
3357
3754
|
}
|
|
3358
|
-
|
|
3755
|
+
interface SetTaxExemptionRequest {
|
|
3756
|
+
/**
|
|
3757
|
+
* Draft order ID.
|
|
3758
|
+
* @internal
|
|
3759
|
+
* @format GUID
|
|
3760
|
+
*/
|
|
3761
|
+
draftOrderId: string;
|
|
3762
|
+
/**
|
|
3763
|
+
* Whether the draft order is exempt from tax calculations.
|
|
3764
|
+
*
|
|
3765
|
+
* Default: `false`
|
|
3766
|
+
* @internal
|
|
3767
|
+
*/
|
|
3768
|
+
taxExempt: boolean | null;
|
|
3359
3769
|
}
|
|
3360
|
-
|
|
3770
|
+
interface SetTaxExemptionResponse {
|
|
3771
|
+
/**
|
|
3772
|
+
* The draft order details calculated with updated tax exemption.
|
|
3773
|
+
* @internal
|
|
3774
|
+
*/
|
|
3775
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3361
3776
|
}
|
|
3362
|
-
|
|
3777
|
+
interface GetDraftEditabilityStatusRequest {
|
|
3363
3778
|
/**
|
|
3364
3779
|
* Draft order ID.
|
|
3365
3780
|
* @format GUID
|
|
3366
3781
|
*/
|
|
3367
3782
|
draftOrderId?: string | null;
|
|
3368
3783
|
}
|
|
3369
|
-
|
|
3784
|
+
interface GetDraftEditabilityStatusResponse {
|
|
3370
3785
|
/**
|
|
3371
3786
|
* Draft order ID.
|
|
3372
3787
|
* @format GUID
|
|
@@ -3378,11 +3793,27 @@ export interface GetDraftEditabilityStatusResponse {
|
|
|
3378
3793
|
*/
|
|
3379
3794
|
status?: EditingStatus;
|
|
3380
3795
|
}
|
|
3381
|
-
|
|
3796
|
+
interface SetBusinessLocationRequest {
|
|
3797
|
+
/**
|
|
3798
|
+
* Draft order ID.
|
|
3799
|
+
* @internal
|
|
3800
|
+
* @format GUID
|
|
3801
|
+
*/
|
|
3802
|
+
draftOrderId: string;
|
|
3803
|
+
/**
|
|
3804
|
+
* Business location.
|
|
3805
|
+
* @internal
|
|
3806
|
+
*/
|
|
3807
|
+
businessLocation?: Location;
|
|
3382
3808
|
}
|
|
3383
|
-
|
|
3809
|
+
interface SetBusinessLocationResponse {
|
|
3810
|
+
/**
|
|
3811
|
+
* The draft order details calculated with updated business location.
|
|
3812
|
+
* @internal
|
|
3813
|
+
*/
|
|
3814
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3384
3815
|
}
|
|
3385
|
-
|
|
3816
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3386
3817
|
createdEvent?: EntityCreatedEvent;
|
|
3387
3818
|
updatedEvent?: EntityUpdatedEvent;
|
|
3388
3819
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3391,7 +3822,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3391
3822
|
* Unique event ID.
|
|
3392
3823
|
* Allows clients to ignore duplicate webhooks.
|
|
3393
3824
|
*/
|
|
3394
|
-
|
|
3825
|
+
_id?: string;
|
|
3395
3826
|
/**
|
|
3396
3827
|
* Assumes actions are also always typed to an entity_type
|
|
3397
3828
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3425,36 +3856,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3425
3856
|
entityEventSequence?: string | null;
|
|
3426
3857
|
}
|
|
3427
3858
|
/** @oneof */
|
|
3428
|
-
|
|
3859
|
+
interface DomainEventBodyOneOf {
|
|
3429
3860
|
createdEvent?: EntityCreatedEvent;
|
|
3430
3861
|
updatedEvent?: EntityUpdatedEvent;
|
|
3431
3862
|
deletedEvent?: EntityDeletedEvent;
|
|
3432
3863
|
actionEvent?: ActionEvent;
|
|
3433
3864
|
}
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3437
|
-
restoreInfo?: RestoreInfo;
|
|
3865
|
+
interface EntityCreatedEvent {
|
|
3866
|
+
entity?: string;
|
|
3438
3867
|
}
|
|
3439
|
-
|
|
3868
|
+
interface RestoreInfo {
|
|
3440
3869
|
deletedDate?: Date | null;
|
|
3441
3870
|
}
|
|
3442
|
-
|
|
3871
|
+
interface EntityUpdatedEvent {
|
|
3443
3872
|
/**
|
|
3444
3873
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3445
3874
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3446
3875
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3447
3876
|
*/
|
|
3448
|
-
|
|
3877
|
+
currentEntity?: string;
|
|
3449
3878
|
}
|
|
3450
|
-
|
|
3879
|
+
interface EntityDeletedEvent {
|
|
3451
3880
|
/** Entity that was deleted */
|
|
3452
|
-
|
|
3881
|
+
deletedEntity?: string | null;
|
|
3453
3882
|
}
|
|
3454
|
-
|
|
3455
|
-
|
|
3883
|
+
interface ActionEvent {
|
|
3884
|
+
body?: string;
|
|
3456
3885
|
}
|
|
3457
|
-
|
|
3886
|
+
interface MessageEnvelope {
|
|
3458
3887
|
/**
|
|
3459
3888
|
* App instance ID.
|
|
3460
3889
|
* @format GUID
|
|
@@ -3470,7 +3899,7 @@ export interface MessageEnvelope {
|
|
|
3470
3899
|
/** Stringify payload. */
|
|
3471
3900
|
data?: string;
|
|
3472
3901
|
}
|
|
3473
|
-
|
|
3902
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3474
3903
|
/**
|
|
3475
3904
|
* ID of a site visitor that has not logged in to the site.
|
|
3476
3905
|
* @format GUID
|
|
@@ -3495,7 +3924,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3495
3924
|
identityType?: WebhookIdentityType;
|
|
3496
3925
|
}
|
|
3497
3926
|
/** @oneof */
|
|
3498
|
-
|
|
3927
|
+
interface IdentificationDataIdOneOf {
|
|
3499
3928
|
/**
|
|
3500
3929
|
* ID of a site visitor that has not logged in to the site.
|
|
3501
3930
|
* @format GUID
|
|
@@ -3517,774 +3946,134 @@ export interface IdentificationDataIdOneOf {
|
|
|
3517
3946
|
*/
|
|
3518
3947
|
appId?: string;
|
|
3519
3948
|
}
|
|
3520
|
-
|
|
3949
|
+
declare enum WebhookIdentityType {
|
|
3521
3950
|
UNKNOWN = "UNKNOWN",
|
|
3522
3951
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3523
3952
|
MEMBER = "MEMBER",
|
|
3524
3953
|
WIX_USER = "WIX_USER",
|
|
3525
3954
|
APP = "APP"
|
|
3526
3955
|
}
|
|
3527
|
-
interface
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
interface DescriptionLineNonNullableFields {
|
|
3555
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
3556
|
-
colorInfo?: ColorNonNullableFields;
|
|
3557
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
3558
|
-
color: string;
|
|
3559
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
3560
|
-
lineType: DescriptionLineType;
|
|
3561
|
-
}
|
|
3562
|
-
interface FocalPointNonNullableFields {
|
|
3563
|
-
x: number;
|
|
3564
|
-
y: number;
|
|
3565
|
-
}
|
|
3566
|
-
interface ImageNonNullableFields {
|
|
3567
|
-
id: string;
|
|
3568
|
-
url: string;
|
|
3569
|
-
height: number;
|
|
3570
|
-
width: number;
|
|
3571
|
-
focalPoint?: FocalPointNonNullableFields;
|
|
3572
|
-
}
|
|
3573
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
3574
|
-
shippable: boolean;
|
|
3575
|
-
}
|
|
3576
|
-
interface ItemTypeNonNullableFields {
|
|
3577
|
-
preset: ItemTypeItemType;
|
|
3578
|
-
custom: string;
|
|
3579
|
-
}
|
|
3580
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
3581
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3582
|
-
taxRate: string;
|
|
3583
|
-
totalTax?: PriceNonNullableFields;
|
|
3584
|
-
}
|
|
3585
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
3586
|
-
taxAmount?: PriceNonNullableFields;
|
|
3587
|
-
jurisdictionType: JurisdictionType;
|
|
3588
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
3589
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3590
|
-
}
|
|
3591
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
3592
|
-
taxAmount?: PriceNonNullableFields;
|
|
3593
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3594
|
-
taxIncludedInPrice: boolean;
|
|
3595
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
3596
|
-
}
|
|
3597
|
-
interface DigitalFileNonNullableFields {
|
|
3598
|
-
fileId: string;
|
|
3599
|
-
}
|
|
3600
|
-
interface SubscriptionTitleNonNullableFields {
|
|
3601
|
-
original: string;
|
|
3602
|
-
}
|
|
3603
|
-
interface SubscriptionDescriptionNonNullableFields {
|
|
3604
|
-
original: string;
|
|
3605
|
-
}
|
|
3606
|
-
interface FreeTrialPeriodNonNullableFields {
|
|
3607
|
-
frequency: SubscriptionFrequency;
|
|
3608
|
-
interval: number;
|
|
3609
|
-
}
|
|
3610
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
3611
|
-
frequency: SubscriptionFrequency;
|
|
3612
|
-
autoRenewal: boolean;
|
|
3613
|
-
/** @internal */
|
|
3614
|
-
enableCustomerCancellation: boolean;
|
|
3615
|
-
/** @internal */
|
|
3616
|
-
freeTrialPeriod?: FreeTrialPeriodNonNullableFields;
|
|
3617
|
-
}
|
|
3618
|
-
interface BillingAdjustmentPriceSummaryNonNullableFields {
|
|
3619
|
-
subtotal?: PriceNonNullableFields;
|
|
3620
|
-
tax?: PriceNonNullableFields;
|
|
3621
|
-
total?: PriceNonNullableFields;
|
|
3622
|
-
}
|
|
3623
|
-
interface BillingAdjustmentNonNullableFields {
|
|
3624
|
-
type: AdjustmentType;
|
|
3625
|
-
priceSummary?: BillingAdjustmentPriceSummaryNonNullableFields;
|
|
3626
|
-
}
|
|
3627
|
-
interface SubscriptionInfoNonNullableFields {
|
|
3628
|
-
cycleNumber: number;
|
|
3629
|
-
subscriptionOptionTitle: string;
|
|
3630
|
-
/** @internal */
|
|
3631
|
-
title?: SubscriptionTitleNonNullableFields;
|
|
3632
|
-
/** @internal */
|
|
3633
|
-
description?: SubscriptionDescriptionNonNullableFields;
|
|
3634
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
3635
|
-
/** @internal */
|
|
3636
|
-
billingAdjustment?: BillingAdjustmentNonNullableFields;
|
|
3637
|
-
}
|
|
3638
|
-
interface LocationAndQuantityNonNullableFields {
|
|
3639
|
-
id: string;
|
|
3640
|
-
quantity: number;
|
|
3641
|
-
}
|
|
3642
|
-
interface TaxableAddressNonNullableFields {
|
|
3643
|
-
addressType: TaxableAddressType;
|
|
3644
|
-
}
|
|
3645
|
-
interface OrderLineItemNonNullableFields {
|
|
3646
|
-
id: string;
|
|
3647
|
-
productName?: ProductNameNonNullableFields;
|
|
3648
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3649
|
-
quantity: number;
|
|
3650
|
-
totalDiscount?: PriceNonNullableFields;
|
|
3651
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
3652
|
-
image?: ImageNonNullableFields;
|
|
3653
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
3654
|
-
itemType?: ItemTypeNonNullableFields;
|
|
3655
|
-
price?: PriceNonNullableFields;
|
|
3656
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
3657
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3658
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3659
|
-
paymentOption: PaymentOptionType;
|
|
3660
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3661
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
3662
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
3663
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
3664
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
3665
|
-
depositAmount?: PriceNonNullableFields;
|
|
3666
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
3667
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
3668
|
-
/** @internal */
|
|
3669
|
-
taxableAddress?: TaxableAddressNonNullableFields;
|
|
3670
|
-
/** @internal */
|
|
3671
|
-
priceUndetermined: boolean;
|
|
3672
|
-
/** @internal */
|
|
3673
|
-
fixedQuantity: boolean;
|
|
3674
|
-
}
|
|
3675
|
-
interface ItemDetailsNonNullableFields {
|
|
3676
|
-
added: boolean;
|
|
3677
|
-
changedDetails?: ItemChangedDetailsNonNullableFields;
|
|
3678
|
-
removed: boolean;
|
|
3679
|
-
lineItem?: OrderLineItemNonNullableFields;
|
|
3680
|
-
}
|
|
3681
|
-
interface StreetAddressNonNullableFields {
|
|
3682
|
-
number: string;
|
|
3683
|
-
name: string;
|
|
3684
|
-
apt: string;
|
|
3685
|
-
}
|
|
3686
|
-
interface AddressNonNullableFields {
|
|
3687
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3688
|
-
}
|
|
3689
|
-
interface VatIdNonNullableFields {
|
|
3690
|
-
id: string;
|
|
3691
|
-
type: VatType;
|
|
3692
|
-
}
|
|
3693
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
3694
|
-
vatId?: VatIdNonNullableFields;
|
|
3695
|
-
}
|
|
3696
|
-
interface AddressWithContactNonNullableFields {
|
|
3697
|
-
address?: AddressNonNullableFields;
|
|
3698
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
3699
|
-
}
|
|
3700
|
-
interface PickupAddressNonNullableFields {
|
|
3701
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3702
|
-
}
|
|
3703
|
-
interface V1PickupDetailsNonNullableFields {
|
|
3704
|
-
address?: PickupAddressNonNullableFields;
|
|
3705
|
-
pickupMethod: PickupDetailsPickupMethod;
|
|
3706
|
-
}
|
|
3707
|
-
interface V1DeliveryLogisticsNonNullableFields {
|
|
3708
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
3709
|
-
pickupDetails?: V1PickupDetailsNonNullableFields;
|
|
3710
|
-
}
|
|
3711
|
-
interface V1ShippingPriceNonNullableFields {
|
|
3712
|
-
price?: PriceNonNullableFields;
|
|
3713
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3714
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3715
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3716
|
-
discount?: PriceNonNullableFields;
|
|
3717
|
-
}
|
|
3718
|
-
interface V1ShippingInformationNonNullableFields {
|
|
3719
|
-
title: string;
|
|
3720
|
-
logistics?: V1DeliveryLogisticsNonNullableFields;
|
|
3721
|
-
cost?: V1ShippingPriceNonNullableFields;
|
|
3722
|
-
}
|
|
3723
|
-
interface ShippingChangedDetailsNonNullableFields {
|
|
3724
|
-
shippingInfoBeforeChange?: V1ShippingInformationNonNullableFields;
|
|
3725
|
-
}
|
|
3726
|
-
interface ShippingDetailsNonNullableFields {
|
|
3727
|
-
added: boolean;
|
|
3728
|
-
changedDetails?: ShippingChangedDetailsNonNullableFields;
|
|
3729
|
-
removed: boolean;
|
|
3730
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
3731
|
-
}
|
|
3732
|
-
interface BuyerInfoNonNullableFields {
|
|
3733
|
-
visitorId: string;
|
|
3734
|
-
memberId: string;
|
|
3735
|
-
}
|
|
3736
|
-
interface AdditionalFeeNonNullableFields {
|
|
3737
|
-
name: string;
|
|
3738
|
-
price?: PriceNonNullableFields;
|
|
3739
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3740
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
3741
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
3742
|
-
id: string;
|
|
3743
|
-
lineItemIds: string[];
|
|
3744
|
-
}
|
|
3745
|
-
interface TaxDetailsNonNullableFields {
|
|
3746
|
-
taxable: boolean;
|
|
3747
|
-
}
|
|
3748
|
-
interface AdditionalFeeDetailsNonNullableFields {
|
|
3749
|
-
additionalFee?: AdditionalFeeNonNullableFields;
|
|
3750
|
-
taxDetails?: TaxDetailsNonNullableFields;
|
|
3751
|
-
source: SourceType;
|
|
3752
|
-
applied: boolean;
|
|
3753
|
-
}
|
|
3754
|
-
interface CouponNonNullableFields {
|
|
3755
|
-
id: string;
|
|
3756
|
-
code: string;
|
|
3757
|
-
name: string;
|
|
3758
|
-
amount?: PriceNonNullableFields;
|
|
3759
|
-
}
|
|
3760
|
-
interface MerchantDiscountNonNullableFields {
|
|
3761
|
-
discountReason: DiscountReason;
|
|
3762
|
-
amount?: PriceNonNullableFields;
|
|
3763
|
-
}
|
|
3764
|
-
interface DiscountRuleNameNonNullableFields {
|
|
3765
|
-
original: string;
|
|
3766
|
-
}
|
|
3767
|
-
interface DiscountRuleNonNullableFields {
|
|
3768
|
-
id: string;
|
|
3769
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
3770
|
-
amount?: PriceNonNullableFields;
|
|
3771
|
-
}
|
|
3772
|
-
interface LineItemDiscountNonNullableFields {
|
|
3773
|
-
id: string;
|
|
3774
|
-
totalDiscount?: PriceNonNullableFields;
|
|
3775
|
-
}
|
|
3776
|
-
interface AppliedDiscountNonNullableFields {
|
|
3777
|
-
coupon?: CouponNonNullableFields;
|
|
3778
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
3779
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
3780
|
-
discountType: AppliedDiscountDiscountType;
|
|
3781
|
-
lineItemIds: string[];
|
|
3782
|
-
/** @internal */
|
|
3783
|
-
lineItemDiscounts: LineItemDiscountNonNullableFields[];
|
|
3784
|
-
}
|
|
3785
|
-
interface DiscountDetailsNonNullableFields {
|
|
3786
|
-
discount?: AppliedDiscountNonNullableFields;
|
|
3787
|
-
source: SourceType;
|
|
3788
|
-
applied: boolean;
|
|
3789
|
-
}
|
|
3790
|
-
interface CreatedByNonNullableFields {
|
|
3791
|
-
userId: string;
|
|
3792
|
-
appId: string;
|
|
3793
|
-
}
|
|
3794
|
-
interface PriceSummaryNonNullableFields {
|
|
3795
|
-
subtotal?: PriceNonNullableFields;
|
|
3796
|
-
shipping?: PriceNonNullableFields;
|
|
3797
|
-
tax?: PriceNonNullableFields;
|
|
3798
|
-
discount?: PriceNonNullableFields;
|
|
3799
|
-
totalPrice?: PriceNonNullableFields;
|
|
3800
|
-
total?: PriceNonNullableFields;
|
|
3801
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
3802
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
3803
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
3804
|
-
}
|
|
3805
|
-
interface TaxSummaryNonNullableFields {
|
|
3806
|
-
totalTax?: PriceNonNullableFields;
|
|
3807
|
-
}
|
|
3808
|
-
interface BalanceNonNullableFields {
|
|
3809
|
-
amount: string;
|
|
3810
|
-
formattedAmount: string;
|
|
3811
|
-
}
|
|
3812
|
-
interface BalanceSummaryNonNullableFields {
|
|
3813
|
-
balance?: BalanceNonNullableFields;
|
|
3814
|
-
paid?: PriceNonNullableFields;
|
|
3815
|
-
refunded?: PriceNonNullableFields;
|
|
3816
|
-
authorized?: PriceNonNullableFields;
|
|
3817
|
-
}
|
|
3818
|
-
interface InventoryUpdateNonNullableFields {
|
|
3819
|
-
lineItemId: string;
|
|
3820
|
-
}
|
|
3821
|
-
interface DraftOrderCommitSettingsNonNullableFields {
|
|
3822
|
-
updateInventory: InventoryUpdateNonNullableFields[];
|
|
3823
|
-
}
|
|
3824
|
-
interface RecipientInfoChangedDetailsNonNullableFields {
|
|
3825
|
-
recipientInfoBeforeChange?: AddressWithContactNonNullableFields;
|
|
3826
|
-
}
|
|
3827
|
-
interface RecipientInfoDetailsNonNullableFields {
|
|
3828
|
-
added: boolean;
|
|
3829
|
-
changedDetails?: RecipientInfoChangedDetailsNonNullableFields;
|
|
3830
|
-
removed: boolean;
|
|
3831
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3832
|
-
}
|
|
3833
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
3834
|
-
taxName: string;
|
|
3835
|
-
taxType: string;
|
|
3836
|
-
jurisdiction: string;
|
|
3837
|
-
jurisdictionType: JurisdictionType;
|
|
3838
|
-
rate: string;
|
|
3839
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
3840
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
3841
|
-
}
|
|
3842
|
-
interface OrderTaxInfoNonNullableFields {
|
|
3843
|
-
totalTax?: PriceNonNullableFields;
|
|
3844
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
3845
|
-
}
|
|
3846
|
-
interface BuyerChangedDetailsNonNullableFields {
|
|
3847
|
-
/** @internal */
|
|
3848
|
-
buyerInfoBeforeChange?: BuyerInfoNonNullableFields;
|
|
3849
|
-
}
|
|
3850
|
-
interface BuyerDetailsNonNullableFields {
|
|
3851
|
-
/** @internal */
|
|
3852
|
-
added: boolean;
|
|
3853
|
-
/** @internal */
|
|
3854
|
-
changedDetails?: BuyerChangedDetailsNonNullableFields;
|
|
3855
|
-
/** @internal */
|
|
3856
|
-
removed: boolean;
|
|
3857
|
-
/** @internal */
|
|
3858
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3859
|
-
}
|
|
3860
|
-
interface BillingChangedDetailsNonNullableFields {
|
|
3861
|
-
/** @internal */
|
|
3862
|
-
billingInfoBeforeChange?: AddressWithContactNonNullableFields;
|
|
3863
|
-
}
|
|
3864
|
-
interface BillingDetailsNonNullableFields {
|
|
3865
|
-
/** @internal */
|
|
3866
|
-
added: boolean;
|
|
3867
|
-
/** @internal */
|
|
3868
|
-
changedDetails?: BillingChangedDetailsNonNullableFields;
|
|
3869
|
-
/** @internal */
|
|
3870
|
-
removed: boolean;
|
|
3871
|
-
/** @internal */
|
|
3872
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3873
|
-
}
|
|
3874
|
-
interface LocationNonNullableFields {
|
|
3875
|
-
id: string;
|
|
3876
|
-
name: string;
|
|
3877
|
-
}
|
|
3878
|
-
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3879
|
-
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3880
|
-
}
|
|
3881
|
-
interface BusinessLocationDetailsNonNullableFields {
|
|
3882
|
-
added: boolean;
|
|
3883
|
-
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3884
|
-
removed: boolean;
|
|
3885
|
-
businessLocation?: LocationNonNullableFields;
|
|
3886
|
-
}
|
|
3887
|
-
interface DraftOrderNonNullableFields {
|
|
3888
|
-
lineItems: ItemDetailsNonNullableFields[];
|
|
3889
|
-
shippingInfo?: ShippingDetailsNonNullableFields;
|
|
3890
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3891
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3892
|
-
additionalFees: AdditionalFeeDetailsNonNullableFields[];
|
|
3893
|
-
discounts: DiscountDetailsNonNullableFields[];
|
|
3894
|
-
createdBy?: CreatedByNonNullableFields;
|
|
3895
|
-
status: EditingStatus;
|
|
3896
|
-
weightUnit: WeightUnit;
|
|
3897
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
3898
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
3899
|
-
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
3900
|
-
commitSettings?: DraftOrderCommitSettingsNonNullableFields;
|
|
3901
|
-
recipientInfo?: RecipientInfoDetailsNonNullableFields;
|
|
3902
|
-
/** @internal */
|
|
3903
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
3904
|
-
/** @internal */
|
|
3905
|
-
buyerDetails?: BuyerDetailsNonNullableFields;
|
|
3906
|
-
/** @internal */
|
|
3907
|
-
billingDetails?: BillingDetailsNonNullableFields;
|
|
3908
|
-
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
3909
|
-
}
|
|
3910
|
-
interface PickupDetailsNonNullableFields {
|
|
3911
|
-
address?: AddressNonNullableFields;
|
|
3912
|
-
pickupMethod: PickupMethod;
|
|
3913
|
-
}
|
|
3914
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
3915
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
3916
|
-
}
|
|
3917
|
-
interface ShippingPriceNonNullableFields {
|
|
3918
|
-
price?: PriceNonNullableFields;
|
|
3919
|
-
currency: string;
|
|
3920
|
-
}
|
|
3921
|
-
interface ShippingOptionNonNullableFields {
|
|
3922
|
-
code: string;
|
|
3923
|
-
title: string;
|
|
3924
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
3925
|
-
cost?: ShippingPriceNonNullableFields;
|
|
3926
|
-
}
|
|
3927
|
-
interface ApplicationErrorNonNullableFields {
|
|
3928
|
-
code: string;
|
|
3929
|
-
description: string;
|
|
3930
|
-
}
|
|
3931
|
-
interface FieldViolationNonNullableFields {
|
|
3932
|
-
field: string;
|
|
3933
|
-
description: string;
|
|
3934
|
-
violatedRule: RuleType;
|
|
3935
|
-
}
|
|
3936
|
-
interface ValidationErrorNonNullableFields {
|
|
3937
|
-
fieldViolations: FieldViolationNonNullableFields[];
|
|
3938
|
-
}
|
|
3939
|
-
interface DetailsNonNullableFields {
|
|
3940
|
-
applicationError?: ApplicationErrorNonNullableFields;
|
|
3941
|
-
validationError?: ValidationErrorNonNullableFields;
|
|
3942
|
-
}
|
|
3943
|
-
interface CarrierErrorNonNullableFields {
|
|
3944
|
-
carrierId: string;
|
|
3945
|
-
error?: DetailsNonNullableFields;
|
|
3946
|
-
}
|
|
3947
|
-
interface CarrierErrorsNonNullableFields {
|
|
3948
|
-
errors: CarrierErrorNonNullableFields[];
|
|
3949
|
-
}
|
|
3950
|
-
interface CalculationErrorsNonNullableFields {
|
|
3951
|
-
generalShippingCalculationError?: DetailsNonNullableFields;
|
|
3952
|
-
carrierErrors?: CarrierErrorsNonNullableFields;
|
|
3953
|
-
taxCalculationError?: DetailsNonNullableFields;
|
|
3954
|
-
orderValidationErrors: ApplicationErrorNonNullableFields[];
|
|
3955
|
-
}
|
|
3956
|
-
interface CalculatedDraftOrderNonNullableFields {
|
|
3957
|
-
draftOrder?: DraftOrderNonNullableFields;
|
|
3958
|
-
shippingOptions: ShippingOptionNonNullableFields[];
|
|
3959
|
-
calculationErrors?: CalculationErrorsNonNullableFields;
|
|
3960
|
-
}
|
|
3961
|
-
export interface CreateDraftOrderResponseNonNullableFields {
|
|
3962
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3963
|
-
}
|
|
3964
|
-
export interface CreateEmptyDraftOrderResponseNonNullableFields {
|
|
3965
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3966
|
-
}
|
|
3967
|
-
export interface AddLineItemsToDraftOrderResponseNonNullableFields {
|
|
3968
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3969
|
-
}
|
|
3970
|
-
export interface UpdateLineItemsResponseNonNullableFields {
|
|
3971
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3972
|
-
}
|
|
3973
|
-
export interface SetDiscountsResponseNonNullableFields {
|
|
3974
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3975
|
-
}
|
|
3976
|
-
export interface CreateCustomDiscountsResponseNonNullableFields {
|
|
3977
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3978
|
-
}
|
|
3979
|
-
export interface DeleteCustomDiscountsResponseNonNullableFields {
|
|
3980
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3981
|
-
}
|
|
3982
|
-
export interface SetAdditionalFeesResponseNonNullableFields {
|
|
3983
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3984
|
-
}
|
|
3985
|
-
export interface CreateCustomAdditionalFeesResponseNonNullableFields {
|
|
3986
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3987
|
-
}
|
|
3988
|
-
export interface DeleteCustomAdditionalFeesResponseNonNullableFields {
|
|
3989
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3990
|
-
}
|
|
3991
|
-
export interface SetShippingInfoResponseNonNullableFields {
|
|
3992
|
-
/** @internal */
|
|
3993
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3994
|
-
}
|
|
3995
|
-
export interface SetBuyerInfoResponseNonNullableFields {
|
|
3996
|
-
/** @internal */
|
|
3997
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3956
|
+
interface AddLineItemsToDraftOrderOptions {
|
|
3957
|
+
/**
|
|
3958
|
+
* Catalog line items to add to draft order.
|
|
3959
|
+
* @maxSize 300
|
|
3960
|
+
*/
|
|
3961
|
+
catalogLineItems?: CatalogReferenceLineItem[];
|
|
3962
|
+
/**
|
|
3963
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
3964
|
+
* @maxSize 300
|
|
3965
|
+
*/
|
|
3966
|
+
customLineItems?: CustomLineItem[];
|
|
3967
|
+
}
|
|
3968
|
+
interface UpdateLineItemsOptions {
|
|
3969
|
+
/**
|
|
3970
|
+
* Details of changes to apply per line item
|
|
3971
|
+
* @minSize 1
|
|
3972
|
+
* @maxSize 300
|
|
3973
|
+
*/
|
|
3974
|
+
lineItemChanges?: LineItemChangeDetails[];
|
|
3975
|
+
}
|
|
3976
|
+
interface CreateCustomDiscountsOptions {
|
|
3977
|
+
/**
|
|
3978
|
+
* The discounts to add.
|
|
3979
|
+
* @minSize 1
|
|
3980
|
+
* @maxSize 100
|
|
3981
|
+
*/
|
|
3982
|
+
discounts?: DiscountOption[];
|
|
3998
3983
|
}
|
|
3999
|
-
|
|
4000
|
-
/**
|
|
4001
|
-
|
|
3984
|
+
interface CreateCustomAdditionalFeesOptions {
|
|
3985
|
+
/**
|
|
3986
|
+
* The additional fees to add. added with opted-out setting
|
|
3987
|
+
* @minSize 1
|
|
3988
|
+
* @maxSize 100
|
|
3989
|
+
*/
|
|
3990
|
+
customAdditionalFees?: AdditionalFeeOption[];
|
|
4002
3991
|
}
|
|
4003
|
-
|
|
4004
|
-
/**
|
|
4005
|
-
|
|
3992
|
+
interface CommitDraftOrderOptions {
|
|
3993
|
+
/** Optional side effects to trigger */
|
|
3994
|
+
commitSettings?: DraftOrderCommitSettings;
|
|
3995
|
+
/**
|
|
3996
|
+
* Reason for edit, given by user (optional).
|
|
3997
|
+
* @maxLength 200
|
|
3998
|
+
*/
|
|
3999
|
+
reason?: string | null;
|
|
4006
4000
|
}
|
|
4007
|
-
|
|
4008
|
-
|
|
4001
|
+
interface QueryCursorResult {
|
|
4002
|
+
cursors: Cursors;
|
|
4003
|
+
hasNext: () => boolean;
|
|
4004
|
+
hasPrev: () => boolean;
|
|
4005
|
+
length: number;
|
|
4006
|
+
pageSize: number;
|
|
4007
|
+
}
|
|
4008
|
+
interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
4009
|
+
items: DraftOrder[];
|
|
4010
|
+
query: DraftOrdersQueryBuilder;
|
|
4011
|
+
next: () => Promise<DraftOrdersQueryResult>;
|
|
4012
|
+
prev: () => Promise<DraftOrdersQueryResult>;
|
|
4013
|
+
}
|
|
4014
|
+
interface DraftOrdersQueryBuilder {
|
|
4015
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4016
|
+
* @param value - Value to compare against.
|
|
4017
|
+
* @documentationMaturity preview
|
|
4018
|
+
*/
|
|
4019
|
+
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4020
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4021
|
+
* @param value - Value to compare against.
|
|
4022
|
+
* @documentationMaturity preview
|
|
4023
|
+
*/
|
|
4024
|
+
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4025
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4026
|
+
* @param value - Value to compare against.
|
|
4027
|
+
* @documentationMaturity preview
|
|
4028
|
+
*/
|
|
4029
|
+
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4030
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4031
|
+
* @param value - Value to compare against.
|
|
4032
|
+
* @documentationMaturity preview
|
|
4033
|
+
*/
|
|
4034
|
+
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4035
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4036
|
+
* @param value - Value to compare against.
|
|
4037
|
+
* @documentationMaturity preview
|
|
4038
|
+
*/
|
|
4039
|
+
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4040
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4041
|
+
* @param value - Value to compare against.
|
|
4042
|
+
* @documentationMaturity preview
|
|
4043
|
+
*/
|
|
4044
|
+
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4045
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
4046
|
+
* @param string - String to compare against. Case-insensitive.
|
|
4047
|
+
* @documentationMaturity preview
|
|
4048
|
+
*/
|
|
4049
|
+
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
4050
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
4051
|
+
* @param values - List of values to compare against.
|
|
4052
|
+
* @documentationMaturity preview
|
|
4053
|
+
*/
|
|
4054
|
+
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
4055
|
+
/** @documentationMaturity preview */
|
|
4056
|
+
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4057
|
+
/** @documentationMaturity preview */
|
|
4058
|
+
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
4059
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4060
|
+
* @documentationMaturity preview
|
|
4061
|
+
*/
|
|
4062
|
+
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4063
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4064
|
+
* @documentationMaturity preview
|
|
4065
|
+
*/
|
|
4066
|
+
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4067
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
4068
|
+
* @documentationMaturity preview
|
|
4069
|
+
*/
|
|
4070
|
+
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
4071
|
+
/** @param cursor - A pointer to specific record
|
|
4072
|
+
* @documentationMaturity preview
|
|
4073
|
+
*/
|
|
4074
|
+
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
4075
|
+
/** @documentationMaturity preview */
|
|
4076
|
+
find: () => Promise<DraftOrdersQueryResult>;
|
|
4009
4077
|
}
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
orderDraftable: boolean;
|
|
4013
|
-
nonDraftableReasons: NonDraftableReason[];
|
|
4014
|
-
}
|
|
4015
|
-
interface CustomActivityNonNullableFields {
|
|
4016
|
-
appId: string;
|
|
4017
|
-
type: string;
|
|
4018
|
-
}
|
|
4019
|
-
interface MerchantCommentNonNullableFields {
|
|
4020
|
-
message: string;
|
|
4021
|
-
}
|
|
4022
|
-
interface OrderRefundedNonNullableFields {
|
|
4023
|
-
manual: boolean;
|
|
4024
|
-
amount?: PriceNonNullableFields;
|
|
4025
|
-
reason: string;
|
|
4026
|
-
}
|
|
4027
|
-
interface OrderCreatedFromExchangeNonNullableFields {
|
|
4028
|
-
originalOrderId: string;
|
|
4029
|
-
}
|
|
4030
|
-
interface LineItemExchangeDataNonNullableFields {
|
|
4031
|
-
lineItemId: string;
|
|
4032
|
-
quantity: number;
|
|
4033
|
-
}
|
|
4034
|
-
interface NewExchangeOrderCreatedNonNullableFields {
|
|
4035
|
-
exchangeOrderId: string;
|
|
4036
|
-
lineItems: LineItemExchangeDataNonNullableFields[];
|
|
4037
|
-
}
|
|
4038
|
-
interface LineItemQuantityChangeNonNullableFields {
|
|
4039
|
-
originalQuantity: number;
|
|
4040
|
-
newQuantity: number;
|
|
4041
|
-
diff: number;
|
|
4042
|
-
deltaType: LineItemQuantityChangeType;
|
|
4043
|
-
}
|
|
4044
|
-
interface LineItemPriceChangeNonNullableFields {
|
|
4045
|
-
originalPrice?: PriceNonNullableFields;
|
|
4046
|
-
newPrice?: PriceNonNullableFields;
|
|
4047
|
-
}
|
|
4048
|
-
interface LineItemChangesNonNullableFields {
|
|
4049
|
-
id: string;
|
|
4050
|
-
name?: ProductNameNonNullableFields;
|
|
4051
|
-
quantity?: LineItemQuantityChangeNonNullableFields;
|
|
4052
|
-
price?: LineItemPriceChangeNonNullableFields;
|
|
4053
|
-
}
|
|
4054
|
-
interface ManagedLineItemNonNullableFields {
|
|
4055
|
-
id: string;
|
|
4056
|
-
name?: ProductNameNonNullableFields;
|
|
4057
|
-
quantity: number;
|
|
4058
|
-
}
|
|
4059
|
-
interface TranslatedValueNonNullableFields {
|
|
4060
|
-
original: string;
|
|
4061
|
-
}
|
|
4062
|
-
interface LineItemAmountNonNullableFields {
|
|
4063
|
-
id: string;
|
|
4064
|
-
name?: ProductNameNonNullableFields;
|
|
4065
|
-
amount?: PriceNonNullableFields;
|
|
4066
|
-
}
|
|
4067
|
-
interface ManagedDiscountNonNullableFields {
|
|
4068
|
-
id: string;
|
|
4069
|
-
name?: TranslatedValueNonNullableFields;
|
|
4070
|
-
affectedLineItems: LineItemAmountNonNullableFields[];
|
|
4071
|
-
totalAmount?: PriceNonNullableFields;
|
|
4072
|
-
}
|
|
4073
|
-
interface ManagedAdditionalFeeNonNullableFields {
|
|
4074
|
-
id: string;
|
|
4075
|
-
name?: TranslatedValueNonNullableFields;
|
|
4076
|
-
affectedLineItems: LineItemAmountNonNullableFields[];
|
|
4077
|
-
totalAmount?: PriceNonNullableFields;
|
|
4078
|
-
}
|
|
4079
|
-
interface TotalPriceChangeNonNullableFields {
|
|
4080
|
-
originalTotal?: PriceNonNullableFields;
|
|
4081
|
-
newTotal?: PriceNonNullableFields;
|
|
4082
|
-
}
|
|
4083
|
-
interface ShippingInformationNonNullableFields {
|
|
4084
|
-
total?: PriceNonNullableFields;
|
|
4085
|
-
shippingTitle: string;
|
|
4086
|
-
}
|
|
4087
|
-
interface ShippingInformationChangeNonNullableFields {
|
|
4088
|
-
originalShippingInfo?: ShippingInformationNonNullableFields;
|
|
4089
|
-
newShippingInfo?: ShippingInformationNonNullableFields;
|
|
4090
|
-
}
|
|
4091
|
-
interface OrderChangeNonNullableFields {
|
|
4092
|
-
lineItemChanged?: LineItemChangesNonNullableFields;
|
|
4093
|
-
lineItemAdded?: ManagedLineItemNonNullableFields;
|
|
4094
|
-
lineItemRemoved?: ManagedLineItemNonNullableFields;
|
|
4095
|
-
discountAdded?: ManagedDiscountNonNullableFields;
|
|
4096
|
-
discountRemoved?: ManagedDiscountNonNullableFields;
|
|
4097
|
-
additionalFeeAdded?: ManagedAdditionalFeeNonNullableFields;
|
|
4098
|
-
additionalFeeRemoved?: ManagedAdditionalFeeNonNullableFields;
|
|
4099
|
-
totalPriceChanged?: TotalPriceChangeNonNullableFields;
|
|
4100
|
-
shippingInformationChanged?: ShippingInformationChangeNonNullableFields;
|
|
4101
|
-
}
|
|
4102
|
-
interface DraftOrderChangesAppliedNonNullableFields {
|
|
4103
|
-
draftOrderId: string;
|
|
4104
|
-
changes: OrderChangeNonNullableFields[];
|
|
4105
|
-
}
|
|
4106
|
-
interface SavedPaymentMethodNonNullableFields {
|
|
4107
|
-
name: string;
|
|
4108
|
-
}
|
|
4109
|
-
interface AuthorizedPaymentCreatedNonNullableFields {
|
|
4110
|
-
paymentId: string;
|
|
4111
|
-
amount?: PriceNonNullableFields;
|
|
4112
|
-
}
|
|
4113
|
-
interface AuthorizedPaymentCapturedNonNullableFields {
|
|
4114
|
-
paymentId: string;
|
|
4115
|
-
amount?: PriceNonNullableFields;
|
|
4116
|
-
}
|
|
4117
|
-
interface AuthorizedPaymentVoidedNonNullableFields {
|
|
4118
|
-
paymentId: string;
|
|
4119
|
-
amount?: PriceNonNullableFields;
|
|
4120
|
-
}
|
|
4121
|
-
interface RegularPaymentRefundNonNullableFields {
|
|
4122
|
-
amount?: PriceNonNullableFields;
|
|
4123
|
-
}
|
|
4124
|
-
interface GiftCardPaymentRefundNonNullableFields {
|
|
4125
|
-
amount?: PriceNonNullableFields;
|
|
4126
|
-
}
|
|
4127
|
-
interface RefundedPaymentNonNullableFields {
|
|
4128
|
-
regular?: RegularPaymentRefundNonNullableFields;
|
|
4129
|
-
giftCard?: GiftCardPaymentRefundNonNullableFields;
|
|
4130
|
-
paymentId: string;
|
|
4131
|
-
externalRefund: boolean;
|
|
4132
|
-
}
|
|
4133
|
-
interface RefundInitiatedNonNullableFields {
|
|
4134
|
-
refundId: string;
|
|
4135
|
-
amount?: PriceNonNullableFields;
|
|
4136
|
-
payments: RefundedPaymentNonNullableFields[];
|
|
4137
|
-
}
|
|
4138
|
-
interface PaymentRefundedNonNullableFields {
|
|
4139
|
-
refundId: string;
|
|
4140
|
-
payment?: RefundedPaymentNonNullableFields;
|
|
4141
|
-
}
|
|
4142
|
-
interface PaymentRefundFailedNonNullableFields {
|
|
4143
|
-
refundId: string;
|
|
4144
|
-
payment?: RefundedPaymentNonNullableFields;
|
|
4145
|
-
}
|
|
4146
|
-
interface RefundedAsStoreCreditNonNullableFields {
|
|
4147
|
-
amount?: PriceNonNullableFields;
|
|
4148
|
-
}
|
|
4149
|
-
interface RegularPaymentNonNullableFields {
|
|
4150
|
-
amount?: PriceNonNullableFields;
|
|
4151
|
-
}
|
|
4152
|
-
interface PaymentPendingNonNullableFields {
|
|
4153
|
-
regular?: RegularPaymentNonNullableFields;
|
|
4154
|
-
paymentId: string;
|
|
4155
|
-
}
|
|
4156
|
-
interface PaymentCanceledNonNullableFields {
|
|
4157
|
-
regular?: RegularPaymentNonNullableFields;
|
|
4158
|
-
paymentId: string;
|
|
4159
|
-
}
|
|
4160
|
-
interface PaymentDeclinedNonNullableFields {
|
|
4161
|
-
regular?: RegularPaymentNonNullableFields;
|
|
4162
|
-
paymentId: string;
|
|
4163
|
-
}
|
|
4164
|
-
interface WixReceiptNonNullableFields {
|
|
4165
|
-
receiptId: string;
|
|
4166
|
-
}
|
|
4167
|
-
interface ReceiptCreatedNonNullableFields {
|
|
4168
|
-
wixReceipt?: WixReceiptNonNullableFields;
|
|
4169
|
-
paymentId: string;
|
|
4170
|
-
}
|
|
4171
|
-
interface ReceiptSentNonNullableFields {
|
|
4172
|
-
wixReceipt?: WixReceiptNonNullableFields;
|
|
4173
|
-
paymentId: string;
|
|
4174
|
-
}
|
|
4175
|
-
interface ActivityNonNullableFields {
|
|
4176
|
-
customActivity?: CustomActivityNonNullableFields;
|
|
4177
|
-
merchantComment?: MerchantCommentNonNullableFields;
|
|
4178
|
-
orderRefunded?: OrderRefundedNonNullableFields;
|
|
4179
|
-
orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
|
|
4180
|
-
newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
|
|
4181
|
-
/** @internal */
|
|
4182
|
-
draftOrderChangesApplied?: DraftOrderChangesAppliedNonNullableFields;
|
|
4183
|
-
/** @internal */
|
|
4184
|
-
savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
|
|
4185
|
-
/** @internal */
|
|
4186
|
-
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields;
|
|
4187
|
-
/** @internal */
|
|
4188
|
-
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields;
|
|
4189
|
-
/** @internal */
|
|
4190
|
-
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields;
|
|
4191
|
-
/** @internal */
|
|
4192
|
-
refundInitiated?: RefundInitiatedNonNullableFields;
|
|
4193
|
-
/** @internal */
|
|
4194
|
-
paymentRefunded?: PaymentRefundedNonNullableFields;
|
|
4195
|
-
/** @internal */
|
|
4196
|
-
paymentRefundFailed?: PaymentRefundFailedNonNullableFields;
|
|
4197
|
-
/** @internal */
|
|
4198
|
-
refundedAsStoreCredit?: RefundedAsStoreCreditNonNullableFields;
|
|
4199
|
-
/** @internal */
|
|
4200
|
-
paymentPending?: PaymentPendingNonNullableFields;
|
|
4201
|
-
/** @internal */
|
|
4202
|
-
paymentCanceled?: PaymentCanceledNonNullableFields;
|
|
4203
|
-
/** @internal */
|
|
4204
|
-
paymentDeclined?: PaymentDeclinedNonNullableFields;
|
|
4205
|
-
/** @internal */
|
|
4206
|
-
receiptCreated?: ReceiptCreatedNonNullableFields;
|
|
4207
|
-
/** @internal */
|
|
4208
|
-
receiptSent?: ReceiptSentNonNullableFields;
|
|
4209
|
-
type: ActivityType;
|
|
4210
|
-
}
|
|
4211
|
-
interface V1CreatedByNonNullableFields {
|
|
4212
|
-
userId: string;
|
|
4213
|
-
memberId: string;
|
|
4214
|
-
visitorId: string;
|
|
4215
|
-
appId: string;
|
|
4216
|
-
}
|
|
4217
|
-
interface ChannelInfoNonNullableFields {
|
|
4218
|
-
type: ChannelType;
|
|
4219
|
-
}
|
|
4220
|
-
interface CustomFieldNonNullableFields {
|
|
4221
|
-
title: string;
|
|
4222
|
-
}
|
|
4223
|
-
interface V1BalanceSummaryNonNullableFields {
|
|
4224
|
-
balance?: BalanceNonNullableFields;
|
|
4225
|
-
paid?: PriceNonNullableFields;
|
|
4226
|
-
refunded?: PriceNonNullableFields;
|
|
4227
|
-
authorized?: PriceNonNullableFields;
|
|
4228
|
-
/** @internal */
|
|
4229
|
-
pendingRefund?: PriceNonNullableFields;
|
|
4230
|
-
pending?: PriceNonNullableFields;
|
|
4231
|
-
}
|
|
4232
|
-
interface TagListNonNullableFields {
|
|
4233
|
-
tagIds: string[];
|
|
4234
|
-
}
|
|
4235
|
-
interface TagsNonNullableFields {
|
|
4236
|
-
privateTags?: TagListNonNullableFields;
|
|
4237
|
-
tags?: TagListNonNullableFields;
|
|
4238
|
-
}
|
|
4239
|
-
interface OrderNonNullableFields {
|
|
4240
|
-
number: string;
|
|
4241
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
4242
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
4243
|
-
paymentStatus: PaymentStatus;
|
|
4244
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
4245
|
-
weightUnit: WeightUnit;
|
|
4246
|
-
taxIncludedInPrices: boolean;
|
|
4247
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
4248
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
4249
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
4250
|
-
status: OrderStatus;
|
|
4251
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
4252
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
4253
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
4254
|
-
activities: ActivityNonNullableFields[];
|
|
4255
|
-
attributionSource: AttributionSource;
|
|
4256
|
-
createdBy?: V1CreatedByNonNullableFields;
|
|
4257
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
4258
|
-
customFields: CustomFieldNonNullableFields[];
|
|
4259
|
-
isInternalOrderCreate: boolean;
|
|
4260
|
-
payNow?: PriceSummaryNonNullableFields;
|
|
4261
|
-
balanceSummary?: V1BalanceSummaryNonNullableFields;
|
|
4262
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
4263
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
4264
|
-
tags?: TagsNonNullableFields;
|
|
4265
|
-
businessLocation?: LocationNonNullableFields;
|
|
4266
|
-
/** @internal */
|
|
4267
|
-
payAfterFreeTrial?: PriceSummaryNonNullableFields;
|
|
4268
|
-
}
|
|
4269
|
-
export interface CommitDraftOrderResponseNonNullableFields {
|
|
4270
|
-
committedDraftOrder?: DraftOrderNonNullableFields;
|
|
4271
|
-
orderAfterCommit?: OrderNonNullableFields;
|
|
4272
|
-
}
|
|
4273
|
-
export interface CreateOrderFromDraftResponseNonNullableFields {
|
|
4274
|
-
/** @internal */
|
|
4275
|
-
committedDraftOrder?: DraftOrderNonNullableFields;
|
|
4276
|
-
/** @internal */
|
|
4277
|
-
createdOrder?: OrderNonNullableFields;
|
|
4278
|
-
}
|
|
4279
|
-
export interface QueryDraftOrdersResponseNonNullableFields {
|
|
4280
|
-
draftOrders: DraftOrderNonNullableFields[];
|
|
4281
|
-
}
|
|
4282
|
-
export interface SetTaxExemptionResponseNonNullableFields {
|
|
4283
|
-
/** @internal */
|
|
4284
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
4285
|
-
}
|
|
4286
|
-
export interface SetBusinessLocationResponseNonNullableFields {
|
|
4287
|
-
/** @internal */
|
|
4288
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
4289
|
-
}
|
|
4290
|
-
export {};
|
|
4078
|
+
|
|
4079
|
+
export { type OrderLineItem as $, type AddLineItemsToDraftOrderOptions as A, AttributionSource as B, type CreateDraftOrderResponse as C, type DeleteCustomDiscountsResponse as D, EditingStatus as E, FileType as F, type GetDraftOrderResponse as G, ChannelType as H, type IdAndApplied as I, JurisdictionType as J, SortOrder as K, LineItemQuantityChangeType as L, WebhookIdentityType as M, NonDraftableReason as N, OrderStatus as O, PaymentOptionType as P, type DraftOrder as Q, RuleType as R, type SetDiscountsResponse as S, TaxableAddressType as T, type UpdateLineItemsOptions as U, VatType as V, WeightUnit as W, type ItemDetails as X, type ItemDetailsChangeTypeOneOf as Y, type Price as Z, type PriceDescription as _, type CreateEmptyDraftOrderResponse as a, type BalanceSummary as a$, type ProductName as a0, type CatalogReference as a1, type DescriptionLine as a2, type DescriptionLineValueOneOf as a3, type DescriptionLineDescriptionLineValueOneOf as a4, type DescriptionLineName as a5, type PlainTextValue as a6, type Color as a7, type FocalPoint as a8, type PhysicalProperties as a9, type AddressLocation as aA, type FullAddressContactDetails as aB, type VatId as aC, type V1PickupDetails as aD, type PickupAddress as aE, type V1DeliveryTimeSlot as aF, type V1ShippingPrice as aG, type ShippingRegion as aH, type ShippingChangedDetails as aI, type BuyerInfo as aJ, type BuyerInfoIdOneOf as aK, type AdditionalFeeDetails as aL, type AdditionalFee as aM, type TaxDetails as aN, type DiscountDetails as aO, type AppliedDiscount as aP, type AppliedDiscountDiscountSourceOneOf as aQ, type Coupon as aR, type MerchantDiscount as aS, type MerchantDiscountMerchantDiscountReasonOneOf as aT, type DiscountRule as aU, type DiscountRuleName as aV, type LineItemDiscount as aW, type CreatedBy as aX, type CreatedByStringOneOf as aY, type PriceSummary as aZ, type TaxSummary as a_, type ItemType as aa, type ItemTypeItemTypeDataOneOf as ab, type ItemTaxFullDetails as ac, type LineItemTaxInfo as ad, type LineItemTaxBreakdown as ae, type DigitalFile as af, type SubscriptionInfo as ag, type SubscriptionTitle as ah, type SubscriptionDescription as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type BillingAdjustment as al, type BillingAdjustmentPriceSummary as am, type LocationAndQuantity as an, type TaxableAddress as ao, type TaxableAddressTaxableAddressDataOneOf as ap, type ExtendedFields as aq, type ItemChangedDetails as ar, type ShippingDetails as as, type ShippingDetailsChangeTypeOneOf as at, type V1ShippingInformation as au, type V1DeliveryLogistics as av, type V1DeliveryLogisticsAddressOneOf as aw, type AddressWithContact as ax, type Address as ay, type StreetAddress as az, type AddLineItemsToDraftOrderResponse as b, type CommitDraftOrderRequest as b$, type Balance as b0, type DraftOrderCommitSettings as b1, type InventoryUpdate as b2, type RecipientInfoDetails as b3, type RecipientInfoDetailsChangeTypeOneOf as b4, type RecipientInfoChangedDetails as b5, type OrderTaxInfo as b6, type OrderTaxBreakdown as b7, type BuyerDetails as b8, type BuyerDetailsChangeTypeOneOf as b9, type AddLineItemsToDraftOrderRequest as bA, type CatalogReferenceLineItem as bB, type CustomLineItem as bC, type SecuredMedia as bD, type UpdateLineItemsRequest as bE, type LineItemChangeDetails as bF, type SetDiscountsRequest as bG, type CreateCustomDiscountsRequest as bH, type DiscountOption as bI, type DiscountOptionDiscountAmountOneOf as bJ, type DeleteCustomDiscountsRequest as bK, type SetAdditionalFeesRequest as bL, type CreateCustomAdditionalFeesRequest as bM, type AdditionalFeeOption as bN, type DeleteCustomAdditionalFeesRequest as bO, type SetShippingInfoRequest as bP, type SetShippingInfoResponse as bQ, type SetBuyerInfoRequest as bR, type SetBuyerInfoResponse as bS, type SetRecipientInfoRequest as bT, type SetRecipientInfoResponse as bU, type SetBillingInfoRequest as bV, type SetBillingInfoResponse as bW, type UpdateShippingInfoRequest as bX, type UpdateShippingInfoResponse as bY, type GetDraftOrderRequest as bZ, type GetOrderDraftabilityStatusRequest as b_, type BuyerChangedDetails as ba, type BillingDetails as bb, type BillingDetailsChangeTypeOneOf as bc, type BillingChangedDetails as bd, type BusinessLocationDetails as be, type BusinessLocationDetailsChangeTypeOneOf as bf, type Location as bg, type BusinessLocationChangedDetails as bh, type CreateDraftOrderRequest as bi, type CalculatedDraftOrder as bj, type ShippingOption as bk, type DeliveryLogistics as bl, type PickupDetails as bm, type DeliveryTimeSlot as bn, type ShippingPrice as bo, type CalculationErrors as bp, type CalculationErrorsShippingCalculationErrorOneOf as bq, type Details as br, type DetailsKindOneOf as bs, type ApplicationError as bt, type ValidationError as bu, type FieldViolation as bv, type SystemError as bw, type CarrierErrors as bx, type CarrierError as by, type CreateEmptyDraftOrderRequest as bz, type UpdateLineItemsResponse as c, type CreateOrderFromDraftResponse as c$, type Order as c0, type CurrencyConversionDetails as c1, type Activity as c2, type ActivityContentOneOf as c3, type CustomActivity as c4, type MerchantComment as c5, type OrderRefunded as c6, type OrderCreatedFromExchange as c7, type NewExchangeOrderCreated as c8, type LineItemExchangeData as c9, type RefundedAsStoreCredit as cA, type PaymentPending as cB, type PaymentPendingPaymentDetailsOneOf as cC, type RegularPayment as cD, type RegularPaymentPaymentMethodDetailsOneOf as cE, type CreditCardDetails as cF, type PaymentCanceled as cG, type PaymentCanceledPaymentDetailsOneOf as cH, type PaymentDeclined as cI, type PaymentDeclinedPaymentDetailsOneOf as cJ, type ReceiptCreated as cK, type ReceiptCreatedReceiptInfoOneOf as cL, type WixReceipt as cM, type ExternalReceipt as cN, type ReceiptSent as cO, type ReceiptSentReceiptInfoOneOf as cP, type V1CreatedBy as cQ, type V1CreatedByStringOneOf as cR, type ChannelInfo as cS, type CustomField as cT, type V1BalanceSummary as cU, type FulfillmentStatusesAggregate as cV, type Tags as cW, type TagList as cX, type CreateOrderFromDraftRequest as cY, type OrderCreateSettings as cZ, type OrderCreateNotifications as c_, type DraftOrderChangesApplied as ca, type OrderChange as cb, type OrderChangeValueOneOf as cc, type LineItemChanges as cd, type LineItemQuantityChange as ce, type LineItemPriceChange as cf, type ManagedLineItem as cg, type ManagedDiscount as ch, type TranslatedValue as ci, type LineItemAmount as cj, type ManagedAdditionalFee as ck, type TotalPriceChange as cl, type ShippingInformationChange as cm, type ShippingInformation as cn, type SavedPaymentMethod as co, type AuthorizedPaymentCreated as cp, type AuthorizedPaymentCaptured as cq, type AuthorizedPaymentVoided as cr, type RefundInitiated as cs, type RefundedPayment as ct, type RefundedPaymentKindOneOf as cu, type RegularPaymentRefund as cv, type GiftCardPaymentRefund as cw, type MembershipPaymentRefund as cx, type PaymentRefunded as cy, type PaymentRefundFailed as cz, type CreateCustomDiscountsOptions as d, type DeleteDraftOrderRequest as d0, type DeleteDraftOrderResponse as d1, type QueryDraftOrdersRequest as d2, type CursorQuery as d3, type CursorQueryPagingMethodOneOf as d4, type Sorting as d5, type CursorPaging as d6, type QueryDraftOrdersResponse as d7, type CursorPagingMetadata as d8, type Cursors as d9, type UpdateExtendedFieldsRequest as da, type UpdateExtendedFieldsResponse as db, type SetTaxExemptionRequest as dc, type SetTaxExemptionResponse as dd, type GetDraftEditabilityStatusRequest as de, type GetDraftEditabilityStatusResponse as df, type SetBusinessLocationRequest as dg, type SetBusinessLocationResponse as dh, type DomainEvent as di, type DomainEventBodyOneOf as dj, type EntityCreatedEvent as dk, type RestoreInfo as dl, type EntityUpdatedEvent as dm, type EntityDeletedEvent as dn, type ActionEvent as dp, type MessageEnvelope as dq, type IdentificationData as dr, type IdentificationDataIdOneOf as ds, type DraftOrdersQueryResult as dt, type CreateCustomDiscountsResponse as e, type SetAdditionalFeesResponse as f, type CreateCustomAdditionalFeesOptions as g, type CreateCustomAdditionalFeesResponse as h, type DeleteCustomAdditionalFeesResponse as i, type GetOrderDraftabilityStatusResponse as j, type CommitDraftOrderOptions as k, type CommitDraftOrderResponse as l, type DraftOrdersQueryBuilder as m, DescriptionLineType as n, ItemTypeItemType as o, SubscriptionFrequency as p, AdjustmentType as q, PickupDetailsPickupMethod as r, SourceType as s, AppliedDiscountDiscountType as t, DiscountReason as u, PickupMethod as v, DiscountType as w, PaymentStatus as x, FulfillmentStatus as y, ActivityType as z };
|