@wix/auto_sdk_ecom_draft-orders 1.0.19 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +57 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +2951 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +446 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +168 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/{ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.mts → cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -429
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +360 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4055 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +1899 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +26 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +2926 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +398 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +114 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/{ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts → es/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -429
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +357 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4055 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +1851 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +57 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +2951 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +446 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +168 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/internal/{ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.mts → cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -889
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +360 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4515 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +1899 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +26 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +2926 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +398 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +114 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/internal/{ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts → es/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -889
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +357 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4515 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +1851 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -232
- package/build/index.d.ts +0 -232
- package/build/index.js +0 -4593
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -4520
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -232
- package/build/internal/index.d.ts +0 -232
- package/build/internal/index.js +0 -4593
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -4520
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -2751
- package/build/internal/meta.d.ts +0 -2751
- package/build/internal/meta.js +0 -3323
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -3275
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -2751
- package/build/meta.d.ts +0 -2751
- package/build/meta.js +0 -3323
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -3275
- package/build/meta.mjs.map +0 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
|
|
2
|
-
interface DraftOrder {
|
|
2
|
+
export 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 @@ 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,25 +116,13 @@ 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;
|
|
131
119
|
/**
|
|
132
120
|
* Order business location
|
|
133
121
|
* Includes details about changes when relevant.
|
|
134
122
|
*/
|
|
135
123
|
businessLocationDetails?: BusinessLocationDetails;
|
|
136
124
|
}
|
|
137
|
-
interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
125
|
+
export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
138
126
|
/** Whether the line item was added as part of the draft. */
|
|
139
127
|
added?: boolean;
|
|
140
128
|
/** Line item fields before the change. */
|
|
@@ -145,7 +133,7 @@ interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
|
145
133
|
lineItem?: OrderLineItem;
|
|
146
134
|
}
|
|
147
135
|
/** @oneof */
|
|
148
|
-
interface ItemDetailsChangeTypeOneOf {
|
|
136
|
+
export interface ItemDetailsChangeTypeOneOf {
|
|
149
137
|
/** Whether the line item was added as part of the draft. */
|
|
150
138
|
added?: boolean;
|
|
151
139
|
/** Line item fields before the change. */
|
|
@@ -153,7 +141,7 @@ interface ItemDetailsChangeTypeOneOf {
|
|
|
153
141
|
/** Whether the line item was removed as part of the draft. */
|
|
154
142
|
removed?: boolean;
|
|
155
143
|
}
|
|
156
|
-
interface Price {
|
|
144
|
+
export interface Price {
|
|
157
145
|
/**
|
|
158
146
|
* Amount.
|
|
159
147
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -165,7 +153,7 @@ interface Price {
|
|
|
165
153
|
*/
|
|
166
154
|
formattedAmount?: string;
|
|
167
155
|
}
|
|
168
|
-
interface PriceDescription {
|
|
156
|
+
export interface PriceDescription {
|
|
169
157
|
/**
|
|
170
158
|
* __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).
|
|
171
159
|
* @minLength 1
|
|
@@ -181,12 +169,12 @@ interface PriceDescription {
|
|
|
181
169
|
*/
|
|
182
170
|
translated?: string | null;
|
|
183
171
|
}
|
|
184
|
-
interface OrderLineItem {
|
|
172
|
+
export interface OrderLineItem {
|
|
185
173
|
/**
|
|
186
174
|
* Line item ID.
|
|
187
175
|
* @immutable
|
|
188
176
|
*/
|
|
189
|
-
|
|
177
|
+
id?: string;
|
|
190
178
|
/**
|
|
191
179
|
* Item name.
|
|
192
180
|
* + Stores - `product.name`
|
|
@@ -216,7 +204,7 @@ interface OrderLineItem {
|
|
|
216
204
|
*/
|
|
217
205
|
descriptionLines?: DescriptionLine[];
|
|
218
206
|
/** Line item image. */
|
|
219
|
-
image?:
|
|
207
|
+
image?: Image;
|
|
220
208
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
221
209
|
physicalProperties?: PhysicalProperties;
|
|
222
210
|
/** Item type. Either a preset type or custom. */
|
|
@@ -291,17 +279,6 @@ interface OrderLineItem {
|
|
|
291
279
|
* @maxSize 5
|
|
292
280
|
*/
|
|
293
281
|
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;
|
|
305
282
|
/**
|
|
306
283
|
* Custom extended fields for the line item object.
|
|
307
284
|
*
|
|
@@ -309,7 +286,7 @@ interface OrderLineItem {
|
|
|
309
286
|
*/
|
|
310
287
|
extendedFields?: ExtendedFields;
|
|
311
288
|
}
|
|
312
|
-
interface ProductName {
|
|
289
|
+
export interface ProductName {
|
|
313
290
|
/**
|
|
314
291
|
* __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).
|
|
315
292
|
*
|
|
@@ -331,7 +308,7 @@ interface ProductName {
|
|
|
331
308
|
translated?: string | null;
|
|
332
309
|
}
|
|
333
310
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
334
|
-
interface CatalogReference {
|
|
311
|
+
export interface CatalogReference {
|
|
335
312
|
/**
|
|
336
313
|
* ID of the item within the catalog it belongs to.
|
|
337
314
|
* @minLength 1
|
|
@@ -357,7 +334,7 @@ interface CatalogReference {
|
|
|
357
334
|
*/
|
|
358
335
|
options?: Record<string, any> | null;
|
|
359
336
|
}
|
|
360
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
337
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
361
338
|
/** Description line plain text value. */
|
|
362
339
|
plainText?: PlainTextValue;
|
|
363
340
|
/** Description line color value. */
|
|
@@ -366,16 +343,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
366
343
|
name?: DescriptionLineName;
|
|
367
344
|
}
|
|
368
345
|
/** @oneof */
|
|
369
|
-
interface DescriptionLineValueOneOf {
|
|
346
|
+
export interface DescriptionLineValueOneOf {
|
|
370
347
|
/** Description line plain text value. */
|
|
371
348
|
plainText?: PlainTextValue;
|
|
372
349
|
/** Description line color value. */
|
|
373
350
|
colorInfo?: Color;
|
|
374
351
|
}
|
|
375
352
|
/** @oneof */
|
|
376
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
353
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
377
354
|
}
|
|
378
|
-
interface DescriptionLineName {
|
|
355
|
+
export interface DescriptionLineName {
|
|
379
356
|
/**
|
|
380
357
|
* 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).
|
|
381
358
|
* @maxLength 100
|
|
@@ -389,7 +366,7 @@ interface DescriptionLineName {
|
|
|
389
366
|
*/
|
|
390
367
|
translated?: string | null;
|
|
391
368
|
}
|
|
392
|
-
interface PlainTextValue {
|
|
369
|
+
export interface PlainTextValue {
|
|
393
370
|
/**
|
|
394
371
|
* 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).
|
|
395
372
|
* @maxLength 600
|
|
@@ -403,7 +380,7 @@ interface PlainTextValue {
|
|
|
403
380
|
*/
|
|
404
381
|
translated?: string | null;
|
|
405
382
|
}
|
|
406
|
-
interface Color {
|
|
383
|
+
export interface Color {
|
|
407
384
|
/**
|
|
408
385
|
* 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).
|
|
409
386
|
* @maxLength 500
|
|
@@ -419,7 +396,7 @@ interface Color {
|
|
|
419
396
|
/** HEX or RGB color code for display. */
|
|
420
397
|
code?: string | null;
|
|
421
398
|
}
|
|
422
|
-
declare enum DescriptionLineType {
|
|
399
|
+
export declare enum DescriptionLineType {
|
|
423
400
|
/** Unrecognized type. */
|
|
424
401
|
UNRECOGNISED = "UNRECOGNISED",
|
|
425
402
|
/** Plain text type. */
|
|
@@ -427,7 +404,30 @@ declare enum DescriptionLineType {
|
|
|
427
404
|
/** Color type. */
|
|
428
405
|
COLOR = "COLOR"
|
|
429
406
|
}
|
|
430
|
-
interface
|
|
407
|
+
export interface Image {
|
|
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 {
|
|
431
431
|
/** X-coordinate of the focal point. */
|
|
432
432
|
x?: number;
|
|
433
433
|
/** Y-coordinate of the focal point. */
|
|
@@ -437,7 +437,7 @@ interface FocalPoint {
|
|
|
437
437
|
/** crop by width */
|
|
438
438
|
width?: number | null;
|
|
439
439
|
}
|
|
440
|
-
interface PhysicalProperties {
|
|
440
|
+
export 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 @@ interface PhysicalProperties {
|
|
|
448
448
|
/** Whether this line item is shippable. */
|
|
449
449
|
shippable?: boolean;
|
|
450
450
|
}
|
|
451
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
451
|
+
export 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
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
458
|
+
export 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
|
-
declare enum ItemTypeItemType {
|
|
464
|
+
export declare enum ItemTypeItemType {
|
|
465
465
|
UNRECOGNISED = "UNRECOGNISED",
|
|
466
466
|
PHYSICAL = "PHYSICAL",
|
|
467
467
|
DIGITAL = "DIGITAL",
|
|
@@ -469,7 +469,7 @@ declare enum ItemTypeItemType {
|
|
|
469
469
|
SERVICE = "SERVICE"
|
|
470
470
|
}
|
|
471
471
|
/** Type of selected payment option for catalog item */
|
|
472
|
-
declare enum PaymentOptionType {
|
|
472
|
+
export 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 @@ 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
|
-
interface ItemTaxFullDetails {
|
|
484
|
+
export interface ItemTaxFullDetails {
|
|
485
485
|
/** Taxable amount of this line item. */
|
|
486
486
|
taxableAmount?: Price;
|
|
487
487
|
/**
|
|
@@ -492,7 +492,7 @@ interface ItemTaxFullDetails {
|
|
|
492
492
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
493
493
|
totalTax?: Price;
|
|
494
494
|
}
|
|
495
|
-
interface LineItemTaxInfo {
|
|
495
|
+
export 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 @@ 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
|
-
interface LineItemTaxBreakdown {
|
|
523
|
+
export 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 @@ 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
|
-
declare enum JurisdictionType {
|
|
556
|
+
export declare enum JurisdictionType {
|
|
557
557
|
UNDEFINED = "UNDEFINED",
|
|
558
558
|
COUNTRY = "COUNTRY",
|
|
559
559
|
STATE = "STATE",
|
|
@@ -561,7 +561,7 @@ declare enum JurisdictionType {
|
|
|
561
561
|
CITY = "CITY",
|
|
562
562
|
SPECIAL = "SPECIAL"
|
|
563
563
|
}
|
|
564
|
-
interface DigitalFile {
|
|
564
|
+
export interface DigitalFile {
|
|
565
565
|
/**
|
|
566
566
|
* ID of the secure file in media.
|
|
567
567
|
* @minLength 1
|
|
@@ -581,12 +581,12 @@ interface DigitalFile {
|
|
|
581
581
|
*/
|
|
582
582
|
expirationDate?: Date | null;
|
|
583
583
|
}
|
|
584
|
-
interface SubscriptionInfo {
|
|
584
|
+
export 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,11 +600,6 @@ 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;
|
|
608
603
|
/**
|
|
609
604
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
610
605
|
* @maxLength 60
|
|
@@ -613,29 +608,13 @@ interface SubscriptionInfo {
|
|
|
613
608
|
* @targetRemovalDate 2025-10-01
|
|
614
609
|
*/
|
|
615
610
|
subscriptionOptionDescription?: string | null;
|
|
616
|
-
/**
|
|
617
|
-
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
618
|
-
* @internal
|
|
619
|
-
*/
|
|
620
|
-
description?: SubscriptionDescription;
|
|
621
611
|
/**
|
|
622
612
|
* Subscription detailed information.
|
|
623
613
|
* @immutable
|
|
624
614
|
*/
|
|
625
615
|
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;
|
|
637
616
|
}
|
|
638
|
-
interface SubscriptionTitle {
|
|
617
|
+
export interface SubscriptionTitle {
|
|
639
618
|
/**
|
|
640
619
|
* 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).
|
|
641
620
|
* @minLength 1
|
|
@@ -651,7 +630,7 @@ interface SubscriptionTitle {
|
|
|
651
630
|
*/
|
|
652
631
|
translated?: string | null;
|
|
653
632
|
}
|
|
654
|
-
interface SubscriptionDescription {
|
|
633
|
+
export interface SubscriptionDescription {
|
|
655
634
|
/**
|
|
656
635
|
* Subscription option description.
|
|
657
636
|
* @maxLength 500
|
|
@@ -663,7 +642,7 @@ interface SubscriptionDescription {
|
|
|
663
642
|
*/
|
|
664
643
|
translated?: string | null;
|
|
665
644
|
}
|
|
666
|
-
interface SubscriptionSettings {
|
|
645
|
+
export interface SubscriptionSettings {
|
|
667
646
|
/** Frequency of recurring payment. */
|
|
668
647
|
frequency?: SubscriptionFrequency;
|
|
669
648
|
/**
|
|
@@ -679,31 +658,16 @@ interface SubscriptionSettings {
|
|
|
679
658
|
* @min 1
|
|
680
659
|
*/
|
|
681
660
|
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;
|
|
697
661
|
}
|
|
698
662
|
/** Frequency unit of recurring payment */
|
|
699
|
-
declare enum SubscriptionFrequency {
|
|
663
|
+
export declare enum SubscriptionFrequency {
|
|
700
664
|
UNDEFINED = "UNDEFINED",
|
|
701
665
|
DAY = "DAY",
|
|
702
666
|
WEEK = "WEEK",
|
|
703
667
|
MONTH = "MONTH",
|
|
704
668
|
YEAR = "YEAR"
|
|
705
669
|
}
|
|
706
|
-
interface FreeTrialPeriod {
|
|
670
|
+
export interface FreeTrialPeriod {
|
|
707
671
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
708
672
|
frequency?: SubscriptionFrequency;
|
|
709
673
|
/**
|
|
@@ -713,20 +677,20 @@ interface FreeTrialPeriod {
|
|
|
713
677
|
*/
|
|
714
678
|
interval?: number;
|
|
715
679
|
}
|
|
716
|
-
interface BillingAdjustment {
|
|
680
|
+
export interface BillingAdjustment {
|
|
717
681
|
/** The type of adjustment. */
|
|
718
682
|
type?: AdjustmentType;
|
|
719
683
|
/** Summary of the prorated adjustment amount. */
|
|
720
684
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
721
685
|
}
|
|
722
|
-
declare enum AdjustmentType {
|
|
686
|
+
export declare enum AdjustmentType {
|
|
723
687
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
724
688
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
725
689
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
726
690
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
727
691
|
CREDIT = "CREDIT"
|
|
728
692
|
}
|
|
729
|
-
interface BillingAdjustmentPriceSummary {
|
|
693
|
+
export interface BillingAdjustmentPriceSummary {
|
|
730
694
|
/** Subtotal of adjustment, before tax. */
|
|
731
695
|
subtotal?: Price;
|
|
732
696
|
/** Tax on adjustment. */
|
|
@@ -734,12 +698,12 @@ interface BillingAdjustmentPriceSummary {
|
|
|
734
698
|
/** Total price after tax. */
|
|
735
699
|
total?: Price;
|
|
736
700
|
}
|
|
737
|
-
interface LocationAndQuantity {
|
|
701
|
+
export interface LocationAndQuantity {
|
|
738
702
|
/**
|
|
739
703
|
* Location id in the associated owner app.
|
|
740
704
|
* @format GUID
|
|
741
705
|
*/
|
|
742
|
-
|
|
706
|
+
id?: string;
|
|
743
707
|
/**
|
|
744
708
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
745
709
|
* @format GUID
|
|
@@ -760,22 +724,22 @@ interface LocationAndQuantity {
|
|
|
760
724
|
*/
|
|
761
725
|
name?: string | null;
|
|
762
726
|
}
|
|
763
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
727
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
764
728
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
765
729
|
addressType?: TaxableAddressType;
|
|
766
730
|
}
|
|
767
731
|
/** @oneof */
|
|
768
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
732
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
769
733
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
770
734
|
addressType?: TaxableAddressType;
|
|
771
735
|
}
|
|
772
|
-
declare enum TaxableAddressType {
|
|
736
|
+
export declare enum TaxableAddressType {
|
|
773
737
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
774
738
|
BUSINESS = "BUSINESS",
|
|
775
739
|
BILLING = "BILLING",
|
|
776
740
|
SHIPPING = "SHIPPING"
|
|
777
741
|
}
|
|
778
|
-
interface ExtendedFields {
|
|
742
|
+
export interface ExtendedFields {
|
|
779
743
|
/**
|
|
780
744
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
781
745
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -786,7 +750,7 @@ interface ExtendedFields {
|
|
|
786
750
|
*/
|
|
787
751
|
namespaces?: Record<string, Record<string, any>>;
|
|
788
752
|
}
|
|
789
|
-
interface ItemChangedDetails {
|
|
753
|
+
export interface ItemChangedDetails {
|
|
790
754
|
/**
|
|
791
755
|
* Line item quantity before change.
|
|
792
756
|
* @min 1
|
|
@@ -798,7 +762,7 @@ interface ItemChangedDetails {
|
|
|
798
762
|
/** Line item price description before change. */
|
|
799
763
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
800
764
|
}
|
|
801
|
-
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
765
|
+
export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
802
766
|
/** Whether shipping info was added as part of the draft. */
|
|
803
767
|
added?: boolean;
|
|
804
768
|
/** Shipping info before the change. */
|
|
@@ -809,7 +773,7 @@ interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
809
773
|
shippingInfo?: V1ShippingInformation;
|
|
810
774
|
}
|
|
811
775
|
/** @oneof */
|
|
812
|
-
interface ShippingDetailsChangeTypeOneOf {
|
|
776
|
+
export interface ShippingDetailsChangeTypeOneOf {
|
|
813
777
|
/** Whether shipping info was added as part of the draft. */
|
|
814
778
|
added?: boolean;
|
|
815
779
|
/** Shipping info before the change. */
|
|
@@ -817,7 +781,7 @@ interface ShippingDetailsChangeTypeOneOf {
|
|
|
817
781
|
/** Whether shipping info was removed as part of the draft. */
|
|
818
782
|
removed?: boolean;
|
|
819
783
|
}
|
|
820
|
-
interface V1ShippingInformation {
|
|
784
|
+
export interface V1ShippingInformation {
|
|
821
785
|
/**
|
|
822
786
|
* App Def Id of external provider which was a source of shipping info
|
|
823
787
|
* @minLength 1
|
|
@@ -843,7 +807,7 @@ interface V1ShippingInformation {
|
|
|
843
807
|
/** Shipping region. */
|
|
844
808
|
region?: ShippingRegion;
|
|
845
809
|
}
|
|
846
|
-
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
810
|
+
export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
847
811
|
/** Shipping address and contact details. */
|
|
848
812
|
shippingDestination?: AddressWithContact;
|
|
849
813
|
/** Pickup details. */
|
|
@@ -867,21 +831,21 @@ interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
867
831
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
868
832
|
}
|
|
869
833
|
/** @oneof */
|
|
870
|
-
interface V1DeliveryLogisticsAddressOneOf {
|
|
834
|
+
export interface V1DeliveryLogisticsAddressOneOf {
|
|
871
835
|
/** Shipping address and contact details. */
|
|
872
836
|
shippingDestination?: AddressWithContact;
|
|
873
837
|
/** Pickup details. */
|
|
874
838
|
pickupDetails?: V1PickupDetails;
|
|
875
839
|
}
|
|
876
840
|
/** Billing Info and shipping details */
|
|
877
|
-
interface AddressWithContact {
|
|
841
|
+
export interface AddressWithContact {
|
|
878
842
|
/** Address. */
|
|
879
843
|
address?: Address;
|
|
880
844
|
/** Contact details. */
|
|
881
845
|
contactDetails?: FullAddressContactDetails;
|
|
882
846
|
}
|
|
883
847
|
/** Physical address */
|
|
884
|
-
interface Address {
|
|
848
|
+
export interface Address {
|
|
885
849
|
/**
|
|
886
850
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
887
851
|
* @format COUNTRY
|
|
@@ -908,7 +872,7 @@ interface Address {
|
|
|
908
872
|
* Main address line (usually street name and number).
|
|
909
873
|
* @maxLength 150
|
|
910
874
|
*/
|
|
911
|
-
|
|
875
|
+
addressLine?: string | null;
|
|
912
876
|
/**
|
|
913
877
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
914
878
|
* @maxLength 100
|
|
@@ -925,20 +889,20 @@ interface Address {
|
|
|
925
889
|
*/
|
|
926
890
|
subdivisionFullname?: string | null;
|
|
927
891
|
}
|
|
928
|
-
interface StreetAddress {
|
|
892
|
+
export interface StreetAddress {
|
|
929
893
|
/** Street number. */
|
|
930
894
|
number?: string;
|
|
931
895
|
/** Street name. */
|
|
932
896
|
name?: string;
|
|
933
897
|
}
|
|
934
|
-
interface AddressLocation {
|
|
898
|
+
export interface AddressLocation {
|
|
935
899
|
/** Address latitude. */
|
|
936
900
|
latitude?: number | null;
|
|
937
901
|
/** Address longitude. */
|
|
938
902
|
longitude?: number | null;
|
|
939
903
|
}
|
|
940
904
|
/** Full contact details for an address */
|
|
941
|
-
interface FullAddressContactDetails {
|
|
905
|
+
export interface FullAddressContactDetails {
|
|
942
906
|
/**
|
|
943
907
|
* First name.
|
|
944
908
|
* @maxLength 100
|
|
@@ -962,9 +926,9 @@ interface FullAddressContactDetails {
|
|
|
962
926
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
963
927
|
vatId?: VatId;
|
|
964
928
|
}
|
|
965
|
-
interface VatId {
|
|
929
|
+
export interface VatId {
|
|
966
930
|
/** Customer's tax ID. */
|
|
967
|
-
|
|
931
|
+
id?: string;
|
|
968
932
|
/**
|
|
969
933
|
* Tax type.
|
|
970
934
|
*
|
|
@@ -975,21 +939,21 @@ interface VatId {
|
|
|
975
939
|
type?: VatType;
|
|
976
940
|
}
|
|
977
941
|
/** tax info types */
|
|
978
|
-
declare enum VatType {
|
|
942
|
+
export declare enum VatType {
|
|
979
943
|
UNSPECIFIED = "UNSPECIFIED",
|
|
980
944
|
/** CPF - for individual tax payers. */
|
|
981
945
|
CPF = "CPF",
|
|
982
946
|
/** CNPJ - for corporations */
|
|
983
947
|
CNPJ = "CNPJ"
|
|
984
948
|
}
|
|
985
|
-
interface V1PickupDetails {
|
|
949
|
+
export interface V1PickupDetails {
|
|
986
950
|
/** Pickup address. */
|
|
987
951
|
address?: PickupAddress;
|
|
988
952
|
/** Pickup method */
|
|
989
953
|
pickupMethod?: PickupDetailsPickupMethod;
|
|
990
954
|
}
|
|
991
955
|
/** Physical address */
|
|
992
|
-
interface PickupAddress {
|
|
956
|
+
export interface PickupAddress {
|
|
993
957
|
/**
|
|
994
958
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
995
959
|
* @format COUNTRY
|
|
@@ -1016,7 +980,7 @@ interface PickupAddress {
|
|
|
1016
980
|
* Main address line (usually street name and number).
|
|
1017
981
|
* @maxLength 1000
|
|
1018
982
|
*/
|
|
1019
|
-
|
|
983
|
+
addressLine?: string | null;
|
|
1020
984
|
/**
|
|
1021
985
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1022
986
|
* @maxLength 1000
|
|
@@ -1033,18 +997,18 @@ interface PickupAddress {
|
|
|
1033
997
|
*/
|
|
1034
998
|
subdivisionFullname?: string | null;
|
|
1035
999
|
}
|
|
1036
|
-
declare enum PickupDetailsPickupMethod {
|
|
1000
|
+
export declare enum PickupDetailsPickupMethod {
|
|
1037
1001
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1038
1002
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1039
1003
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1040
1004
|
}
|
|
1041
|
-
interface V1DeliveryTimeSlot {
|
|
1005
|
+
export interface V1DeliveryTimeSlot {
|
|
1042
1006
|
/** Delivery slot starting time. */
|
|
1043
1007
|
from?: Date | null;
|
|
1044
1008
|
/** Delivery slot ending time. */
|
|
1045
1009
|
to?: Date | null;
|
|
1046
1010
|
}
|
|
1047
|
-
interface V1ShippingPrice {
|
|
1011
|
+
export interface V1ShippingPrice {
|
|
1048
1012
|
/** Shipping price for display purposes. */
|
|
1049
1013
|
price?: Price;
|
|
1050
1014
|
/**
|
|
@@ -1065,19 +1029,19 @@ interface V1ShippingPrice {
|
|
|
1065
1029
|
*/
|
|
1066
1030
|
discount?: Price;
|
|
1067
1031
|
}
|
|
1068
|
-
interface ShippingRegion {
|
|
1032
|
+
export interface ShippingRegion {
|
|
1069
1033
|
/**
|
|
1070
1034
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1071
1035
|
* @maxLength 100
|
|
1072
1036
|
*/
|
|
1073
1037
|
name?: string | null;
|
|
1074
1038
|
}
|
|
1075
|
-
interface ShippingChangedDetails {
|
|
1039
|
+
export interface ShippingChangedDetails {
|
|
1076
1040
|
/** Shipping info before the change. */
|
|
1077
1041
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1078
1042
|
}
|
|
1079
1043
|
/** Buyer Info */
|
|
1080
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1044
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1081
1045
|
/**
|
|
1082
1046
|
* Visitor ID (if site visitor is not a member).
|
|
1083
1047
|
* @format GUID
|
|
@@ -1100,7 +1064,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1100
1064
|
email?: string | null;
|
|
1101
1065
|
}
|
|
1102
1066
|
/** @oneof */
|
|
1103
|
-
interface BuyerInfoIdOneOf {
|
|
1067
|
+
export interface BuyerInfoIdOneOf {
|
|
1104
1068
|
/**
|
|
1105
1069
|
* Visitor ID (if site visitor is not a member).
|
|
1106
1070
|
* @format GUID
|
|
@@ -1112,7 +1076,7 @@ interface BuyerInfoIdOneOf {
|
|
|
1112
1076
|
*/
|
|
1113
1077
|
memberId?: string;
|
|
1114
1078
|
}
|
|
1115
|
-
interface AdditionalFeeDetails {
|
|
1079
|
+
export interface AdditionalFeeDetails {
|
|
1116
1080
|
/** Additional fee. */
|
|
1117
1081
|
additionalFee?: AdditionalFee;
|
|
1118
1082
|
/** Tax details related to the additional fee. */
|
|
@@ -1128,7 +1092,7 @@ interface AdditionalFeeDetails {
|
|
|
1128
1092
|
/** Whether this additional fee is applied to the order. */
|
|
1129
1093
|
applied?: boolean;
|
|
1130
1094
|
}
|
|
1131
|
-
interface AdditionalFee {
|
|
1095
|
+
export interface AdditionalFee {
|
|
1132
1096
|
/**
|
|
1133
1097
|
* Additional fee's unique code for future processing.
|
|
1134
1098
|
* @minLength 1
|
|
@@ -1159,23 +1123,15 @@ interface AdditionalFee {
|
|
|
1159
1123
|
* @format GUID
|
|
1160
1124
|
* @immutable
|
|
1161
1125
|
*/
|
|
1162
|
-
|
|
1126
|
+
id?: string;
|
|
1163
1127
|
/**
|
|
1164
1128
|
* Optional - Line items associated with this additional fee.
|
|
1165
1129
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1166
1130
|
* @format GUID
|
|
1167
1131
|
*/
|
|
1168
1132
|
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;
|
|
1177
1133
|
}
|
|
1178
|
-
interface TaxDetails {
|
|
1134
|
+
export interface TaxDetails {
|
|
1179
1135
|
/** Indication if additional fee is taxable or not */
|
|
1180
1136
|
taxable?: boolean;
|
|
1181
1137
|
/**
|
|
@@ -1184,7 +1140,7 @@ interface TaxDetails {
|
|
|
1184
1140
|
*/
|
|
1185
1141
|
taxGroupId?: string | null;
|
|
1186
1142
|
}
|
|
1187
|
-
declare enum SourceType {
|
|
1143
|
+
export declare enum SourceType {
|
|
1188
1144
|
/** Part of the original order */
|
|
1189
1145
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1190
1146
|
/** Added by estimate * */
|
|
@@ -1192,7 +1148,7 @@ declare enum SourceType {
|
|
|
1192
1148
|
/** Added manually to current draft order */
|
|
1193
1149
|
CUSTOM = "CUSTOM"
|
|
1194
1150
|
}
|
|
1195
|
-
interface DiscountDetails {
|
|
1151
|
+
export interface DiscountDetails {
|
|
1196
1152
|
/** Discount details. */
|
|
1197
1153
|
discount?: AppliedDiscount;
|
|
1198
1154
|
/**
|
|
@@ -1206,7 +1162,7 @@ interface DiscountDetails {
|
|
|
1206
1162
|
/** Whether this discount is applied to the order. */
|
|
1207
1163
|
applied?: boolean;
|
|
1208
1164
|
}
|
|
1209
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1165
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1210
1166
|
/** Applied coupon info. */
|
|
1211
1167
|
coupon?: Coupon;
|
|
1212
1168
|
/** Merchant discount. */
|
|
@@ -1236,18 +1192,10 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1236
1192
|
* @format GUID
|
|
1237
1193
|
* @immutable
|
|
1238
1194
|
*/
|
|
1239
|
-
|
|
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;
|
|
1195
|
+
id?: string | null;
|
|
1248
1196
|
}
|
|
1249
1197
|
/** @oneof */
|
|
1250
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1198
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1251
1199
|
/** Applied coupon info. */
|
|
1252
1200
|
coupon?: Coupon;
|
|
1253
1201
|
/** Merchant discount. */
|
|
@@ -1255,15 +1203,15 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1255
1203
|
/** Automatic Discount */
|
|
1256
1204
|
discountRule?: DiscountRule;
|
|
1257
1205
|
}
|
|
1258
|
-
declare enum AppliedDiscountDiscountType {
|
|
1206
|
+
export declare enum AppliedDiscountDiscountType {
|
|
1259
1207
|
GLOBAL = "GLOBAL",
|
|
1260
1208
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1261
1209
|
SHIPPING = "SHIPPING"
|
|
1262
1210
|
}
|
|
1263
1211
|
/** Coupon */
|
|
1264
|
-
interface Coupon {
|
|
1212
|
+
export interface Coupon {
|
|
1265
1213
|
/** Coupon ID. */
|
|
1266
|
-
|
|
1214
|
+
id?: string;
|
|
1267
1215
|
/** Coupon code. */
|
|
1268
1216
|
code?: string;
|
|
1269
1217
|
/** Coupon name. */
|
|
@@ -1271,7 +1219,7 @@ interface Coupon {
|
|
|
1271
1219
|
/** Coupon value. */
|
|
1272
1220
|
amount?: Price;
|
|
1273
1221
|
}
|
|
1274
|
-
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1222
|
+
export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1275
1223
|
/**
|
|
1276
1224
|
* Pre-defined discount reason (optional).
|
|
1277
1225
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1284,16 +1232,9 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1284
1232
|
description?: string | null;
|
|
1285
1233
|
/** Discount amount. */
|
|
1286
1234
|
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;
|
|
1294
1235
|
}
|
|
1295
1236
|
/** @oneof */
|
|
1296
|
-
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1237
|
+
export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1297
1238
|
/**
|
|
1298
1239
|
* Pre-defined discount reason (optional).
|
|
1299
1240
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1305,23 +1246,23 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1305
1246
|
*/
|
|
1306
1247
|
description?: string | null;
|
|
1307
1248
|
}
|
|
1308
|
-
declare enum DiscountReason {
|
|
1249
|
+
export declare enum DiscountReason {
|
|
1309
1250
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1310
1251
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1311
1252
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1312
1253
|
}
|
|
1313
|
-
interface DiscountRule {
|
|
1254
|
+
export interface DiscountRule {
|
|
1314
1255
|
/**
|
|
1315
1256
|
* Discount rule ID
|
|
1316
1257
|
* @format GUID
|
|
1317
1258
|
*/
|
|
1318
|
-
|
|
1259
|
+
id?: string;
|
|
1319
1260
|
/** Discount rule name */
|
|
1320
1261
|
name?: DiscountRuleName;
|
|
1321
1262
|
/** Discount value. */
|
|
1322
1263
|
amount?: Price;
|
|
1323
1264
|
}
|
|
1324
|
-
interface DiscountRuleName {
|
|
1265
|
+
export interface DiscountRuleName {
|
|
1325
1266
|
/**
|
|
1326
1267
|
* Original discount rule name (in site's default language).
|
|
1327
1268
|
* @minLength 1
|
|
@@ -1335,16 +1276,16 @@ interface DiscountRuleName {
|
|
|
1335
1276
|
*/
|
|
1336
1277
|
translated?: string | null;
|
|
1337
1278
|
}
|
|
1338
|
-
interface LineItemDiscount {
|
|
1279
|
+
export interface LineItemDiscount {
|
|
1339
1280
|
/**
|
|
1340
1281
|
* ID of line item the discount applies to.
|
|
1341
1282
|
* @format GUID
|
|
1342
1283
|
*/
|
|
1343
|
-
|
|
1284
|
+
id?: string;
|
|
1344
1285
|
/** Total discount for this line item. */
|
|
1345
1286
|
totalDiscount?: Price;
|
|
1346
1287
|
}
|
|
1347
|
-
interface CreatedBy extends CreatedByStringOneOf {
|
|
1288
|
+
export interface CreatedBy extends CreatedByStringOneOf {
|
|
1348
1289
|
/**
|
|
1349
1290
|
* User ID. When the draft order was created by a Wix user.
|
|
1350
1291
|
* @format GUID
|
|
@@ -1357,7 +1298,7 @@ interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1357
1298
|
appId?: string;
|
|
1358
1299
|
}
|
|
1359
1300
|
/** @oneof */
|
|
1360
|
-
interface CreatedByStringOneOf {
|
|
1301
|
+
export interface CreatedByStringOneOf {
|
|
1361
1302
|
/**
|
|
1362
1303
|
* User ID. When the draft order was created by a Wix user.
|
|
1363
1304
|
* @format GUID
|
|
@@ -1369,13 +1310,13 @@ interface CreatedByStringOneOf {
|
|
|
1369
1310
|
*/
|
|
1370
1311
|
appId?: string;
|
|
1371
1312
|
}
|
|
1372
|
-
declare enum EditingStatus {
|
|
1313
|
+
export declare enum EditingStatus {
|
|
1373
1314
|
/** DraftOrder is in draft state. */
|
|
1374
1315
|
DRAFT = "DRAFT",
|
|
1375
1316
|
/** DraftOrder is in committed state. */
|
|
1376
1317
|
COMMITTED = "COMMITTED"
|
|
1377
1318
|
}
|
|
1378
|
-
declare enum WeightUnit {
|
|
1319
|
+
export declare enum WeightUnit {
|
|
1379
1320
|
/** Weight unit can't be classified due to an error. */
|
|
1380
1321
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1381
1322
|
/** Kilograms. */
|
|
@@ -1383,7 +1324,7 @@ declare enum WeightUnit {
|
|
|
1383
1324
|
/** Pounds. */
|
|
1384
1325
|
LB = "LB"
|
|
1385
1326
|
}
|
|
1386
|
-
interface PriceSummary {
|
|
1327
|
+
export interface PriceSummary {
|
|
1387
1328
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1388
1329
|
subtotal?: Price;
|
|
1389
1330
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1397,14 +1338,14 @@ interface PriceSummary {
|
|
|
1397
1338
|
/** Total price of additional fees before tax. */
|
|
1398
1339
|
totalAdditionalFees?: Price;
|
|
1399
1340
|
}
|
|
1400
|
-
interface TaxSummary {
|
|
1341
|
+
export interface TaxSummary {
|
|
1401
1342
|
/**
|
|
1402
1343
|
* Total tax.
|
|
1403
1344
|
* @readonly
|
|
1404
1345
|
*/
|
|
1405
1346
|
totalTax?: Price;
|
|
1406
1347
|
}
|
|
1407
|
-
interface BalanceSummary {
|
|
1348
|
+
export interface BalanceSummary {
|
|
1408
1349
|
/**
|
|
1409
1350
|
* Amount left to pay for order to be considered paid.
|
|
1410
1351
|
* @readonly
|
|
@@ -1423,7 +1364,7 @@ interface BalanceSummary {
|
|
|
1423
1364
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1424
1365
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1425
1366
|
*/
|
|
1426
|
-
interface Balance {
|
|
1367
|
+
export interface Balance {
|
|
1427
1368
|
/**
|
|
1428
1369
|
* Balance amount.
|
|
1429
1370
|
*
|
|
@@ -1439,7 +1380,7 @@ interface Balance {
|
|
|
1439
1380
|
formattedAmount?: string;
|
|
1440
1381
|
}
|
|
1441
1382
|
/** Side-effects upon committing a draft order. */
|
|
1442
|
-
interface DraftOrderCommitSettings {
|
|
1383
|
+
export interface DraftOrderCommitSettings {
|
|
1443
1384
|
/**
|
|
1444
1385
|
* Whether to send notifications to the buyer.
|
|
1445
1386
|
*
|
|
@@ -1471,14 +1412,14 @@ interface DraftOrderCommitSettings {
|
|
|
1471
1412
|
*/
|
|
1472
1413
|
updateInventory?: InventoryUpdate[];
|
|
1473
1414
|
}
|
|
1474
|
-
interface InventoryUpdate {
|
|
1415
|
+
export interface InventoryUpdate {
|
|
1475
1416
|
/**
|
|
1476
1417
|
* Line item ID.
|
|
1477
1418
|
* @format GUID
|
|
1478
1419
|
*/
|
|
1479
1420
|
lineItemId?: string;
|
|
1480
1421
|
}
|
|
1481
|
-
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1422
|
+
export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1482
1423
|
/** Indicates that recipient information was added during draft. */
|
|
1483
1424
|
added?: boolean;
|
|
1484
1425
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1489,7 +1430,7 @@ interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1489
1430
|
recipientInfo?: AddressWithContact;
|
|
1490
1431
|
}
|
|
1491
1432
|
/** @oneof */
|
|
1492
|
-
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1433
|
+
export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1493
1434
|
/** Indicates that recipient information was added during draft. */
|
|
1494
1435
|
added?: boolean;
|
|
1495
1436
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1497,11 +1438,11 @@ interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1497
1438
|
/** Indicates that recipient information was removed during draft. */
|
|
1498
1439
|
removed?: boolean;
|
|
1499
1440
|
}
|
|
1500
|
-
interface RecipientInfoChangedDetails {
|
|
1441
|
+
export interface RecipientInfoChangedDetails {
|
|
1501
1442
|
/** Order recipient address and contact details before draft. */
|
|
1502
1443
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1503
1444
|
}
|
|
1504
|
-
interface OrderTaxInfo {
|
|
1445
|
+
export interface OrderTaxInfo {
|
|
1505
1446
|
/** Calculated tax, added from line items. */
|
|
1506
1447
|
totalTax?: Price;
|
|
1507
1448
|
/**
|
|
@@ -1521,7 +1462,7 @@ interface OrderTaxInfo {
|
|
|
1521
1462
|
* 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.
|
|
1522
1463
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1523
1464
|
*/
|
|
1524
|
-
interface OrderTaxBreakdown {
|
|
1465
|
+
export interface OrderTaxBreakdown {
|
|
1525
1466
|
/**
|
|
1526
1467
|
* The name of the tax against which this tax amount was calculated.
|
|
1527
1468
|
* @maxLength 200
|
|
@@ -1548,101 +1489,21 @@ interface OrderTaxBreakdown {
|
|
|
1548
1489
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1549
1490
|
aggregatedTaxAmount?: Price;
|
|
1550
1491
|
}
|
|
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;
|
|
1492
|
+
export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1572
1493
|
}
|
|
1573
1494
|
/** @oneof */
|
|
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;
|
|
1495
|
+
export interface BuyerDetailsChangeTypeOneOf {
|
|
1590
1496
|
}
|
|
1591
|
-
interface BuyerChangedDetails {
|
|
1592
|
-
/**
|
|
1593
|
-
* Buyer information before draft.
|
|
1594
|
-
* @internal
|
|
1595
|
-
*/
|
|
1596
|
-
buyerInfoBeforeChange?: BuyerInfo;
|
|
1497
|
+
export interface BuyerChangedDetails {
|
|
1597
1498
|
}
|
|
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;
|
|
1499
|
+
export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1619
1500
|
}
|
|
1620
1501
|
/** @oneof */
|
|
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;
|
|
1502
|
+
export interface BillingDetailsChangeTypeOneOf {
|
|
1637
1503
|
}
|
|
1638
|
-
interface BillingChangedDetails {
|
|
1639
|
-
/**
|
|
1640
|
-
* Billing address and contact details before draft.
|
|
1641
|
-
* @internal
|
|
1642
|
-
*/
|
|
1643
|
-
billingInfoBeforeChange?: AddressWithContact;
|
|
1504
|
+
export interface BillingChangedDetails {
|
|
1644
1505
|
}
|
|
1645
|
-
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1506
|
+
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1646
1507
|
/** Indicates that business location was added during draft. */
|
|
1647
1508
|
added?: boolean;
|
|
1648
1509
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1653,7 +1514,7 @@ interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf
|
|
|
1653
1514
|
businessLocation?: Location;
|
|
1654
1515
|
}
|
|
1655
1516
|
/** @oneof */
|
|
1656
|
-
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1517
|
+
export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1657
1518
|
/** Indicates that business location was added during draft. */
|
|
1658
1519
|
added?: boolean;
|
|
1659
1520
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1661,13 +1522,13 @@ interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1661
1522
|
/** Indicates that business location was removed during draft. */
|
|
1662
1523
|
removed?: boolean;
|
|
1663
1524
|
}
|
|
1664
|
-
interface Location {
|
|
1525
|
+
export interface Location {
|
|
1665
1526
|
/**
|
|
1666
1527
|
* Location ID.
|
|
1667
1528
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1668
1529
|
* @format GUID
|
|
1669
1530
|
*/
|
|
1670
|
-
|
|
1531
|
+
id?: string;
|
|
1671
1532
|
/**
|
|
1672
1533
|
* Location name.
|
|
1673
1534
|
* @minLength 1
|
|
@@ -1676,27 +1537,22 @@ interface Location {
|
|
|
1676
1537
|
*/
|
|
1677
1538
|
name?: string;
|
|
1678
1539
|
}
|
|
1679
|
-
interface BusinessLocationChangedDetails {
|
|
1540
|
+
export interface BusinessLocationChangedDetails {
|
|
1680
1541
|
/** Business location before draft. */
|
|
1681
1542
|
businessLocationBeforeChange?: Location;
|
|
1682
1543
|
}
|
|
1683
|
-
interface CreateDraftOrderRequest {
|
|
1544
|
+
export interface CreateDraftOrderRequest {
|
|
1684
1545
|
/**
|
|
1685
1546
|
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1686
1547
|
* @format GUID
|
|
1687
1548
|
*/
|
|
1688
1549
|
orderId: string | null;
|
|
1689
1550
|
}
|
|
1690
|
-
interface CreateDraftOrderResponse {
|
|
1551
|
+
export interface CreateDraftOrderResponse {
|
|
1691
1552
|
/** The draft order details calculated with latest content */
|
|
1692
1553
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1693
|
-
/**
|
|
1694
|
-
* Whether the draft order already exists.
|
|
1695
|
-
* @internal
|
|
1696
|
-
*/
|
|
1697
|
-
preexistingDraftOrder?: boolean | null;
|
|
1698
1554
|
}
|
|
1699
|
-
interface CalculatedDraftOrder {
|
|
1555
|
+
export interface CalculatedDraftOrder {
|
|
1700
1556
|
/**
|
|
1701
1557
|
* The draft order full details with calculations based on it's content.
|
|
1702
1558
|
* Discount and additional fee options are also included.
|
|
@@ -1707,7 +1563,7 @@ interface CalculatedDraftOrder {
|
|
|
1707
1563
|
/** Errors that occurred during calculation. */
|
|
1708
1564
|
calculationErrors?: CalculationErrors;
|
|
1709
1565
|
}
|
|
1710
|
-
interface ShippingOption {
|
|
1566
|
+
export interface ShippingOption {
|
|
1711
1567
|
/**
|
|
1712
1568
|
* This carrier's unique ID
|
|
1713
1569
|
* @format GUID
|
|
@@ -1722,7 +1578,7 @@ interface ShippingOption {
|
|
|
1722
1578
|
/** Shipping cost. */
|
|
1723
1579
|
cost?: ShippingPrice;
|
|
1724
1580
|
}
|
|
1725
|
-
interface DeliveryLogistics {
|
|
1581
|
+
export interface DeliveryLogistics {
|
|
1726
1582
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1727
1583
|
deliveryTime?: string | null;
|
|
1728
1584
|
/** Instructions for caller, e.g for pickup: "Ensure to come during Opening Hours, and please don't park in disabled-spot" */
|
|
@@ -1732,7 +1588,7 @@ interface DeliveryLogistics {
|
|
|
1732
1588
|
/** Expected delivery time slot (from and to time stamps representation) */
|
|
1733
1589
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1734
1590
|
}
|
|
1735
|
-
interface PickupDetails {
|
|
1591
|
+
export interface PickupDetails {
|
|
1736
1592
|
/** Pickup address */
|
|
1737
1593
|
address?: Address;
|
|
1738
1594
|
/**
|
|
@@ -1744,18 +1600,18 @@ interface PickupDetails {
|
|
|
1744
1600
|
*/
|
|
1745
1601
|
pickupMethod?: PickupMethod;
|
|
1746
1602
|
}
|
|
1747
|
-
declare enum PickupMethod {
|
|
1603
|
+
export declare enum PickupMethod {
|
|
1748
1604
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1749
1605
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1750
1606
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1751
1607
|
}
|
|
1752
|
-
interface DeliveryTimeSlot {
|
|
1608
|
+
export interface DeliveryTimeSlot {
|
|
1753
1609
|
/** starting time of the delivery time slot */
|
|
1754
1610
|
from?: Date | null;
|
|
1755
1611
|
/** ending time of the delivery time slot */
|
|
1756
1612
|
to?: Date | null;
|
|
1757
1613
|
}
|
|
1758
|
-
interface ShippingPrice {
|
|
1614
|
+
export interface ShippingPrice {
|
|
1759
1615
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1760
1616
|
price?: Price;
|
|
1761
1617
|
/**
|
|
@@ -1764,7 +1620,7 @@ interface ShippingPrice {
|
|
|
1764
1620
|
*/
|
|
1765
1621
|
currency?: string;
|
|
1766
1622
|
}
|
|
1767
|
-
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1623
|
+
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1768
1624
|
/** General shipping calculation error. */
|
|
1769
1625
|
generalShippingCalculationError?: Details;
|
|
1770
1626
|
/** Carrier errors. */
|
|
@@ -1775,13 +1631,13 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1775
1631
|
orderValidationErrors?: ApplicationError[];
|
|
1776
1632
|
}
|
|
1777
1633
|
/** @oneof */
|
|
1778
|
-
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1634
|
+
export interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1779
1635
|
/** General shipping calculation error. */
|
|
1780
1636
|
generalShippingCalculationError?: Details;
|
|
1781
1637
|
/** Carrier errors. */
|
|
1782
1638
|
carrierErrors?: CarrierErrors;
|
|
1783
1639
|
}
|
|
1784
|
-
interface Details extends DetailsKindOneOf {
|
|
1640
|
+
export interface Details extends DetailsKindOneOf {
|
|
1785
1641
|
applicationError?: ApplicationError;
|
|
1786
1642
|
validationError?: ValidationError;
|
|
1787
1643
|
systemError?: SystemError;
|
|
@@ -1792,12 +1648,12 @@ interface Details extends DetailsKindOneOf {
|
|
|
1792
1648
|
tracing?: Record<string, string>;
|
|
1793
1649
|
}
|
|
1794
1650
|
/** @oneof */
|
|
1795
|
-
interface DetailsKindOneOf {
|
|
1651
|
+
export interface DetailsKindOneOf {
|
|
1796
1652
|
applicationError?: ApplicationError;
|
|
1797
1653
|
validationError?: ValidationError;
|
|
1798
1654
|
systemError?: SystemError;
|
|
1799
1655
|
}
|
|
1800
|
-
interface ApplicationError {
|
|
1656
|
+
export interface ApplicationError {
|
|
1801
1657
|
/** Error code. */
|
|
1802
1658
|
code?: string;
|
|
1803
1659
|
/** Description of the error. */
|
|
@@ -1837,10 +1693,10 @@ interface ApplicationError {
|
|
|
1837
1693
|
* ]
|
|
1838
1694
|
* }
|
|
1839
1695
|
*/
|
|
1840
|
-
interface ValidationError {
|
|
1696
|
+
export interface ValidationError {
|
|
1841
1697
|
fieldViolations?: FieldViolation[];
|
|
1842
1698
|
}
|
|
1843
|
-
declare enum RuleType {
|
|
1699
|
+
export declare enum RuleType {
|
|
1844
1700
|
VALIDATION = "VALIDATION",
|
|
1845
1701
|
OTHER = "OTHER",
|
|
1846
1702
|
MAX = "MAX",
|
|
@@ -1863,7 +1719,7 @@ declare enum RuleType {
|
|
|
1863
1719
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1864
1720
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1865
1721
|
}
|
|
1866
|
-
interface FieldViolation {
|
|
1722
|
+
export interface FieldViolation {
|
|
1867
1723
|
field?: string;
|
|
1868
1724
|
description?: string;
|
|
1869
1725
|
violatedRule?: RuleType;
|
|
@@ -1871,27 +1727,27 @@ interface FieldViolation {
|
|
|
1871
1727
|
ruleName?: string | null;
|
|
1872
1728
|
data?: Record<string, any> | null;
|
|
1873
1729
|
}
|
|
1874
|
-
interface SystemError {
|
|
1730
|
+
export interface SystemError {
|
|
1875
1731
|
/** Error code. */
|
|
1876
1732
|
errorCode?: string | null;
|
|
1877
1733
|
}
|
|
1878
|
-
interface CarrierErrors {
|
|
1734
|
+
export interface CarrierErrors {
|
|
1879
1735
|
/** Carrier errors. */
|
|
1880
1736
|
errors?: CarrierError[];
|
|
1881
1737
|
}
|
|
1882
|
-
interface CarrierError {
|
|
1738
|
+
export interface CarrierError {
|
|
1883
1739
|
/** Carrier ID. */
|
|
1884
1740
|
carrierId?: string;
|
|
1885
1741
|
/** Error details. */
|
|
1886
1742
|
error?: Details;
|
|
1887
1743
|
}
|
|
1888
|
-
interface CreateEmptyDraftOrderRequest {
|
|
1744
|
+
export interface CreateEmptyDraftOrderRequest {
|
|
1889
1745
|
}
|
|
1890
|
-
interface CreateEmptyDraftOrderResponse {
|
|
1746
|
+
export interface CreateEmptyDraftOrderResponse {
|
|
1891
1747
|
/** The draft order details calculated with latest content */
|
|
1892
1748
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1893
1749
|
}
|
|
1894
|
-
interface AddLineItemsToDraftOrderRequest {
|
|
1750
|
+
export interface AddLineItemsToDraftOrderRequest {
|
|
1895
1751
|
/**
|
|
1896
1752
|
* The draft order id
|
|
1897
1753
|
* @format GUID
|
|
@@ -1908,7 +1764,7 @@ interface AddLineItemsToDraftOrderRequest {
|
|
|
1908
1764
|
*/
|
|
1909
1765
|
customLineItems?: CustomLineItem[];
|
|
1910
1766
|
}
|
|
1911
|
-
interface CatalogReferenceLineItem {
|
|
1767
|
+
export interface CatalogReferenceLineItem {
|
|
1912
1768
|
/** 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. */
|
|
1913
1769
|
catalogReference?: CatalogReference;
|
|
1914
1770
|
/**
|
|
@@ -1927,12 +1783,12 @@ interface CatalogReferenceLineItem {
|
|
|
1927
1783
|
*/
|
|
1928
1784
|
locations?: LocationAndQuantity[];
|
|
1929
1785
|
}
|
|
1930
|
-
interface CustomLineItem {
|
|
1786
|
+
export interface CustomLineItem {
|
|
1931
1787
|
/**
|
|
1932
1788
|
* Line item ID.
|
|
1933
1789
|
* @format GUID
|
|
1934
1790
|
*/
|
|
1935
|
-
|
|
1791
|
+
id?: string | null;
|
|
1936
1792
|
/**
|
|
1937
1793
|
* Item quantity.
|
|
1938
1794
|
*
|
|
@@ -1952,7 +1808,7 @@ interface CustomLineItem {
|
|
|
1952
1808
|
*/
|
|
1953
1809
|
productName?: ProductName;
|
|
1954
1810
|
/** URL to the item's page on the site. */
|
|
1955
|
-
url?:
|
|
1811
|
+
url?: PageUrlV2;
|
|
1956
1812
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
1957
1813
|
price?: Price;
|
|
1958
1814
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -1964,7 +1820,7 @@ interface CustomLineItem {
|
|
|
1964
1820
|
/** Line item description lines. Used for display purposes for order. */
|
|
1965
1821
|
descriptionLines?: DescriptionLine[];
|
|
1966
1822
|
/** Line item image details. */
|
|
1967
|
-
media?:
|
|
1823
|
+
media?: Image;
|
|
1968
1824
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
1969
1825
|
physicalProperties?: PhysicalProperties;
|
|
1970
1826
|
/** Item type. Either a preset type or custom. */
|
|
@@ -1984,13 +1840,19 @@ interface CustomLineItem {
|
|
|
1984
1840
|
*/
|
|
1985
1841
|
locations?: LocationAndQuantity[];
|
|
1986
1842
|
}
|
|
1987
|
-
interface
|
|
1843
|
+
export interface PageUrlV2 {
|
|
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 {
|
|
1988
1850
|
/**
|
|
1989
1851
|
* Media ID in Wix Media Manager.
|
|
1990
1852
|
* @minLength 1
|
|
1991
1853
|
* @maxLength 100
|
|
1992
1854
|
*/
|
|
1993
|
-
|
|
1855
|
+
id?: string;
|
|
1994
1856
|
/**
|
|
1995
1857
|
* Original filename.
|
|
1996
1858
|
* @minLength 1
|
|
@@ -2000,7 +1862,7 @@ interface SecuredMedia {
|
|
|
2000
1862
|
/** File type. */
|
|
2001
1863
|
fileType?: FileType;
|
|
2002
1864
|
}
|
|
2003
|
-
declare enum FileType {
|
|
1865
|
+
export declare enum FileType {
|
|
2004
1866
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2005
1867
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
2006
1868
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -2008,11 +1870,11 @@ declare enum FileType {
|
|
|
2008
1870
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
2009
1871
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2010
1872
|
}
|
|
2011
|
-
interface AddLineItemsToDraftOrderResponse {
|
|
1873
|
+
export interface AddLineItemsToDraftOrderResponse {
|
|
2012
1874
|
/** The draft order details calculated with latest content */
|
|
2013
1875
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2014
1876
|
}
|
|
2015
|
-
interface UpdateLineItemsRequest {
|
|
1877
|
+
export interface UpdateLineItemsRequest {
|
|
2016
1878
|
/**
|
|
2017
1879
|
* The draft order id
|
|
2018
1880
|
* @format GUID
|
|
@@ -2025,7 +1887,7 @@ interface UpdateLineItemsRequest {
|
|
|
2025
1887
|
*/
|
|
2026
1888
|
lineItemChanges?: LineItemChangeDetails[];
|
|
2027
1889
|
}
|
|
2028
|
-
interface LineItemChangeDetails {
|
|
1890
|
+
export interface LineItemChangeDetails {
|
|
2029
1891
|
/**
|
|
2030
1892
|
* The line item id to change
|
|
2031
1893
|
* @format GUID
|
|
@@ -2044,11 +1906,11 @@ interface LineItemChangeDetails {
|
|
|
2044
1906
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2045
1907
|
newPriceDescription?: PriceDescription;
|
|
2046
1908
|
}
|
|
2047
|
-
interface UpdateLineItemsResponse {
|
|
1909
|
+
export interface UpdateLineItemsResponse {
|
|
2048
1910
|
/** The draft order details calculated with latest content */
|
|
2049
1911
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2050
1912
|
}
|
|
2051
|
-
interface SetDiscountsRequest {
|
|
1913
|
+
export interface SetDiscountsRequest {
|
|
2052
1914
|
/**
|
|
2053
1915
|
* The draft order id
|
|
2054
1916
|
* @format GUID
|
|
@@ -2060,17 +1922,17 @@ interface SetDiscountsRequest {
|
|
|
2060
1922
|
*/
|
|
2061
1923
|
discounts: IdAndApplied[];
|
|
2062
1924
|
}
|
|
2063
|
-
interface IdAndApplied {
|
|
1925
|
+
export interface IdAndApplied {
|
|
2064
1926
|
/** Discount ID. */
|
|
2065
|
-
|
|
1927
|
+
id?: string;
|
|
2066
1928
|
/** Whether to apply the discount to the draft order. */
|
|
2067
1929
|
applied?: boolean;
|
|
2068
1930
|
}
|
|
2069
|
-
interface SetDiscountsResponse {
|
|
1931
|
+
export interface SetDiscountsResponse {
|
|
2070
1932
|
/** The draft order details calculated with latest content */
|
|
2071
1933
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2072
1934
|
}
|
|
2073
|
-
interface CreateCustomDiscountsRequest {
|
|
1935
|
+
export interface CreateCustomDiscountsRequest {
|
|
2074
1936
|
/**
|
|
2075
1937
|
* The draft order id
|
|
2076
1938
|
* @format GUID
|
|
@@ -2083,19 +1945,7 @@ interface CreateCustomDiscountsRequest {
|
|
|
2083
1945
|
*/
|
|
2084
1946
|
discounts?: DiscountOption[];
|
|
2085
1947
|
}
|
|
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;
|
|
1948
|
+
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2099
1949
|
/**
|
|
2100
1950
|
* Discount type.
|
|
2101
1951
|
* * `"GLOBAL"` - discount applies to entire order.
|
|
@@ -2130,31 +1980,19 @@ interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
2130
1980
|
applyToDraftOrder?: boolean | null;
|
|
2131
1981
|
}
|
|
2132
1982
|
/** @oneof */
|
|
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;
|
|
1983
|
+
export interface DiscountOptionDiscountAmountOneOf {
|
|
2146
1984
|
}
|
|
2147
|
-
declare enum DiscountType {
|
|
1985
|
+
export declare enum DiscountType {
|
|
2148
1986
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2149
1987
|
GLOBAL = "GLOBAL",
|
|
2150
1988
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
2151
1989
|
SHIPPING = "SHIPPING"
|
|
2152
1990
|
}
|
|
2153
|
-
interface CreateCustomDiscountsResponse {
|
|
1991
|
+
export interface CreateCustomDiscountsResponse {
|
|
2154
1992
|
/** The draft order details with the added discounts */
|
|
2155
1993
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2156
1994
|
}
|
|
2157
|
-
interface DeleteCustomDiscountsRequest {
|
|
1995
|
+
export interface DeleteCustomDiscountsRequest {
|
|
2158
1996
|
/**
|
|
2159
1997
|
* The draft order id
|
|
2160
1998
|
* @format GUID
|
|
@@ -2168,11 +2006,11 @@ interface DeleteCustomDiscountsRequest {
|
|
|
2168
2006
|
*/
|
|
2169
2007
|
discountIds: string[];
|
|
2170
2008
|
}
|
|
2171
|
-
interface DeleteCustomDiscountsResponse {
|
|
2009
|
+
export interface DeleteCustomDiscountsResponse {
|
|
2172
2010
|
/** The draft order details calculated with latest content */
|
|
2173
2011
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2174
2012
|
}
|
|
2175
|
-
interface SetAdditionalFeesRequest {
|
|
2013
|
+
export interface SetAdditionalFeesRequest {
|
|
2176
2014
|
/**
|
|
2177
2015
|
* The draft order id
|
|
2178
2016
|
* @format GUID
|
|
@@ -2185,11 +2023,11 @@ interface SetAdditionalFeesRequest {
|
|
|
2185
2023
|
*/
|
|
2186
2024
|
additionalFees: IdAndApplied[];
|
|
2187
2025
|
}
|
|
2188
|
-
interface SetAdditionalFeesResponse {
|
|
2026
|
+
export interface SetAdditionalFeesResponse {
|
|
2189
2027
|
/** The draft order details calculated with modified additional fees */
|
|
2190
2028
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2191
2029
|
}
|
|
2192
|
-
interface CreateCustomAdditionalFeesRequest {
|
|
2030
|
+
export interface CreateCustomAdditionalFeesRequest {
|
|
2193
2031
|
/**
|
|
2194
2032
|
* The draft order id
|
|
2195
2033
|
* @format GUID
|
|
@@ -2202,7 +2040,7 @@ interface CreateCustomAdditionalFeesRequest {
|
|
|
2202
2040
|
*/
|
|
2203
2041
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2204
2042
|
}
|
|
2205
|
-
interface AdditionalFeeOption {
|
|
2043
|
+
export interface AdditionalFeeOption {
|
|
2206
2044
|
/**
|
|
2207
2045
|
* Translated additional fee's name
|
|
2208
2046
|
* @minLength 1
|
|
@@ -2225,11 +2063,11 @@ interface AdditionalFeeOption {
|
|
|
2225
2063
|
*/
|
|
2226
2064
|
code?: string | null;
|
|
2227
2065
|
}
|
|
2228
|
-
interface CreateCustomAdditionalFeesResponse {
|
|
2066
|
+
export interface CreateCustomAdditionalFeesResponse {
|
|
2229
2067
|
/** The draft order details with added custom additional fees */
|
|
2230
2068
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2231
2069
|
}
|
|
2232
|
-
interface DeleteCustomAdditionalFeesRequest {
|
|
2070
|
+
export interface DeleteCustomAdditionalFeesRequest {
|
|
2233
2071
|
/**
|
|
2234
2072
|
* The draft order id
|
|
2235
2073
|
* @format GUID
|
|
@@ -2243,91 +2081,27 @@ interface DeleteCustomAdditionalFeesRequest {
|
|
|
2243
2081
|
*/
|
|
2244
2082
|
customAdditionalFees: string[];
|
|
2245
2083
|
}
|
|
2246
|
-
interface DeleteCustomAdditionalFeesResponse {
|
|
2084
|
+
export interface DeleteCustomAdditionalFeesResponse {
|
|
2247
2085
|
/** The draft order details calculated with latest content */
|
|
2248
2086
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2249
2087
|
}
|
|
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;
|
|
2088
|
+
export interface SetShippingInfoRequest {
|
|
2262
2089
|
}
|
|
2263
|
-
interface SetShippingInfoResponse {
|
|
2264
|
-
/**
|
|
2265
|
-
* The draft order details calculated with updated shipping info
|
|
2266
|
-
* @internal
|
|
2267
|
-
*/
|
|
2268
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2090
|
+
export interface SetShippingInfoResponse {
|
|
2269
2091
|
}
|
|
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;
|
|
2092
|
+
export interface SetBuyerInfoRequest {
|
|
2282
2093
|
}
|
|
2283
|
-
interface SetBuyerInfoResponse {
|
|
2284
|
-
/**
|
|
2285
|
-
* The draft order details calculated with updated buyer info
|
|
2286
|
-
* @internal
|
|
2287
|
-
*/
|
|
2288
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2094
|
+
export interface SetBuyerInfoResponse {
|
|
2289
2095
|
}
|
|
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;
|
|
2096
|
+
export interface SetRecipientInfoRequest {
|
|
2302
2097
|
}
|
|
2303
|
-
interface SetRecipientInfoResponse {
|
|
2304
|
-
/**
|
|
2305
|
-
* The draft order details calculated with updated recipient info
|
|
2306
|
-
* @internal
|
|
2307
|
-
*/
|
|
2308
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2098
|
+
export interface SetRecipientInfoResponse {
|
|
2309
2099
|
}
|
|
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;
|
|
2100
|
+
export interface SetBillingInfoRequest {
|
|
2322
2101
|
}
|
|
2323
|
-
interface SetBillingInfoResponse {
|
|
2324
|
-
/**
|
|
2325
|
-
* The draft order details calculated with updated billing info
|
|
2326
|
-
* @internal
|
|
2327
|
-
*/
|
|
2328
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2102
|
+
export interface SetBillingInfoResponse {
|
|
2329
2103
|
}
|
|
2330
|
-
interface UpdateShippingInfoRequest {
|
|
2104
|
+
export interface UpdateShippingInfoRequest {
|
|
2331
2105
|
/**
|
|
2332
2106
|
* The draft order id
|
|
2333
2107
|
* @format GUID
|
|
@@ -2336,22 +2110,22 @@ interface UpdateShippingInfoRequest {
|
|
|
2336
2110
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
2337
2111
|
shippingOption?: ShippingOption;
|
|
2338
2112
|
}
|
|
2339
|
-
interface UpdateShippingInfoResponse {
|
|
2113
|
+
export interface UpdateShippingInfoResponse {
|
|
2340
2114
|
/** The draft order details calculated with de/selected shipping info */
|
|
2341
2115
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2342
2116
|
}
|
|
2343
|
-
interface GetDraftOrderRequest {
|
|
2117
|
+
export interface GetDraftOrderRequest {
|
|
2344
2118
|
/**
|
|
2345
2119
|
* The draft order id
|
|
2346
2120
|
* @format GUID
|
|
2347
2121
|
*/
|
|
2348
2122
|
draftOrderId: string;
|
|
2349
2123
|
}
|
|
2350
|
-
interface GetDraftOrderResponse {
|
|
2124
|
+
export interface GetDraftOrderResponse {
|
|
2351
2125
|
/** The draft order details calculated with latest content */
|
|
2352
2126
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2353
2127
|
}
|
|
2354
|
-
interface GetOrderDraftabilityStatusRequest {
|
|
2128
|
+
export interface GetOrderDraftabilityStatusRequest {
|
|
2355
2129
|
/**
|
|
2356
2130
|
* Order ID.
|
|
2357
2131
|
* @minLength 1
|
|
@@ -2359,7 +2133,7 @@ interface GetOrderDraftabilityStatusRequest {
|
|
|
2359
2133
|
*/
|
|
2360
2134
|
orderId: string;
|
|
2361
2135
|
}
|
|
2362
|
-
interface GetOrderDraftabilityStatusResponse {
|
|
2136
|
+
export interface GetOrderDraftabilityStatusResponse {
|
|
2363
2137
|
/**
|
|
2364
2138
|
* Order ID.
|
|
2365
2139
|
* @minLength 1
|
|
@@ -2374,7 +2148,7 @@ interface GetOrderDraftabilityStatusResponse {
|
|
|
2374
2148
|
*/
|
|
2375
2149
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2376
2150
|
}
|
|
2377
|
-
declare enum NonDraftableReason {
|
|
2151
|
+
export declare enum NonDraftableReason {
|
|
2378
2152
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2379
2153
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2380
2154
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
@@ -2388,7 +2162,7 @@ declare enum NonDraftableReason {
|
|
|
2388
2162
|
UNSUPPORTED_CATALOG_ITEM = "UNSUPPORTED_CATALOG_ITEM",
|
|
2389
2163
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2390
2164
|
}
|
|
2391
|
-
interface CommitDraftOrderRequest {
|
|
2165
|
+
export interface CommitDraftOrderRequest {
|
|
2392
2166
|
/**
|
|
2393
2167
|
* The draft order id
|
|
2394
2168
|
* @format GUID
|
|
@@ -2402,19 +2176,19 @@ interface CommitDraftOrderRequest {
|
|
|
2402
2176
|
*/
|
|
2403
2177
|
reason?: string | null;
|
|
2404
2178
|
}
|
|
2405
|
-
interface CommitDraftOrderResponse {
|
|
2179
|
+
export interface CommitDraftOrderResponse {
|
|
2406
2180
|
/** The draft order after commit. */
|
|
2407
2181
|
committedDraftOrder?: DraftOrder;
|
|
2408
2182
|
/** The updated order after commit. */
|
|
2409
2183
|
orderAfterCommit?: Order;
|
|
2410
2184
|
}
|
|
2411
|
-
interface Order {
|
|
2185
|
+
export interface Order {
|
|
2412
2186
|
/**
|
|
2413
2187
|
* Order ID.
|
|
2414
2188
|
* @format GUID
|
|
2415
2189
|
* @readonly
|
|
2416
2190
|
*/
|
|
2417
|
-
|
|
2191
|
+
id?: string | null;
|
|
2418
2192
|
/**
|
|
2419
2193
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2420
2194
|
* @readonly
|
|
@@ -2425,12 +2199,12 @@ interface Order {
|
|
|
2425
2199
|
* @readonly
|
|
2426
2200
|
* @immutable
|
|
2427
2201
|
*/
|
|
2428
|
-
|
|
2202
|
+
createdDate?: Date | null;
|
|
2429
2203
|
/**
|
|
2430
2204
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2431
2205
|
* @readonly
|
|
2432
2206
|
*/
|
|
2433
|
-
|
|
2207
|
+
updatedDate?: Date | null;
|
|
2434
2208
|
/**
|
|
2435
2209
|
* Order line items.
|
|
2436
2210
|
* @minSize 1
|
|
@@ -2575,14 +2349,8 @@ interface Order {
|
|
|
2575
2349
|
purchasedDate?: Date | null;
|
|
2576
2350
|
/** Order Location */
|
|
2577
2351
|
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;
|
|
2584
2352
|
}
|
|
2585
|
-
declare enum PaymentStatus {
|
|
2353
|
+
export declare enum PaymentStatus {
|
|
2586
2354
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2587
2355
|
/**
|
|
2588
2356
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2623,7 +2391,7 @@ declare enum PaymentStatus {
|
|
|
2623
2391
|
*/
|
|
2624
2392
|
DECLINED = "DECLINED"
|
|
2625
2393
|
}
|
|
2626
|
-
declare enum FulfillmentStatus {
|
|
2394
|
+
export declare enum FulfillmentStatus {
|
|
2627
2395
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2628
2396
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2629
2397
|
/**
|
|
@@ -2634,7 +2402,7 @@ declare enum FulfillmentStatus {
|
|
|
2634
2402
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2635
2403
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2636
2404
|
}
|
|
2637
|
-
interface CurrencyConversionDetails {
|
|
2405
|
+
export interface CurrencyConversionDetails {
|
|
2638
2406
|
/**
|
|
2639
2407
|
* 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.
|
|
2640
2408
|
* @readonly
|
|
@@ -2650,7 +2418,7 @@ interface CurrencyConversionDetails {
|
|
|
2650
2418
|
*/
|
|
2651
2419
|
conversionRate?: string | null;
|
|
2652
2420
|
}
|
|
2653
|
-
declare enum OrderStatus {
|
|
2421
|
+
export declare enum OrderStatus {
|
|
2654
2422
|
/** Order created, but not yet approved or canceled. */
|
|
2655
2423
|
INITIALIZED = "INITIALIZED",
|
|
2656
2424
|
/**
|
|
@@ -2675,73 +2443,19 @@ declare enum OrderStatus {
|
|
|
2675
2443
|
*/
|
|
2676
2444
|
REJECTED = "REJECTED"
|
|
2677
2445
|
}
|
|
2678
|
-
interface Activity extends ActivityContentOneOf {
|
|
2446
|
+
export interface Activity extends ActivityContentOneOf {
|
|
2679
2447
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2680
2448
|
customActivity?: CustomActivity;
|
|
2681
2449
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2682
2450
|
merchantComment?: MerchantComment;
|
|
2683
2451
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2684
2452
|
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;
|
|
2739
2453
|
/**
|
|
2740
2454
|
* Activity ID.
|
|
2741
2455
|
* @format GUID
|
|
2742
2456
|
* @readonly
|
|
2743
2457
|
*/
|
|
2744
|
-
|
|
2458
|
+
id?: string | null;
|
|
2745
2459
|
/**
|
|
2746
2460
|
* Activity author's email.
|
|
2747
2461
|
* @format EMAIL
|
|
@@ -2752,74 +2466,20 @@ interface Activity extends ActivityContentOneOf {
|
|
|
2752
2466
|
* Activity creation date and time.
|
|
2753
2467
|
* @readonly
|
|
2754
2468
|
*/
|
|
2755
|
-
|
|
2469
|
+
createdDate?: Date | null;
|
|
2756
2470
|
/** Activity type. */
|
|
2757
2471
|
type?: ActivityType;
|
|
2758
2472
|
}
|
|
2759
2473
|
/** @oneof */
|
|
2760
|
-
interface ActivityContentOneOf {
|
|
2474
|
+
export interface ActivityContentOneOf {
|
|
2761
2475
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2762
2476
|
customActivity?: CustomActivity;
|
|
2763
2477
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2764
2478
|
merchantComment?: MerchantComment;
|
|
2765
2479
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2766
2480
|
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;
|
|
2821
2481
|
}
|
|
2822
|
-
interface CustomActivity {
|
|
2482
|
+
export interface CustomActivity {
|
|
2823
2483
|
/**
|
|
2824
2484
|
* ID of the app that created the custom activity.
|
|
2825
2485
|
* @format GUID
|
|
@@ -2834,7 +2494,7 @@ interface CustomActivity {
|
|
|
2834
2494
|
additionalData?: Record<string, string>;
|
|
2835
2495
|
}
|
|
2836
2496
|
/** Store owner added a comment */
|
|
2837
|
-
interface MerchantComment {
|
|
2497
|
+
export interface MerchantComment {
|
|
2838
2498
|
/**
|
|
2839
2499
|
* Merchant comment message.
|
|
2840
2500
|
* @minLength 1
|
|
@@ -2842,7 +2502,7 @@ interface MerchantComment {
|
|
|
2842
2502
|
*/
|
|
2843
2503
|
message?: string;
|
|
2844
2504
|
}
|
|
2845
|
-
interface OrderRefunded {
|
|
2505
|
+
export interface OrderRefunded {
|
|
2846
2506
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2847
2507
|
manual?: boolean;
|
|
2848
2508
|
/** Refund amount. */
|
|
@@ -2853,14 +2513,14 @@ interface OrderRefunded {
|
|
|
2853
2513
|
*/
|
|
2854
2514
|
reason?: string;
|
|
2855
2515
|
}
|
|
2856
|
-
interface OrderCreatedFromExchange {
|
|
2516
|
+
export interface OrderCreatedFromExchange {
|
|
2857
2517
|
/**
|
|
2858
2518
|
* ID of the original order for which the exchange happened.
|
|
2859
2519
|
* @format GUID
|
|
2860
2520
|
*/
|
|
2861
2521
|
originalOrderId?: string;
|
|
2862
2522
|
}
|
|
2863
|
-
interface NewExchangeOrderCreated {
|
|
2523
|
+
export interface NewExchangeOrderCreated {
|
|
2864
2524
|
/**
|
|
2865
2525
|
* ID of the new order created as a result of an exchange of items.
|
|
2866
2526
|
* @format GUID
|
|
@@ -2873,7 +2533,7 @@ interface NewExchangeOrderCreated {
|
|
|
2873
2533
|
*/
|
|
2874
2534
|
lineItems?: LineItemExchangeData[];
|
|
2875
2535
|
}
|
|
2876
|
-
interface LineItemExchangeData {
|
|
2536
|
+
export interface LineItemExchangeData {
|
|
2877
2537
|
/**
|
|
2878
2538
|
* ID of the exchanged line item.
|
|
2879
2539
|
* @format GUID
|
|
@@ -2886,7 +2546,7 @@ interface LineItemExchangeData {
|
|
|
2886
2546
|
*/
|
|
2887
2547
|
quantity?: number;
|
|
2888
2548
|
}
|
|
2889
|
-
interface DraftOrderChangesApplied {
|
|
2549
|
+
export interface DraftOrderChangesApplied {
|
|
2890
2550
|
/** Draft order id. */
|
|
2891
2551
|
draftOrderId?: string;
|
|
2892
2552
|
/**
|
|
@@ -2897,7 +2557,7 @@ interface DraftOrderChangesApplied {
|
|
|
2897
2557
|
/** Changes applied to order. */
|
|
2898
2558
|
changes?: OrderChange[];
|
|
2899
2559
|
}
|
|
2900
|
-
interface OrderChange extends OrderChangeValueOneOf {
|
|
2560
|
+
export interface OrderChange extends OrderChangeValueOneOf {
|
|
2901
2561
|
lineItemChanged?: LineItemChanges;
|
|
2902
2562
|
lineItemAdded?: ManagedLineItem;
|
|
2903
2563
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2909,7 +2569,7 @@ interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2909
2569
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2910
2570
|
}
|
|
2911
2571
|
/** @oneof */
|
|
2912
|
-
interface OrderChangeValueOneOf {
|
|
2572
|
+
export interface OrderChangeValueOneOf {
|
|
2913
2573
|
lineItemChanged?: LineItemChanges;
|
|
2914
2574
|
lineItemAdded?: ManagedLineItem;
|
|
2915
2575
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2920,12 +2580,12 @@ interface OrderChangeValueOneOf {
|
|
|
2920
2580
|
totalPriceChanged?: TotalPriceChange;
|
|
2921
2581
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2922
2582
|
}
|
|
2923
|
-
interface LineItemChanges {
|
|
2583
|
+
export interface LineItemChanges {
|
|
2924
2584
|
/**
|
|
2925
2585
|
* Line item ID.
|
|
2926
2586
|
* @format GUID
|
|
2927
2587
|
*/
|
|
2928
|
-
|
|
2588
|
+
id?: string;
|
|
2929
2589
|
/** Item name. */
|
|
2930
2590
|
name?: ProductName;
|
|
2931
2591
|
/** Item quantity change. */
|
|
@@ -2933,7 +2593,7 @@ interface LineItemChanges {
|
|
|
2933
2593
|
/** Item price change. */
|
|
2934
2594
|
price?: LineItemPriceChange;
|
|
2935
2595
|
}
|
|
2936
|
-
interface LineItemQuantityChange {
|
|
2596
|
+
export interface LineItemQuantityChange {
|
|
2937
2597
|
/**
|
|
2938
2598
|
* Item quantity before update.
|
|
2939
2599
|
* @max 1000000
|
|
@@ -2953,24 +2613,24 @@ interface LineItemQuantityChange {
|
|
|
2953
2613
|
/** Type of quantity change: increase or decrease. */
|
|
2954
2614
|
deltaType?: LineItemQuantityChangeType;
|
|
2955
2615
|
}
|
|
2956
|
-
declare enum LineItemQuantityChangeType {
|
|
2616
|
+
export declare enum LineItemQuantityChangeType {
|
|
2957
2617
|
/** Quantity increased. */
|
|
2958
2618
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2959
2619
|
/** Quantity decreased. */
|
|
2960
2620
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2961
2621
|
}
|
|
2962
|
-
interface LineItemPriceChange {
|
|
2622
|
+
export interface LineItemPriceChange {
|
|
2963
2623
|
/** Item price before update. */
|
|
2964
2624
|
originalPrice?: Price;
|
|
2965
2625
|
/** Item price after update. */
|
|
2966
2626
|
newPrice?: Price;
|
|
2967
2627
|
}
|
|
2968
|
-
interface ManagedLineItem {
|
|
2628
|
+
export interface ManagedLineItem {
|
|
2969
2629
|
/**
|
|
2970
2630
|
* Line item ID.
|
|
2971
2631
|
* @format GUID
|
|
2972
2632
|
*/
|
|
2973
|
-
|
|
2633
|
+
id?: string;
|
|
2974
2634
|
/** Item name. */
|
|
2975
2635
|
name?: ProductName;
|
|
2976
2636
|
/**
|
|
@@ -2980,12 +2640,12 @@ interface ManagedLineItem {
|
|
|
2980
2640
|
*/
|
|
2981
2641
|
quantity?: number;
|
|
2982
2642
|
}
|
|
2983
|
-
interface ManagedDiscount {
|
|
2643
|
+
export interface ManagedDiscount {
|
|
2984
2644
|
/**
|
|
2985
2645
|
* Discount id.
|
|
2986
2646
|
* @format GUID
|
|
2987
2647
|
*/
|
|
2988
|
-
|
|
2648
|
+
id?: string;
|
|
2989
2649
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2990
2650
|
name?: TranslatedValue;
|
|
2991
2651
|
/** Line items discount applies to. */
|
|
@@ -2993,7 +2653,7 @@ interface ManagedDiscount {
|
|
|
2993
2653
|
/** Discount amount. */
|
|
2994
2654
|
totalAmount?: Price;
|
|
2995
2655
|
}
|
|
2996
|
-
interface TranslatedValue {
|
|
2656
|
+
export interface TranslatedValue {
|
|
2997
2657
|
/**
|
|
2998
2658
|
* Value in site default language.
|
|
2999
2659
|
* @minLength 1
|
|
@@ -3005,23 +2665,23 @@ interface TranslatedValue {
|
|
|
3005
2665
|
*/
|
|
3006
2666
|
translated?: string | null;
|
|
3007
2667
|
}
|
|
3008
|
-
interface LineItemAmount {
|
|
2668
|
+
export interface LineItemAmount {
|
|
3009
2669
|
/**
|
|
3010
2670
|
* Order line item id
|
|
3011
2671
|
* @format GUID
|
|
3012
2672
|
*/
|
|
3013
|
-
|
|
2673
|
+
id?: string;
|
|
3014
2674
|
/** Item name. */
|
|
3015
2675
|
name?: ProductName;
|
|
3016
2676
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
3017
2677
|
amount?: Price;
|
|
3018
2678
|
}
|
|
3019
|
-
interface ManagedAdditionalFee {
|
|
2679
|
+
export interface ManagedAdditionalFee {
|
|
3020
2680
|
/**
|
|
3021
2681
|
* Additional fee id.
|
|
3022
2682
|
* @format GUID
|
|
3023
2683
|
*/
|
|
3024
|
-
|
|
2684
|
+
id?: string;
|
|
3025
2685
|
/** Additional fee name. */
|
|
3026
2686
|
name?: TranslatedValue;
|
|
3027
2687
|
/** Line items additional fee applies to. */
|
|
@@ -3029,19 +2689,19 @@ interface ManagedAdditionalFee {
|
|
|
3029
2689
|
/** Additional fee amount. */
|
|
3030
2690
|
totalAmount?: Price;
|
|
3031
2691
|
}
|
|
3032
|
-
interface TotalPriceChange {
|
|
2692
|
+
export interface TotalPriceChange {
|
|
3033
2693
|
/** Order’s total price after discounts and tax. Before update */
|
|
3034
2694
|
originalTotal?: Price;
|
|
3035
2695
|
/** Order’s total price after discounts and tax. After update */
|
|
3036
2696
|
newTotal?: Price;
|
|
3037
2697
|
}
|
|
3038
|
-
interface ShippingInformationChange {
|
|
2698
|
+
export interface ShippingInformationChange {
|
|
3039
2699
|
/** Order’s Shipping Information. Before update */
|
|
3040
2700
|
originalShippingInfo?: ShippingInformation;
|
|
3041
2701
|
/** Order’s Shipping Information. After update */
|
|
3042
2702
|
newShippingInfo?: ShippingInformation;
|
|
3043
2703
|
}
|
|
3044
|
-
interface ShippingInformation {
|
|
2704
|
+
export interface ShippingInformation {
|
|
3045
2705
|
/** Order’s shipping price. */
|
|
3046
2706
|
total?: Price;
|
|
3047
2707
|
/**
|
|
@@ -3051,7 +2711,7 @@ interface ShippingInformation {
|
|
|
3051
2711
|
shippingTitle?: string;
|
|
3052
2712
|
}
|
|
3053
2713
|
/** Payment method is saved for order */
|
|
3054
|
-
interface SavedPaymentMethod {
|
|
2714
|
+
export interface SavedPaymentMethod {
|
|
3055
2715
|
/**
|
|
3056
2716
|
* Payment method name
|
|
3057
2717
|
* @minLength 1
|
|
@@ -3065,7 +2725,7 @@ interface SavedPaymentMethod {
|
|
|
3065
2725
|
*/
|
|
3066
2726
|
description?: string | null;
|
|
3067
2727
|
}
|
|
3068
|
-
interface AuthorizedPaymentCreated {
|
|
2728
|
+
export interface AuthorizedPaymentCreated {
|
|
3069
2729
|
/**
|
|
3070
2730
|
* Payment ID of payment associated with this activity
|
|
3071
2731
|
* @format GUID
|
|
@@ -3084,7 +2744,7 @@ interface AuthorizedPaymentCreated {
|
|
|
3084
2744
|
*/
|
|
3085
2745
|
brand?: string | null;
|
|
3086
2746
|
}
|
|
3087
|
-
interface AuthorizedPaymentCaptured {
|
|
2747
|
+
export interface AuthorizedPaymentCaptured {
|
|
3088
2748
|
/**
|
|
3089
2749
|
* Payment ID of payment associated with this activity
|
|
3090
2750
|
* @format GUID
|
|
@@ -3103,7 +2763,7 @@ interface AuthorizedPaymentCaptured {
|
|
|
3103
2763
|
*/
|
|
3104
2764
|
brand?: string | null;
|
|
3105
2765
|
}
|
|
3106
|
-
interface AuthorizedPaymentVoided {
|
|
2766
|
+
export interface AuthorizedPaymentVoided {
|
|
3107
2767
|
/**
|
|
3108
2768
|
* Payment ID of payment associated with this activity
|
|
3109
2769
|
* @format GUID
|
|
@@ -3122,7 +2782,7 @@ interface AuthorizedPaymentVoided {
|
|
|
3122
2782
|
*/
|
|
3123
2783
|
brand?: string | null;
|
|
3124
2784
|
}
|
|
3125
|
-
interface RefundInitiated {
|
|
2785
|
+
export interface RefundInitiated {
|
|
3126
2786
|
/**
|
|
3127
2787
|
* Refund ID.
|
|
3128
2788
|
* @format GUID
|
|
@@ -3142,7 +2802,7 @@ interface RefundInitiated {
|
|
|
3142
2802
|
*/
|
|
3143
2803
|
reason?: string | null;
|
|
3144
2804
|
}
|
|
3145
|
-
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
2805
|
+
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
3146
2806
|
/** Regular payment refund. */
|
|
3147
2807
|
regular?: RegularPaymentRefund;
|
|
3148
2808
|
/** Gift card payment refund. */
|
|
@@ -3158,7 +2818,7 @@ interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
3158
2818
|
externalRefund?: boolean;
|
|
3159
2819
|
}
|
|
3160
2820
|
/** @oneof */
|
|
3161
|
-
interface RefundedPaymentKindOneOf {
|
|
2821
|
+
export interface RefundedPaymentKindOneOf {
|
|
3162
2822
|
/** Regular payment refund. */
|
|
3163
2823
|
regular?: RegularPaymentRefund;
|
|
3164
2824
|
/** Gift card payment refund. */
|
|
@@ -3166,7 +2826,7 @@ interface RefundedPaymentKindOneOf {
|
|
|
3166
2826
|
/** Membership payment refund. */
|
|
3167
2827
|
membership?: MembershipPaymentRefund;
|
|
3168
2828
|
}
|
|
3169
|
-
interface RegularPaymentRefund {
|
|
2829
|
+
export interface RegularPaymentRefund {
|
|
3170
2830
|
/** Refund amount */
|
|
3171
2831
|
amount?: Price;
|
|
3172
2832
|
/**
|
|
@@ -3180,7 +2840,7 @@ interface RegularPaymentRefund {
|
|
|
3180
2840
|
*/
|
|
3181
2841
|
brand?: string | null;
|
|
3182
2842
|
}
|
|
3183
|
-
interface GiftCardPaymentRefund {
|
|
2843
|
+
export interface GiftCardPaymentRefund {
|
|
3184
2844
|
/**
|
|
3185
2845
|
* Gift card payment ID
|
|
3186
2846
|
* @minLength 1
|
|
@@ -3190,7 +2850,7 @@ interface GiftCardPaymentRefund {
|
|
|
3190
2850
|
/** Refund amount */
|
|
3191
2851
|
amount?: Price;
|
|
3192
2852
|
}
|
|
3193
|
-
interface MembershipPaymentRefund {
|
|
2853
|
+
export interface MembershipPaymentRefund {
|
|
3194
2854
|
/**
|
|
3195
2855
|
* Membership ID
|
|
3196
2856
|
* @minLength 1
|
|
@@ -3198,7 +2858,7 @@ interface MembershipPaymentRefund {
|
|
|
3198
2858
|
*/
|
|
3199
2859
|
membershipId?: string | null;
|
|
3200
2860
|
}
|
|
3201
|
-
interface PaymentRefunded {
|
|
2861
|
+
export interface PaymentRefunded {
|
|
3202
2862
|
/**
|
|
3203
2863
|
* Refund ID.
|
|
3204
2864
|
* @format GUID
|
|
@@ -3207,7 +2867,7 @@ interface PaymentRefunded {
|
|
|
3207
2867
|
/** Details about the refunded payment. */
|
|
3208
2868
|
payment?: RefundedPayment;
|
|
3209
2869
|
}
|
|
3210
|
-
interface PaymentRefundFailed {
|
|
2870
|
+
export interface PaymentRefundFailed {
|
|
3211
2871
|
/**
|
|
3212
2872
|
* Refund ID.
|
|
3213
2873
|
* @format GUID
|
|
@@ -3216,7 +2876,7 @@ interface PaymentRefundFailed {
|
|
|
3216
2876
|
/** Details about the failed payment refund. */
|
|
3217
2877
|
payment?: RefundedPayment;
|
|
3218
2878
|
}
|
|
3219
|
-
interface RefundedAsStoreCredit {
|
|
2879
|
+
export interface RefundedAsStoreCredit {
|
|
3220
2880
|
/** Refund amount */
|
|
3221
2881
|
amount?: Price;
|
|
3222
2882
|
/**
|
|
@@ -3225,7 +2885,7 @@ interface RefundedAsStoreCredit {
|
|
|
3225
2885
|
*/
|
|
3226
2886
|
reason?: string | null;
|
|
3227
2887
|
}
|
|
3228
|
-
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2888
|
+
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
3229
2889
|
/** Regular payment. */
|
|
3230
2890
|
regular?: RegularPayment;
|
|
3231
2891
|
/**
|
|
@@ -3235,22 +2895,22 @@ interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
3235
2895
|
paymentId?: string;
|
|
3236
2896
|
}
|
|
3237
2897
|
/** @oneof */
|
|
3238
|
-
interface PaymentPendingPaymentDetailsOneOf {
|
|
2898
|
+
export interface PaymentPendingPaymentDetailsOneOf {
|
|
3239
2899
|
/** Regular payment. */
|
|
3240
2900
|
regular?: RegularPayment;
|
|
3241
2901
|
}
|
|
3242
|
-
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
2902
|
+
export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
3243
2903
|
/** Whether regular card used */
|
|
3244
2904
|
creditCardDetails?: CreditCardDetails;
|
|
3245
2905
|
/** Payment amount */
|
|
3246
2906
|
amount?: Price;
|
|
3247
2907
|
}
|
|
3248
2908
|
/** @oneof */
|
|
3249
|
-
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
2909
|
+
export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
3250
2910
|
/** Whether regular card used */
|
|
3251
2911
|
creditCardDetails?: CreditCardDetails;
|
|
3252
2912
|
}
|
|
3253
|
-
interface CreditCardDetails {
|
|
2913
|
+
export interface CreditCardDetails {
|
|
3254
2914
|
/**
|
|
3255
2915
|
* The last 4 digits of the card number.
|
|
3256
2916
|
* @maxLength 4
|
|
@@ -3262,7 +2922,7 @@ interface CreditCardDetails {
|
|
|
3262
2922
|
*/
|
|
3263
2923
|
brand?: string | null;
|
|
3264
2924
|
}
|
|
3265
|
-
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2925
|
+
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
3266
2926
|
/** Regular payment. */
|
|
3267
2927
|
regular?: RegularPayment;
|
|
3268
2928
|
/**
|
|
@@ -3272,11 +2932,11 @@ interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
3272
2932
|
paymentId?: string;
|
|
3273
2933
|
}
|
|
3274
2934
|
/** @oneof */
|
|
3275
|
-
interface PaymentCanceledPaymentDetailsOneOf {
|
|
2935
|
+
export interface PaymentCanceledPaymentDetailsOneOf {
|
|
3276
2936
|
/** Regular payment. */
|
|
3277
2937
|
regular?: RegularPayment;
|
|
3278
2938
|
}
|
|
3279
|
-
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2939
|
+
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
3280
2940
|
/** Regular payment. */
|
|
3281
2941
|
regular?: RegularPayment;
|
|
3282
2942
|
/**
|
|
@@ -3286,11 +2946,11 @@ interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
3286
2946
|
paymentId?: string;
|
|
3287
2947
|
}
|
|
3288
2948
|
/** @oneof */
|
|
3289
|
-
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
2949
|
+
export interface PaymentDeclinedPaymentDetailsOneOf {
|
|
3290
2950
|
/** Regular payment. */
|
|
3291
2951
|
regular?: RegularPayment;
|
|
3292
2952
|
}
|
|
3293
|
-
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
2953
|
+
export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
3294
2954
|
/** Receipt created by Wix */
|
|
3295
2955
|
wixReceipt?: WixReceipt;
|
|
3296
2956
|
/** Receipt created by an external system. */
|
|
@@ -3302,13 +2962,13 @@ interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
3302
2962
|
paymentId?: string;
|
|
3303
2963
|
}
|
|
3304
2964
|
/** @oneof */
|
|
3305
|
-
interface ReceiptCreatedReceiptInfoOneOf {
|
|
2965
|
+
export interface ReceiptCreatedReceiptInfoOneOf {
|
|
3306
2966
|
/** Receipt created by Wix */
|
|
3307
2967
|
wixReceipt?: WixReceipt;
|
|
3308
2968
|
/** Receipt created by an external system. */
|
|
3309
2969
|
externalReceipt?: ExternalReceipt;
|
|
3310
2970
|
}
|
|
3311
|
-
interface WixReceipt {
|
|
2971
|
+
export interface WixReceipt {
|
|
3312
2972
|
/**
|
|
3313
2973
|
* Receipt ID
|
|
3314
2974
|
* @format GUID
|
|
@@ -3321,7 +2981,7 @@ interface WixReceipt {
|
|
|
3321
2981
|
*/
|
|
3322
2982
|
displayNumber?: string | null;
|
|
3323
2983
|
}
|
|
3324
|
-
interface ExternalReceipt {
|
|
2984
|
+
export interface ExternalReceipt {
|
|
3325
2985
|
/**
|
|
3326
2986
|
* Receipt ID
|
|
3327
2987
|
* @maxLength 100
|
|
@@ -3334,7 +2994,7 @@ interface ExternalReceipt {
|
|
|
3334
2994
|
*/
|
|
3335
2995
|
displayNumber?: string | null;
|
|
3336
2996
|
}
|
|
3337
|
-
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2997
|
+
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
3338
2998
|
/** Receipt created by Wix */
|
|
3339
2999
|
wixReceipt?: WixReceipt;
|
|
3340
3000
|
/** Receipt created by an external system. */
|
|
@@ -3346,13 +3006,13 @@ interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
3346
3006
|
paymentId?: string;
|
|
3347
3007
|
}
|
|
3348
3008
|
/** @oneof */
|
|
3349
|
-
interface ReceiptSentReceiptInfoOneOf {
|
|
3009
|
+
export interface ReceiptSentReceiptInfoOneOf {
|
|
3350
3010
|
/** Receipt created by Wix */
|
|
3351
3011
|
wixReceipt?: WixReceipt;
|
|
3352
3012
|
/** Receipt created by an external system. */
|
|
3353
3013
|
externalReceipt?: ExternalReceipt;
|
|
3354
3014
|
}
|
|
3355
|
-
declare enum ActivityType {
|
|
3015
|
+
export declare enum ActivityType {
|
|
3356
3016
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3357
3017
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3358
3018
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3389,11 +3049,11 @@ declare enum ActivityType {
|
|
|
3389
3049
|
/** @documentationMaturity preview */
|
|
3390
3050
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3391
3051
|
}
|
|
3392
|
-
declare enum AttributionSource {
|
|
3052
|
+
export declare enum AttributionSource {
|
|
3393
3053
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3394
3054
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3395
3055
|
}
|
|
3396
|
-
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3056
|
+
export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3397
3057
|
/**
|
|
3398
3058
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3399
3059
|
* For example, via POS (point of service).
|
|
@@ -3417,7 +3077,7 @@ interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3417
3077
|
appId?: string;
|
|
3418
3078
|
}
|
|
3419
3079
|
/** @oneof */
|
|
3420
|
-
interface V1CreatedByStringOneOf {
|
|
3080
|
+
export interface V1CreatedByStringOneOf {
|
|
3421
3081
|
/**
|
|
3422
3082
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3423
3083
|
* For example, via POS (point of service).
|
|
@@ -3440,7 +3100,7 @@ interface V1CreatedByStringOneOf {
|
|
|
3440
3100
|
*/
|
|
3441
3101
|
appId?: string;
|
|
3442
3102
|
}
|
|
3443
|
-
interface ChannelInfo {
|
|
3103
|
+
export interface ChannelInfo {
|
|
3444
3104
|
/** Sales channel that submitted the order. */
|
|
3445
3105
|
type?: ChannelType;
|
|
3446
3106
|
/**
|
|
@@ -3454,7 +3114,7 @@ interface ChannelInfo {
|
|
|
3454
3114
|
*/
|
|
3455
3115
|
externalOrderUrl?: string | null;
|
|
3456
3116
|
}
|
|
3457
|
-
declare enum ChannelType {
|
|
3117
|
+
export declare enum ChannelType {
|
|
3458
3118
|
/** Unspecified sales channel. This value is not supported. */
|
|
3459
3119
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3460
3120
|
/** A web client. */
|
|
@@ -3488,7 +3148,7 @@ declare enum ChannelType {
|
|
|
3488
3148
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3489
3149
|
FAIRE_COM = "FAIRE_COM"
|
|
3490
3150
|
}
|
|
3491
|
-
interface CustomField {
|
|
3151
|
+
export interface CustomField {
|
|
3492
3152
|
/** Custom field value. */
|
|
3493
3153
|
value?: any;
|
|
3494
3154
|
/**
|
|
@@ -3504,7 +3164,7 @@ interface CustomField {
|
|
|
3504
3164
|
*/
|
|
3505
3165
|
translatedTitle?: string | null;
|
|
3506
3166
|
}
|
|
3507
|
-
interface V1BalanceSummary {
|
|
3167
|
+
export interface V1BalanceSummary {
|
|
3508
3168
|
/**
|
|
3509
3169
|
* Current amount left to pay.
|
|
3510
3170
|
* @readonly
|
|
@@ -3527,19 +3187,13 @@ interface V1BalanceSummary {
|
|
|
3527
3187
|
* @readonly
|
|
3528
3188
|
*/
|
|
3529
3189
|
authorized?: Price;
|
|
3530
|
-
/**
|
|
3531
|
-
* Sum of all pending refund transactions.
|
|
3532
|
-
* @internal
|
|
3533
|
-
* @readonly
|
|
3534
|
-
*/
|
|
3535
|
-
pendingRefund?: Price;
|
|
3536
3190
|
/**
|
|
3537
3191
|
* Sum of all pending transactions.
|
|
3538
3192
|
* @readonly
|
|
3539
3193
|
*/
|
|
3540
3194
|
pending?: Price;
|
|
3541
3195
|
}
|
|
3542
|
-
interface FulfillmentStatusesAggregate {
|
|
3196
|
+
export interface FulfillmentStatusesAggregate {
|
|
3543
3197
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3544
3198
|
statuses?: string[] | null;
|
|
3545
3199
|
}
|
|
@@ -3565,13 +3219,13 @@ interface FulfillmentStatusesAggregate {
|
|
|
3565
3219
|
* }
|
|
3566
3220
|
* }
|
|
3567
3221
|
*/
|
|
3568
|
-
interface Tags {
|
|
3222
|
+
export interface Tags {
|
|
3569
3223
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3570
3224
|
privateTags?: TagList;
|
|
3571
3225
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3572
3226
|
tags?: TagList;
|
|
3573
3227
|
}
|
|
3574
|
-
interface TagList {
|
|
3228
|
+
export interface TagList {
|
|
3575
3229
|
/**
|
|
3576
3230
|
* List of tag IDs
|
|
3577
3231
|
* @maxSize 100
|
|
@@ -3579,79 +3233,28 @@ interface TagList {
|
|
|
3579
3233
|
*/
|
|
3580
3234
|
tagIds?: string[];
|
|
3581
3235
|
}
|
|
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;
|
|
3236
|
+
export interface CreateOrderFromDraftRequest {
|
|
3605
3237
|
}
|
|
3606
|
-
interface OrderCreateSettings {
|
|
3607
|
-
/**
|
|
3608
|
-
* Notification settings to be applied on order creation
|
|
3609
|
-
* @internal
|
|
3610
|
-
*/
|
|
3611
|
-
notifications?: OrderCreateNotifications;
|
|
3238
|
+
export interface OrderCreateSettings {
|
|
3612
3239
|
}
|
|
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;
|
|
3240
|
+
export interface OrderCreateNotifications {
|
|
3628
3241
|
}
|
|
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;
|
|
3242
|
+
export interface CreateOrderFromDraftResponse {
|
|
3640
3243
|
}
|
|
3641
|
-
interface DeleteDraftOrderRequest {
|
|
3244
|
+
export interface DeleteDraftOrderRequest {
|
|
3642
3245
|
/**
|
|
3643
3246
|
* The draft order id
|
|
3644
3247
|
* @format GUID
|
|
3645
3248
|
*/
|
|
3646
3249
|
draftOrderId: string;
|
|
3647
3250
|
}
|
|
3648
|
-
interface DeleteDraftOrderResponse {
|
|
3251
|
+
export interface DeleteDraftOrderResponse {
|
|
3649
3252
|
}
|
|
3650
|
-
interface QueryDraftOrdersRequest {
|
|
3253
|
+
export interface QueryDraftOrdersRequest {
|
|
3651
3254
|
/** WQL expression */
|
|
3652
3255
|
query?: CursorQuery;
|
|
3653
3256
|
}
|
|
3654
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3257
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3655
3258
|
/**
|
|
3656
3259
|
* Cursor paging options.
|
|
3657
3260
|
*
|
|
@@ -3673,7 +3276,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3673
3276
|
sort?: Sorting[];
|
|
3674
3277
|
}
|
|
3675
3278
|
/** @oneof */
|
|
3676
|
-
interface CursorQueryPagingMethodOneOf {
|
|
3279
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
3677
3280
|
/**
|
|
3678
3281
|
* Cursor paging options.
|
|
3679
3282
|
*
|
|
@@ -3681,7 +3284,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
3681
3284
|
*/
|
|
3682
3285
|
cursorPaging?: CursorPaging;
|
|
3683
3286
|
}
|
|
3684
|
-
interface Sorting {
|
|
3287
|
+
export interface Sorting {
|
|
3685
3288
|
/**
|
|
3686
3289
|
* Name of the field to sort by.
|
|
3687
3290
|
* @maxLength 512
|
|
@@ -3690,11 +3293,11 @@ interface Sorting {
|
|
|
3690
3293
|
/** Sort order. */
|
|
3691
3294
|
order?: SortOrder;
|
|
3692
3295
|
}
|
|
3693
|
-
declare enum SortOrder {
|
|
3296
|
+
export declare enum SortOrder {
|
|
3694
3297
|
ASC = "ASC",
|
|
3695
3298
|
DESC = "DESC"
|
|
3696
3299
|
}
|
|
3697
|
-
interface CursorPaging {
|
|
3300
|
+
export interface CursorPaging {
|
|
3698
3301
|
/**
|
|
3699
3302
|
* Maximum number of items to return in the results.
|
|
3700
3303
|
* @max 100
|
|
@@ -3709,13 +3312,13 @@ interface CursorPaging {
|
|
|
3709
3312
|
*/
|
|
3710
3313
|
cursor?: string | null;
|
|
3711
3314
|
}
|
|
3712
|
-
interface QueryDraftOrdersResponse {
|
|
3315
|
+
export interface QueryDraftOrdersResponse {
|
|
3713
3316
|
/** list of edits per order */
|
|
3714
3317
|
draftOrders?: DraftOrder[];
|
|
3715
3318
|
/** Paging metadata. */
|
|
3716
3319
|
pagingMetadata?: CursorPagingMetadata;
|
|
3717
3320
|
}
|
|
3718
|
-
interface CursorPagingMetadata {
|
|
3321
|
+
export interface CursorPagingMetadata {
|
|
3719
3322
|
/** Number of items returned in current page. */
|
|
3720
3323
|
count?: number | null;
|
|
3721
3324
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3728,7 +3331,7 @@ interface CursorPagingMetadata {
|
|
|
3728
3331
|
*/
|
|
3729
3332
|
hasNext?: boolean | null;
|
|
3730
3333
|
}
|
|
3731
|
-
interface Cursors {
|
|
3334
|
+
export interface Cursors {
|
|
3732
3335
|
/**
|
|
3733
3336
|
* Cursor string pointing to the next page in the list of results.
|
|
3734
3337
|
* @maxLength 16000
|
|
@@ -3740,48 +3343,30 @@ interface Cursors {
|
|
|
3740
3343
|
*/
|
|
3741
3344
|
prev?: string | null;
|
|
3742
3345
|
}
|
|
3743
|
-
interface UpdateExtendedFieldsRequest {
|
|
3346
|
+
export interface UpdateExtendedFieldsRequest {
|
|
3744
3347
|
/** ID of the entity to update. */
|
|
3745
|
-
|
|
3348
|
+
id?: string;
|
|
3746
3349
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3747
3350
|
namespace?: string;
|
|
3748
3351
|
/** 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. */
|
|
3749
3352
|
namespaceData?: Record<string, any> | null;
|
|
3750
3353
|
}
|
|
3751
|
-
interface UpdateExtendedFieldsResponse {
|
|
3354
|
+
export interface UpdateExtendedFieldsResponse {
|
|
3752
3355
|
/** Updated DraftOrder */
|
|
3753
3356
|
draftOrder?: DraftOrder;
|
|
3754
3357
|
}
|
|
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;
|
|
3358
|
+
export interface SetTaxExemptionRequest {
|
|
3769
3359
|
}
|
|
3770
|
-
interface SetTaxExemptionResponse {
|
|
3771
|
-
/**
|
|
3772
|
-
* The draft order details calculated with updated tax exemption.
|
|
3773
|
-
* @internal
|
|
3774
|
-
*/
|
|
3775
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3360
|
+
export interface SetTaxExemptionResponse {
|
|
3776
3361
|
}
|
|
3777
|
-
interface GetDraftEditabilityStatusRequest {
|
|
3362
|
+
export interface GetDraftEditabilityStatusRequest {
|
|
3778
3363
|
/**
|
|
3779
3364
|
* Draft order ID.
|
|
3780
3365
|
* @format GUID
|
|
3781
3366
|
*/
|
|
3782
3367
|
draftOrderId?: string | null;
|
|
3783
3368
|
}
|
|
3784
|
-
interface GetDraftEditabilityStatusResponse {
|
|
3369
|
+
export interface GetDraftEditabilityStatusResponse {
|
|
3785
3370
|
/**
|
|
3786
3371
|
* Draft order ID.
|
|
3787
3372
|
* @format GUID
|
|
@@ -3793,27 +3378,11 @@ interface GetDraftEditabilityStatusResponse {
|
|
|
3793
3378
|
*/
|
|
3794
3379
|
status?: EditingStatus;
|
|
3795
3380
|
}
|
|
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;
|
|
3381
|
+
export interface SetBusinessLocationRequest {
|
|
3808
3382
|
}
|
|
3809
|
-
interface SetBusinessLocationResponse {
|
|
3810
|
-
/**
|
|
3811
|
-
* The draft order details calculated with updated business location.
|
|
3812
|
-
* @internal
|
|
3813
|
-
*/
|
|
3814
|
-
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3383
|
+
export interface SetBusinessLocationResponse {
|
|
3815
3384
|
}
|
|
3816
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3385
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3817
3386
|
createdEvent?: EntityCreatedEvent;
|
|
3818
3387
|
updatedEvent?: EntityUpdatedEvent;
|
|
3819
3388
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3822,7 +3391,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3822
3391
|
* Unique event ID.
|
|
3823
3392
|
* Allows clients to ignore duplicate webhooks.
|
|
3824
3393
|
*/
|
|
3825
|
-
|
|
3394
|
+
id?: string;
|
|
3826
3395
|
/**
|
|
3827
3396
|
* Assumes actions are also always typed to an entity_type
|
|
3828
3397
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3856,34 +3425,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3856
3425
|
entityEventSequence?: string | null;
|
|
3857
3426
|
}
|
|
3858
3427
|
/** @oneof */
|
|
3859
|
-
interface DomainEventBodyOneOf {
|
|
3428
|
+
export interface DomainEventBodyOneOf {
|
|
3860
3429
|
createdEvent?: EntityCreatedEvent;
|
|
3861
3430
|
updatedEvent?: EntityUpdatedEvent;
|
|
3862
3431
|
deletedEvent?: EntityDeletedEvent;
|
|
3863
3432
|
actionEvent?: ActionEvent;
|
|
3864
3433
|
}
|
|
3865
|
-
interface EntityCreatedEvent {
|
|
3866
|
-
|
|
3434
|
+
export interface EntityCreatedEvent {
|
|
3435
|
+
entityAsJson?: string;
|
|
3436
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3437
|
+
restoreInfo?: RestoreInfo;
|
|
3867
3438
|
}
|
|
3868
|
-
interface RestoreInfo {
|
|
3439
|
+
export interface RestoreInfo {
|
|
3869
3440
|
deletedDate?: Date | null;
|
|
3870
3441
|
}
|
|
3871
|
-
interface EntityUpdatedEvent {
|
|
3442
|
+
export interface EntityUpdatedEvent {
|
|
3872
3443
|
/**
|
|
3873
3444
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3874
3445
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3875
3446
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3876
3447
|
*/
|
|
3877
|
-
|
|
3448
|
+
currentEntityAsJson?: string;
|
|
3878
3449
|
}
|
|
3879
|
-
interface EntityDeletedEvent {
|
|
3450
|
+
export interface EntityDeletedEvent {
|
|
3880
3451
|
/** Entity that was deleted */
|
|
3881
|
-
|
|
3452
|
+
deletedEntityAsJson?: string | null;
|
|
3882
3453
|
}
|
|
3883
|
-
interface ActionEvent {
|
|
3884
|
-
|
|
3454
|
+
export interface ActionEvent {
|
|
3455
|
+
bodyAsJson?: string;
|
|
3885
3456
|
}
|
|
3886
|
-
interface MessageEnvelope {
|
|
3457
|
+
export interface MessageEnvelope {
|
|
3887
3458
|
/**
|
|
3888
3459
|
* App instance ID.
|
|
3889
3460
|
* @format GUID
|
|
@@ -3899,7 +3470,7 @@ interface MessageEnvelope {
|
|
|
3899
3470
|
/** Stringify payload. */
|
|
3900
3471
|
data?: string;
|
|
3901
3472
|
}
|
|
3902
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3473
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3903
3474
|
/**
|
|
3904
3475
|
* ID of a site visitor that has not logged in to the site.
|
|
3905
3476
|
* @format GUID
|
|
@@ -3924,7 +3495,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3924
3495
|
identityType?: WebhookIdentityType;
|
|
3925
3496
|
}
|
|
3926
3497
|
/** @oneof */
|
|
3927
|
-
interface IdentificationDataIdOneOf {
|
|
3498
|
+
export interface IdentificationDataIdOneOf {
|
|
3928
3499
|
/**
|
|
3929
3500
|
* ID of a site visitor that has not logged in to the site.
|
|
3930
3501
|
* @format GUID
|
|
@@ -3946,134 +3517,10 @@ interface IdentificationDataIdOneOf {
|
|
|
3946
3517
|
*/
|
|
3947
3518
|
appId?: string;
|
|
3948
3519
|
}
|
|
3949
|
-
declare enum WebhookIdentityType {
|
|
3520
|
+
export declare enum WebhookIdentityType {
|
|
3950
3521
|
UNKNOWN = "UNKNOWN",
|
|
3951
3522
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3952
3523
|
MEMBER = "MEMBER",
|
|
3953
3524
|
WIX_USER = "WIX_USER",
|
|
3954
3525
|
APP = "APP"
|
|
3955
3526
|
}
|
|
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[];
|
|
3983
|
-
}
|
|
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[];
|
|
3991
|
-
}
|
|
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;
|
|
4000
|
-
}
|
|
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>;
|
|
4077
|
-
}
|
|
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 };
|