@wix/auto_sdk_ecom_draft-orders 1.0.40 → 1.0.42
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 +65 -23
- package/build/cjs/index.js +1 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{ecom-v1-draft-order-draft-orders.universal-BVXrKSFI.d.ts → index.typings.d.ts} +747 -1
- package/build/cjs/index.typings.js +4958 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +65 -23
- package/build/es/index.mjs +1 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/{ecom-v1-draft-order-draft-orders.universal-BVXrKSFI.d.mts → index.typings.d.mts} +747 -1
- package/build/es/index.typings.mjs +4884 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +65 -23
- package/build/internal/cjs/index.js +1 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{ecom-v1-draft-order-draft-orders.universal-DfcxUgXs.d.ts → index.typings.d.ts} +779 -1
- package/build/internal/cjs/index.typings.js +4958 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +65 -23
- package/build/internal/es/index.mjs +1 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{ecom-v1-draft-order-draft-orders.universal-DfcxUgXs.d.mts → index.typings.d.mts} +779 -1
- package/build/internal/es/index.typings.mjs +4884 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +2 -2
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* Draft Order main entity.
|
|
3
5
|
* A temporary version of an order, allowing modifications before finalization.
|
|
@@ -451,6 +453,8 @@ declare enum DescriptionLineType {
|
|
|
451
453
|
/** Color type. */
|
|
452
454
|
COLOR = "COLOR"
|
|
453
455
|
}
|
|
456
|
+
/** @enumType */
|
|
457
|
+
type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
454
458
|
interface FocalPoint {
|
|
455
459
|
/** X-coordinate of the focal point. */
|
|
456
460
|
x?: number;
|
|
@@ -2859,6 +2863,16 @@ interface Activity extends ActivityContentOneOf {
|
|
|
2859
2863
|
* @internal
|
|
2860
2864
|
*/
|
|
2861
2865
|
receiptSent?: ReceiptSent;
|
|
2866
|
+
/**
|
|
2867
|
+
* Order received a chargeback for one of its' payments.
|
|
2868
|
+
* @internal
|
|
2869
|
+
*/
|
|
2870
|
+
chargebackCreated?: ChargebackCreated;
|
|
2871
|
+
/**
|
|
2872
|
+
* Chargeback reversed for one of the order's payments.
|
|
2873
|
+
* @internal
|
|
2874
|
+
*/
|
|
2875
|
+
chargebackReversed?: ChargebackReversed;
|
|
2862
2876
|
/**
|
|
2863
2877
|
* Activity ID.
|
|
2864
2878
|
* @format GUID
|
|
@@ -2941,6 +2955,16 @@ interface ActivityContentOneOf {
|
|
|
2941
2955
|
* @internal
|
|
2942
2956
|
*/
|
|
2943
2957
|
receiptSent?: ReceiptSent;
|
|
2958
|
+
/**
|
|
2959
|
+
* Order received a chargeback for one of its' payments.
|
|
2960
|
+
* @internal
|
|
2961
|
+
*/
|
|
2962
|
+
chargebackCreated?: ChargebackCreated;
|
|
2963
|
+
/**
|
|
2964
|
+
* Chargeback reversed for one of the order's payments.
|
|
2965
|
+
* @internal
|
|
2966
|
+
*/
|
|
2967
|
+
chargebackReversed?: ChargebackReversed;
|
|
2944
2968
|
}
|
|
2945
2969
|
interface CustomActivity {
|
|
2946
2970
|
/**
|
|
@@ -3477,6 +3501,40 @@ interface ReceiptSentReceiptInfoOneOf {
|
|
|
3477
3501
|
/** Receipt created by an external system. */
|
|
3478
3502
|
externalReceipt?: ExternalReceipt;
|
|
3479
3503
|
}
|
|
3504
|
+
interface ChargebackCreated {
|
|
3505
|
+
/**
|
|
3506
|
+
* ID of the payment that received a chargeback.
|
|
3507
|
+
* @format GUID
|
|
3508
|
+
*/
|
|
3509
|
+
paymentId?: string;
|
|
3510
|
+
/**
|
|
3511
|
+
* Chargeback ID.
|
|
3512
|
+
* @format GUID
|
|
3513
|
+
*/
|
|
3514
|
+
chargebackId?: string;
|
|
3515
|
+
/** Chargeback amount. */
|
|
3516
|
+
amount?: Price;
|
|
3517
|
+
/** Payment details. */
|
|
3518
|
+
paymentDetails?: RegularPayment;
|
|
3519
|
+
}
|
|
3520
|
+
interface ChargebackReversed {
|
|
3521
|
+
/**
|
|
3522
|
+
* ID of the payment involved with the chargeback.
|
|
3523
|
+
* @format GUID
|
|
3524
|
+
*/
|
|
3525
|
+
paymentId?: string;
|
|
3526
|
+
/**
|
|
3527
|
+
* Chargeback ID.
|
|
3528
|
+
* @format GUID
|
|
3529
|
+
*/
|
|
3530
|
+
chargebackId?: string;
|
|
3531
|
+
/** Chargeback amount. */
|
|
3532
|
+
amount?: Price;
|
|
3533
|
+
/** Chargeback reversal amount. */
|
|
3534
|
+
reversalAmount?: Price;
|
|
3535
|
+
/** Payment details. */
|
|
3536
|
+
paymentDetails?: RegularPayment;
|
|
3537
|
+
}
|
|
3480
3538
|
declare enum ActivityType {
|
|
3481
3539
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3482
3540
|
ORDER_PLACED = "ORDER_PLACED",
|
|
@@ -3669,6 +3727,18 @@ interface V1BalanceSummary {
|
|
|
3669
3727
|
* @readonly
|
|
3670
3728
|
*/
|
|
3671
3729
|
pending?: Price;
|
|
3730
|
+
/**
|
|
3731
|
+
* Sum of all transaction chargebacks.
|
|
3732
|
+
* @internal
|
|
3733
|
+
* @readonly
|
|
3734
|
+
*/
|
|
3735
|
+
chargeback?: Price;
|
|
3736
|
+
/**
|
|
3737
|
+
* Sum of all chargeback reversals.
|
|
3738
|
+
* @internal
|
|
3739
|
+
* @readonly
|
|
3740
|
+
*/
|
|
3741
|
+
chargebackReversal?: Price;
|
|
3672
3742
|
}
|
|
3673
3743
|
interface FulfillmentStatusesAggregate {
|
|
3674
3744
|
/** Unique string values based on Fulfillment entities statuses */
|
|
@@ -4030,6 +4100,235 @@ declare enum WebhookIdentityType {
|
|
|
4030
4100
|
}
|
|
4031
4101
|
/** @enumType */
|
|
4032
4102
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4103
|
+
type CreateDraftOrderApplicationErrors = {
|
|
4104
|
+
code?: 'ORDER_CANNOT_BE_EDITED';
|
|
4105
|
+
description?: string;
|
|
4106
|
+
data?: Record<string, any>;
|
|
4107
|
+
} | {
|
|
4108
|
+
code?: 'ORDER_IS_ALREADY_EDITED';
|
|
4109
|
+
description?: string;
|
|
4110
|
+
data?: Record<string, any>;
|
|
4111
|
+
} | {
|
|
4112
|
+
code?: 'FAILED_TO_FETCH_SETTINGS';
|
|
4113
|
+
description?: string;
|
|
4114
|
+
data?: Record<string, any>;
|
|
4115
|
+
} | {
|
|
4116
|
+
code?: 'NOT_AUTHORIZED_TO_READ_DRAFT_ORDERS';
|
|
4117
|
+
description?: string;
|
|
4118
|
+
data?: Record<string, any>;
|
|
4119
|
+
};
|
|
4120
|
+
type CreateEmptyDraftOrderApplicationErrors = {
|
|
4121
|
+
code?: 'FAILED_TO_FETCH_SETTINGS';
|
|
4122
|
+
description?: string;
|
|
4123
|
+
data?: Record<string, any>;
|
|
4124
|
+
};
|
|
4125
|
+
type AddLineItemsToDraftOrderApplicationErrors = {
|
|
4126
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4127
|
+
description?: string;
|
|
4128
|
+
data?: Record<string, any>;
|
|
4129
|
+
} | {
|
|
4130
|
+
code?: 'MAX_ITEMS_REACHED';
|
|
4131
|
+
description?: string;
|
|
4132
|
+
data?: Record<string, any>;
|
|
4133
|
+
} | {
|
|
4134
|
+
code?: 'MULTIPLE_ADDS_FOR_SAME_LINE_ITEM';
|
|
4135
|
+
description?: string;
|
|
4136
|
+
data?: Record<string, any>;
|
|
4137
|
+
} | {
|
|
4138
|
+
code?: 'CATALOG_ITEM_NOT_AVAILABLE';
|
|
4139
|
+
description?: string;
|
|
4140
|
+
data?: Record<string, any>;
|
|
4141
|
+
} | {
|
|
4142
|
+
code?: 'CATALOG_ITEM_NOT_FOUND';
|
|
4143
|
+
description?: string;
|
|
4144
|
+
data?: Record<string, any>;
|
|
4145
|
+
} | {
|
|
4146
|
+
code?: 'CATALOG_ITEM_PAYMENT_OPTION_UNSUPPORTED';
|
|
4147
|
+
description?: string;
|
|
4148
|
+
data?: Record<string, any>;
|
|
4149
|
+
} | {
|
|
4150
|
+
code?: 'CATALOG_ITEM_ALREADY_EXIST';
|
|
4151
|
+
description?: string;
|
|
4152
|
+
data?: Record<string, any>;
|
|
4153
|
+
} | {
|
|
4154
|
+
code?: 'GIFT_CARD_ITEM_UNSUPPORTED';
|
|
4155
|
+
description?: string;
|
|
4156
|
+
data?: Record<string, any>;
|
|
4157
|
+
} | {
|
|
4158
|
+
code?: 'SUBSCRIPTION_ITEM_UNSUPPORTED';
|
|
4159
|
+
description?: string;
|
|
4160
|
+
data?: Record<string, any>;
|
|
4161
|
+
};
|
|
4162
|
+
type UpdateLineItemsApplicationErrors = {
|
|
4163
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4164
|
+
description?: string;
|
|
4165
|
+
data?: Record<string, any>;
|
|
4166
|
+
} | {
|
|
4167
|
+
code?: 'LINE_ITEM_DOES_NOT_EXIST';
|
|
4168
|
+
description?: string;
|
|
4169
|
+
data?: Record<string, any>;
|
|
4170
|
+
} | {
|
|
4171
|
+
code?: 'MULTIPLE_CHANGES_FOR_SAME_LINE_ITEM';
|
|
4172
|
+
description?: string;
|
|
4173
|
+
data?: Record<string, any>;
|
|
4174
|
+
} | {
|
|
4175
|
+
code?: 'EMPTY_CHANGE_REQUEST';
|
|
4176
|
+
description?: string;
|
|
4177
|
+
data?: Record<string, any>;
|
|
4178
|
+
} | {
|
|
4179
|
+
code?: 'UPDATING_PRICE_OF_REMOVED_ITEM_IS_FORBIDDEN';
|
|
4180
|
+
description?: string;
|
|
4181
|
+
data?: Record<string, any>;
|
|
4182
|
+
} | {
|
|
4183
|
+
code?: 'UPDATING_LINE_ITEM_WITH_LOCATIONS';
|
|
4184
|
+
description?: string;
|
|
4185
|
+
data?: Record<string, any>;
|
|
4186
|
+
};
|
|
4187
|
+
type SetDiscountsApplicationErrors = {
|
|
4188
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4189
|
+
description?: string;
|
|
4190
|
+
data?: Record<string, any>;
|
|
4191
|
+
} | {
|
|
4192
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
|
|
4193
|
+
description?: string;
|
|
4194
|
+
data?: Record<string, any>;
|
|
4195
|
+
} | {
|
|
4196
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
|
|
4197
|
+
description?: string;
|
|
4198
|
+
data?: Record<string, any>;
|
|
4199
|
+
};
|
|
4200
|
+
type CreateCustomDiscountsApplicationErrors = {
|
|
4201
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4202
|
+
description?: string;
|
|
4203
|
+
data?: Record<string, any>;
|
|
4204
|
+
} | {
|
|
4205
|
+
code?: 'DISCOUNT_NOT_FOUND';
|
|
4206
|
+
description?: string;
|
|
4207
|
+
data?: Record<string, any>;
|
|
4208
|
+
} | {
|
|
4209
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ORDER_TOTALS';
|
|
4210
|
+
description?: string;
|
|
4211
|
+
data?: Record<string, any>;
|
|
4212
|
+
} | {
|
|
4213
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
|
|
4214
|
+
description?: string;
|
|
4215
|
+
data?: Record<string, any>;
|
|
4216
|
+
} | {
|
|
4217
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
|
|
4218
|
+
description?: string;
|
|
4219
|
+
data?: Record<string, any>;
|
|
4220
|
+
};
|
|
4221
|
+
type DeleteCustomDiscountsApplicationErrors = {
|
|
4222
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4223
|
+
description?: string;
|
|
4224
|
+
data?: Record<string, any>;
|
|
4225
|
+
} | {
|
|
4226
|
+
code?: 'DISCOUNT_NOT_FOUND';
|
|
4227
|
+
description?: string;
|
|
4228
|
+
data?: Record<string, any>;
|
|
4229
|
+
} | {
|
|
4230
|
+
code?: 'DISCOUNT_REMOVE_NOT_SUPPORTED';
|
|
4231
|
+
description?: string;
|
|
4232
|
+
data?: Record<string, any>;
|
|
4233
|
+
};
|
|
4234
|
+
type SetAdditionalFeesApplicationErrors = {
|
|
4235
|
+
code?: 'ADDITIONAL_FEE_NOT_FOUND';
|
|
4236
|
+
description?: string;
|
|
4237
|
+
data?: Record<string, any>;
|
|
4238
|
+
};
|
|
4239
|
+
type CreateCustomAdditionalFeesApplicationErrors = {
|
|
4240
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4241
|
+
description?: string;
|
|
4242
|
+
data?: Record<string, any>;
|
|
4243
|
+
} | {
|
|
4244
|
+
code?: 'LINE_ITEM_NOT_FOUND';
|
|
4245
|
+
description?: string;
|
|
4246
|
+
data?: Record<string, any>;
|
|
4247
|
+
};
|
|
4248
|
+
type DeleteCustomAdditionalFeesApplicationErrors = {
|
|
4249
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4250
|
+
description?: string;
|
|
4251
|
+
data?: Record<string, any>;
|
|
4252
|
+
} | {
|
|
4253
|
+
code?: 'ADDITIONAL_FEE_NOT_FOUND';
|
|
4254
|
+
description?: string;
|
|
4255
|
+
data?: Record<string, any>;
|
|
4256
|
+
} | {
|
|
4257
|
+
code?: 'ADDITIONAL_FEE_REMOVE_NOT_SUPPORTED';
|
|
4258
|
+
description?: string;
|
|
4259
|
+
data?: Record<string, any>;
|
|
4260
|
+
};
|
|
4261
|
+
type SetShippingInfoApplicationErrors = {
|
|
4262
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4263
|
+
description?: string;
|
|
4264
|
+
data?: Record<string, any>;
|
|
4265
|
+
};
|
|
4266
|
+
type SetBuyerInfoApplicationErrors = {
|
|
4267
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4268
|
+
description?: string;
|
|
4269
|
+
data?: Record<string, any>;
|
|
4270
|
+
};
|
|
4271
|
+
type SetRecipientInfoApplicationErrors = {
|
|
4272
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4273
|
+
description?: string;
|
|
4274
|
+
data?: Record<string, any>;
|
|
4275
|
+
};
|
|
4276
|
+
type SetBillingInfoApplicationErrors = {
|
|
4277
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4278
|
+
description?: string;
|
|
4279
|
+
data?: Record<string, any>;
|
|
4280
|
+
};
|
|
4281
|
+
type GetDraftOrderApplicationErrors = {
|
|
4282
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4283
|
+
description?: string;
|
|
4284
|
+
data?: Record<string, any>;
|
|
4285
|
+
};
|
|
4286
|
+
type CommitDraftOrderApplicationErrors = {
|
|
4287
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4288
|
+
description?: string;
|
|
4289
|
+
data?: Record<string, any>;
|
|
4290
|
+
} | {
|
|
4291
|
+
code?: 'DRAFT_ORDER_COMMIT_FAILED_VALIDATIONS';
|
|
4292
|
+
description?: string;
|
|
4293
|
+
data?: Record<string, any>;
|
|
4294
|
+
};
|
|
4295
|
+
type CreateOrderFromDraftApplicationErrors = {
|
|
4296
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4297
|
+
description?: string;
|
|
4298
|
+
data?: Record<string, any>;
|
|
4299
|
+
} | {
|
|
4300
|
+
code?: 'CREATE_ORDER_FAILED_VALIDATIONS';
|
|
4301
|
+
description?: string;
|
|
4302
|
+
data?: Record<string, any>;
|
|
4303
|
+
};
|
|
4304
|
+
type DeleteDraftOrderApplicationErrors = {
|
|
4305
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4306
|
+
description?: string;
|
|
4307
|
+
data?: Record<string, any>;
|
|
4308
|
+
} | {
|
|
4309
|
+
code?: 'DRAFT_ORDER_CANNOT_BE_DELETED';
|
|
4310
|
+
description?: string;
|
|
4311
|
+
data?: Record<string, any>;
|
|
4312
|
+
};
|
|
4313
|
+
type UpdateExtendedFieldsApplicationErrors = {
|
|
4314
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4315
|
+
description?: string;
|
|
4316
|
+
data?: Record<string, any>;
|
|
4317
|
+
};
|
|
4318
|
+
type SetTaxExemptionApplicationErrors = {
|
|
4319
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4320
|
+
description?: string;
|
|
4321
|
+
data?: Record<string, any>;
|
|
4322
|
+
};
|
|
4323
|
+
type SetBusinessLocationApplicationErrors = {
|
|
4324
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4325
|
+
description?: string;
|
|
4326
|
+
data?: Record<string, any>;
|
|
4327
|
+
} | {
|
|
4328
|
+
code?: 'BUSINESS_LOCATION_CANNOT_BE_EDITED';
|
|
4329
|
+
description?: string;
|
|
4330
|
+
data?: Record<string, any>;
|
|
4331
|
+
};
|
|
4033
4332
|
interface BaseEventMetadata {
|
|
4034
4333
|
/**
|
|
4035
4334
|
* App instance ID.
|
|
@@ -4078,13 +4377,118 @@ interface DraftOrderCreatedEnvelope {
|
|
|
4078
4377
|
entity: DraftOrder;
|
|
4079
4378
|
metadata: EventMetadata;
|
|
4080
4379
|
}
|
|
4380
|
+
/**
|
|
4381
|
+
* Triggered when a draft order is created.
|
|
4382
|
+
* @permissionScope Manage Stores - all permissions
|
|
4383
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4384
|
+
* @permissionScope Manage Stores
|
|
4385
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4386
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4387
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4388
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4389
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4390
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4391
|
+
* @webhook
|
|
4392
|
+
* @eventType wix.ecom.v1.draft_order_created
|
|
4393
|
+
* @slug created
|
|
4394
|
+
* @documentationMaturity preview
|
|
4395
|
+
*/
|
|
4396
|
+
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4081
4397
|
interface DraftOrderDeletedEnvelope {
|
|
4082
4398
|
metadata: EventMetadata;
|
|
4083
4399
|
}
|
|
4400
|
+
/**
|
|
4401
|
+
* Triggered when a draft order is deleted.
|
|
4402
|
+
* @permissionScope Manage Stores - all permissions
|
|
4403
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4404
|
+
* @permissionScope Manage Stores
|
|
4405
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4406
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4407
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4408
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4409
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4410
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4411
|
+
* @webhook
|
|
4412
|
+
* @eventType wix.ecom.v1.draft_order_deleted
|
|
4413
|
+
* @slug deleted
|
|
4414
|
+
* @documentationMaturity preview
|
|
4415
|
+
*/
|
|
4416
|
+
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
4084
4417
|
interface DraftOrderUpdatedEnvelope {
|
|
4085
4418
|
entity: DraftOrder;
|
|
4086
4419
|
metadata: EventMetadata;
|
|
4087
4420
|
}
|
|
4421
|
+
/**
|
|
4422
|
+
* Triggered when a draft order is updated.
|
|
4423
|
+
* @permissionScope Manage Stores - all permissions
|
|
4424
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4425
|
+
* @permissionScope Manage Stores
|
|
4426
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4427
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4428
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4429
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4430
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4431
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4432
|
+
* @webhook
|
|
4433
|
+
* @eventType wix.ecom.v1.draft_order_updated
|
|
4434
|
+
* @slug updated
|
|
4435
|
+
* @documentationMaturity preview
|
|
4436
|
+
*/
|
|
4437
|
+
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4438
|
+
type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `lineItems.${number}.changedDetails.priceBeforeChange.amount` | `lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `lineItems.${number}.removed` | `lineItems.${number}.lineItem._id` | `lineItems.${number}.lineItem.productName.original` | `lineItems.${number}.lineItem.catalogReference.catalogItemId` | `lineItems.${number}.lineItem.catalogReference.appId` | `lineItems.${number}.lineItem.quantity` | `lineItems.${number}.lineItem.physicalProperties.shippable` | `lineItems.${number}.lineItem.itemType.preset` | `lineItems.${number}.lineItem.itemType.custom` | `lineItems.${number}.lineItem.paymentOption` | `lineItems.${number}.lineItem.taxDetails.taxRate` | `lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `lineItems.${number}.lineItem.digitalFile.fileId` | `lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.lineItem.taxableAddress.addressType` | `shippingInfo.added` | `shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.amount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.formattedAmount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.taxDetails.taxRate` | `shippingInfo.removed` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.additionalFee.name` | `additionalFees.${number}.additionalFee.price.amount` | `additionalFees.${number}.additionalFee.price.formattedAmount` | `additionalFees.${number}.additionalFee.taxDetails.taxRate` | `additionalFees.${number}.additionalFee._id` | `additionalFees.${number}.taxDetails.taxable` | `additionalFees.${number}.source` | `additionalFees.${number}.applied` | `discounts` | `discounts.${number}.discount.coupon._id` | `discounts.${number}.discount.coupon.code` | `discounts.${number}.discount.coupon.name` | `discounts.${number}.discount.coupon.amount.amount` | `discounts.${number}.discount.coupon.amount.formattedAmount` | `discounts.${number}.discount.merchantDiscount.discountReason` | `discounts.${number}.discount.discountRule._id` | `discounts.${number}.discount.discountRule.name.original` | `discounts.${number}.discount.discountType` | `discounts.${number}.source` | `discounts.${number}.applied` | `createdBy.userId` | `createdBy.appId` | `status` | `weightUnit` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `commitSettings.updateInventory` | `commitSettings.updateInventory.${number}.lineItemId` | `recipientInfo.added` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.number` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.name` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId._id` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId.type` | `recipientInfo.removed` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `buyerDetails.added` | `buyerDetails.changedDetails.buyerInfoBeforeChange.visitorId` | `buyerDetails.changedDetails.buyerInfoBeforeChange.memberId` | `buyerDetails.removed` | `billingDetails.added` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.number` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.name` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId._id` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId.type` | `billingDetails.removed` | `businessLocationDetails.added` | `businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `businessLocationDetails.removed`;
|
|
4439
|
+
/**
|
|
4440
|
+
* Creates or retrieves a draft order based on the specified order ID.
|
|
4441
|
+
*
|
|
4442
|
+
* When passing the ID of an order that is already in draft, the existing draft order is returned.
|
|
4443
|
+
* To complete a draft and update the original order, call Commit Draft Order.
|
|
4444
|
+
* @param orderId - ID of the order to create a draft for.
|
|
4445
|
+
* @public
|
|
4446
|
+
* @documentationMaturity preview
|
|
4447
|
+
* @requiredField orderId
|
|
4448
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4449
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4450
|
+
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4451
|
+
* @applicableIdentity APP
|
|
4452
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
|
|
4453
|
+
*/
|
|
4454
|
+
declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<CreateDraftOrderResponse, {
|
|
4455
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4456
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4457
|
+
__applicationErrorsType?: CreateDraftOrderApplicationErrors;
|
|
4458
|
+
}>;
|
|
4459
|
+
/**
|
|
4460
|
+
* Creates an empty draft order.
|
|
4461
|
+
*
|
|
4462
|
+
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
4463
|
+
* @public
|
|
4464
|
+
* @documentationMaturity preview
|
|
4465
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4466
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4467
|
+
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4468
|
+
* @applicableIdentity APP
|
|
4469
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
|
|
4470
|
+
*/
|
|
4471
|
+
declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDraftOrderResponse, {
|
|
4472
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4473
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4474
|
+
__applicationErrorsType?: CreateEmptyDraftOrderApplicationErrors;
|
|
4475
|
+
}>;
|
|
4476
|
+
/**
|
|
4477
|
+
* Adds catalog or custom line items to a draft order.
|
|
4478
|
+
* @param draftOrderId - Draft order ID.
|
|
4479
|
+
* @public
|
|
4480
|
+
* @documentationMaturity preview
|
|
4481
|
+
* @requiredField draftOrderId
|
|
4482
|
+
* @requiredField options.catalogLineItems.catalogReference
|
|
4483
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
4484
|
+
* @applicableIdentity APP
|
|
4485
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
|
|
4486
|
+
*/
|
|
4487
|
+
declare function addLineItemsToDraftOrder(draftOrderId: string, options?: NonNullablePaths<AddLineItemsToDraftOrderOptions, `catalogLineItems.${number}.catalogReference`>): Promise<NonNullablePaths<AddLineItemsToDraftOrderResponse, {
|
|
4488
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4489
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4490
|
+
__applicationErrorsType?: AddLineItemsToDraftOrderApplicationErrors;
|
|
4491
|
+
}>;
|
|
4088
4492
|
interface AddLineItemsToDraftOrderOptions {
|
|
4089
4493
|
/**
|
|
4090
4494
|
* Catalog line items to add to draft order.
|
|
@@ -4099,6 +4503,75 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
4099
4503
|
*/
|
|
4100
4504
|
customLineItems?: CustomLineItem[];
|
|
4101
4505
|
}
|
|
4506
|
+
/**
|
|
4507
|
+
* Updates a draft order's line items.
|
|
4508
|
+
*
|
|
4509
|
+
* You can update a line item's quantity, price, and description.
|
|
4510
|
+
* > **Notes:**
|
|
4511
|
+
* > + Specifying a quantity of `0` will remove the line item.
|
|
4512
|
+
* > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
|
|
4513
|
+
* > + Quantity cannot be decreased for fulfilled line items. To retrieve fulfillment information, specify the order ID when calling List Fulfillments For Single Order ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-fulfillments/list-fulfillments-for-single-order) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order)).
|
|
4514
|
+
* @param draftOrderId - Draft order ID.
|
|
4515
|
+
* @param lineItemChanges - Details of changes to apply per line item.
|
|
4516
|
+
* @public
|
|
4517
|
+
* @documentationMaturity preview
|
|
4518
|
+
* @requiredField draftOrderId
|
|
4519
|
+
* @requiredField lineItemChanges
|
|
4520
|
+
* @requiredField lineItemChanges.lineItemId
|
|
4521
|
+
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
4522
|
+
* @applicableIdentity APP
|
|
4523
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
4524
|
+
*/
|
|
4525
|
+
declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`>[]): Promise<NonNullablePaths<UpdateLineItemsResponse, {
|
|
4526
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4527
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4528
|
+
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
4529
|
+
}>;
|
|
4530
|
+
/**
|
|
4531
|
+
* Applies or unapplies discounts on a draft order.
|
|
4532
|
+
*
|
|
4533
|
+
* Unapplied discounts are still part of the draft order, but do not affect balance.
|
|
4534
|
+
* Existing discounts that are not passed in the request will keep their current state.
|
|
4535
|
+
* @param draftOrderId - Draft order ID.
|
|
4536
|
+
* @param discounts - Discounts to set on the draft order.
|
|
4537
|
+
*
|
|
4538
|
+
* Any existing discounts that are not passed will not change.
|
|
4539
|
+
* @public
|
|
4540
|
+
* @documentationMaturity preview
|
|
4541
|
+
* @requiredField discounts
|
|
4542
|
+
* @requiredField discounts._id
|
|
4543
|
+
* @requiredField discounts.applied
|
|
4544
|
+
* @requiredField draftOrderId
|
|
4545
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
4546
|
+
* @applicableIdentity APP
|
|
4547
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
|
|
4548
|
+
*/
|
|
4549
|
+
declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetDiscountsResponse, {
|
|
4550
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4551
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4552
|
+
__applicationErrorsType?: SetDiscountsApplicationErrors;
|
|
4553
|
+
}>;
|
|
4554
|
+
/**
|
|
4555
|
+
* Creates custom discounts.
|
|
4556
|
+
*
|
|
4557
|
+
* Newly created discounts are unapplied by default.
|
|
4558
|
+
* To apply them, use Set Discounts.
|
|
4559
|
+
* @param draftOrderId - Draft order ID.
|
|
4560
|
+
* @public
|
|
4561
|
+
* @documentationMaturity preview
|
|
4562
|
+
* @requiredField draftOrderId
|
|
4563
|
+
* @requiredField options.discounts.amount.amount
|
|
4564
|
+
* @requiredField options.discounts.discountType
|
|
4565
|
+
* @requiredField options.discounts.priceAmount.amount
|
|
4566
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
4567
|
+
* @applicableIdentity APP
|
|
4568
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
|
|
4569
|
+
*/
|
|
4570
|
+
declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount.amount` | `discounts.${number}.discountType` | `discounts.${number}.priceAmount.amount`>): Promise<NonNullablePaths<CreateCustomDiscountsResponse, {
|
|
4571
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4572
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4573
|
+
__applicationErrorsType?: CreateCustomDiscountsApplicationErrors;
|
|
4574
|
+
}>;
|
|
4102
4575
|
interface CreateCustomDiscountsOptions {
|
|
4103
4576
|
/**
|
|
4104
4577
|
* Custom discounts to create.
|
|
@@ -4109,6 +4582,68 @@ interface CreateCustomDiscountsOptions {
|
|
|
4109
4582
|
*/
|
|
4110
4583
|
discounts?: DiscountOption[];
|
|
4111
4584
|
}
|
|
4585
|
+
/**
|
|
4586
|
+
* Removes custom discounts from a draft order.
|
|
4587
|
+
* @param draftOrderId - Draft order ID.
|
|
4588
|
+
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
4589
|
+
* @public
|
|
4590
|
+
* @documentationMaturity preview
|
|
4591
|
+
* @requiredField discountIds
|
|
4592
|
+
* @requiredField draftOrderId
|
|
4593
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
4594
|
+
* @applicableIdentity APP
|
|
4595
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
|
|
4596
|
+
*/
|
|
4597
|
+
declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<NonNullablePaths<DeleteCustomDiscountsResponse, {
|
|
4598
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4599
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4600
|
+
__applicationErrorsType?: DeleteCustomDiscountsApplicationErrors;
|
|
4601
|
+
}>;
|
|
4602
|
+
/**
|
|
4603
|
+
* Applies or unapplies additional fees on a draft order.
|
|
4604
|
+
*
|
|
4605
|
+
* Additional fees that are not applied are still part of the draft order, but do not affect balance.
|
|
4606
|
+
* Existing additional fees that are not passed in the request will keep their current state.
|
|
4607
|
+
* @param draftOrderId - Draft order ID.
|
|
4608
|
+
* @param additionalFees - Additional fees to set on the draft order.
|
|
4609
|
+
*
|
|
4610
|
+
* Any existing additional fees that are not passed will not change.
|
|
4611
|
+
* @public
|
|
4612
|
+
* @documentationMaturity preview
|
|
4613
|
+
* @requiredField additionalFees
|
|
4614
|
+
* @requiredField additionalFees._id
|
|
4615
|
+
* @requiredField additionalFees.applied
|
|
4616
|
+
* @requiredField draftOrderId
|
|
4617
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
4618
|
+
* @applicableIdentity APP
|
|
4619
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
|
|
4620
|
+
*/
|
|
4621
|
+
declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
|
|
4622
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4623
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4624
|
+
__applicationErrorsType?: SetAdditionalFeesApplicationErrors;
|
|
4625
|
+
}>;
|
|
4626
|
+
/**
|
|
4627
|
+
* Creates custom additional fees on a draft order.
|
|
4628
|
+
*
|
|
4629
|
+
* Newly created additional fees are not applied by default.
|
|
4630
|
+
* To apply them, use Set Additional Fees.
|
|
4631
|
+
* @param draftOrderId - Draft order ID.
|
|
4632
|
+
* @public
|
|
4633
|
+
* @documentationMaturity preview
|
|
4634
|
+
* @requiredField draftOrderId
|
|
4635
|
+
* @requiredField options.customAdditionalFees.name
|
|
4636
|
+
* @requiredField options.customAdditionalFees.price
|
|
4637
|
+
* @requiredField options.customAdditionalFees.price.amount
|
|
4638
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
4639
|
+
* @applicableIdentity APP
|
|
4640
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
|
|
4641
|
+
*/
|
|
4642
|
+
declare function createCustomAdditionalFees(draftOrderId: string, options?: NonNullablePaths<CreateCustomAdditionalFeesOptions, `customAdditionalFees.${number}.name` | `customAdditionalFees.${number}.price` | `customAdditionalFees.${number}.price.amount`>): Promise<NonNullablePaths<CreateCustomAdditionalFeesResponse, {
|
|
4643
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4644
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4645
|
+
__applicationErrorsType?: CreateCustomAdditionalFeesApplicationErrors;
|
|
4646
|
+
}>;
|
|
4112
4647
|
interface CreateCustomAdditionalFeesOptions {
|
|
4113
4648
|
/**
|
|
4114
4649
|
* Custom additional fees to create.
|
|
@@ -4119,6 +4654,38 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
4119
4654
|
*/
|
|
4120
4655
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
4121
4656
|
}
|
|
4657
|
+
/**
|
|
4658
|
+
* Removes custom additional fees from a draft order.
|
|
4659
|
+
* @param draftOrderId - Draft order ID.
|
|
4660
|
+
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
4661
|
+
* @public
|
|
4662
|
+
* @documentationMaturity preview
|
|
4663
|
+
* @requiredField customAdditionalFees
|
|
4664
|
+
* @requiredField draftOrderId
|
|
4665
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4666
|
+
* @applicableIdentity APP
|
|
4667
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
|
|
4668
|
+
*/
|
|
4669
|
+
declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<NonNullablePaths<DeleteCustomAdditionalFeesResponse, {
|
|
4670
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4671
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4672
|
+
__applicationErrorsType?: DeleteCustomAdditionalFeesApplicationErrors;
|
|
4673
|
+
}>;
|
|
4674
|
+
/**
|
|
4675
|
+
* Sets shipping information on a draft order.
|
|
4676
|
+
* @param draftOrderId - Draft order ID.
|
|
4677
|
+
* @public
|
|
4678
|
+
* @documentationMaturity preview
|
|
4679
|
+
* @requiredField draftOrderId
|
|
4680
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4681
|
+
* @applicableIdentity APP
|
|
4682
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
|
|
4683
|
+
*/
|
|
4684
|
+
declare function setShippingInfo(draftOrderId: string, options?: SetShippingInfoOptions): Promise<NonNullablePaths<SetShippingInfoResponse, {
|
|
4685
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4686
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4687
|
+
__applicationErrorsType?: SetShippingInfoApplicationErrors;
|
|
4688
|
+
}>;
|
|
4122
4689
|
interface SetShippingInfoOptions {
|
|
4123
4690
|
/**
|
|
4124
4691
|
* Shipping info to set on the draft order.
|
|
@@ -4127,6 +4694,21 @@ interface SetShippingInfoOptions {
|
|
|
4127
4694
|
*/
|
|
4128
4695
|
shippingInfo?: V1ShippingInformation;
|
|
4129
4696
|
}
|
|
4697
|
+
/**
|
|
4698
|
+
* Sets buyer info on a draft order.
|
|
4699
|
+
* @param draftOrderId - Draft order ID.
|
|
4700
|
+
* @public
|
|
4701
|
+
* @documentationMaturity preview
|
|
4702
|
+
* @requiredField draftOrderId
|
|
4703
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4704
|
+
* @applicableIdentity APP
|
|
4705
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
|
|
4706
|
+
*/
|
|
4707
|
+
declare function setBuyerInfo(draftOrderId: string, options?: SetBuyerInfoOptions): Promise<NonNullablePaths<SetBuyerInfoResponse, {
|
|
4708
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4709
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4710
|
+
__applicationErrorsType?: SetBuyerInfoApplicationErrors;
|
|
4711
|
+
}>;
|
|
4130
4712
|
interface SetBuyerInfoOptions {
|
|
4131
4713
|
/**
|
|
4132
4714
|
* Shipping info to set on the draft order.
|
|
@@ -4135,6 +4717,21 @@ interface SetBuyerInfoOptions {
|
|
|
4135
4717
|
*/
|
|
4136
4718
|
buyerInfo?: BuyerInfo;
|
|
4137
4719
|
}
|
|
4720
|
+
/**
|
|
4721
|
+
* Sets recipient info on a draft order.
|
|
4722
|
+
* @param draftOrderId - Draft order ID.
|
|
4723
|
+
* @public
|
|
4724
|
+
* @documentationMaturity preview
|
|
4725
|
+
* @requiredField draftOrderId
|
|
4726
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4727
|
+
* @applicableIdentity APP
|
|
4728
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
|
|
4729
|
+
*/
|
|
4730
|
+
declare function setRecipientInfo(draftOrderId: string, options?: SetRecipientInfoOptions): Promise<NonNullablePaths<SetRecipientInfoResponse, {
|
|
4731
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4732
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4733
|
+
__applicationErrorsType?: SetRecipientInfoApplicationErrors;
|
|
4734
|
+
}>;
|
|
4138
4735
|
interface SetRecipientInfoOptions {
|
|
4139
4736
|
/**
|
|
4140
4737
|
* Recipient address and contact details.
|
|
@@ -4143,6 +4740,21 @@ interface SetRecipientInfoOptions {
|
|
|
4143
4740
|
*/
|
|
4144
4741
|
recipientInfo?: AddressWithContact;
|
|
4145
4742
|
}
|
|
4743
|
+
/**
|
|
4744
|
+
* Sets billing info on a draft order.
|
|
4745
|
+
* @param draftOrderId - Draft order ID.
|
|
4746
|
+
* @public
|
|
4747
|
+
* @documentationMaturity preview
|
|
4748
|
+
* @requiredField draftOrderId
|
|
4749
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4750
|
+
* @applicableIdentity APP
|
|
4751
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
|
|
4752
|
+
*/
|
|
4753
|
+
declare function setBillingInfo(draftOrderId: string, options?: SetBillingInfoOptions): Promise<NonNullablePaths<SetBillingInfoResponse, {
|
|
4754
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4755
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4756
|
+
__applicationErrorsType?: SetBillingInfoApplicationErrors;
|
|
4757
|
+
}>;
|
|
4146
4758
|
interface SetBillingInfoOptions {
|
|
4147
4759
|
/**
|
|
4148
4760
|
* Billing address and contact details.
|
|
@@ -4151,6 +4763,66 @@ interface SetBillingInfoOptions {
|
|
|
4151
4763
|
*/
|
|
4152
4764
|
billingInfo?: AddressWithContact;
|
|
4153
4765
|
}
|
|
4766
|
+
/**
|
|
4767
|
+
* Retrieves a draft order.
|
|
4768
|
+
*
|
|
4769
|
+
* The retrieved draft order contains the latest calculations:
|
|
4770
|
+
* + Line items, shipping details, and buyer information.
|
|
4771
|
+
* + Tax details and price totals.
|
|
4772
|
+
* + Automatic discounts and automatic additional fees, along with updated eligibility.
|
|
4773
|
+
*
|
|
4774
|
+
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
4775
|
+
* @param draftOrderId - Draft order ID.
|
|
4776
|
+
* @public
|
|
4777
|
+
* @documentationMaturity preview
|
|
4778
|
+
* @requiredField draftOrderId
|
|
4779
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4780
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4781
|
+
* @applicableIdentity APP
|
|
4782
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
|
|
4783
|
+
*/
|
|
4784
|
+
declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<GetDraftOrderResponse, {
|
|
4785
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4786
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
4787
|
+
__applicationErrorsType?: GetDraftOrderApplicationErrors;
|
|
4788
|
+
}>;
|
|
4789
|
+
/**
|
|
4790
|
+
* Checks whether a draft can be created for an order.
|
|
4791
|
+
*
|
|
4792
|
+
* If `orderDraftable` returns as `true`, the order can be used to create a draft order.
|
|
4793
|
+
*
|
|
4794
|
+
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
4795
|
+
* @param orderId - Order ID.
|
|
4796
|
+
* @public
|
|
4797
|
+
* @documentationMaturity preview
|
|
4798
|
+
* @requiredField orderId
|
|
4799
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4800
|
+
* @applicableIdentity APP
|
|
4801
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
|
|
4802
|
+
*/
|
|
4803
|
+
declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullablePaths<GetOrderDraftabilityStatusResponse, `orderId` | `orderDraftable` | `nonDraftableReasons`>>;
|
|
4804
|
+
/**
|
|
4805
|
+
* Finalizes a draft order and applies its modifications to the associated order.
|
|
4806
|
+
* You can also control which side-effects are executed on commit.
|
|
4807
|
+
*
|
|
4808
|
+
* > **Notes:**
|
|
4809
|
+
* > + The draft order's status is set to `COMMITTED`.
|
|
4810
|
+
* > + Commiting a draft order cannot be undone or reverted.
|
|
4811
|
+
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
4812
|
+
* @param draftOrderId - Draft order ID.
|
|
4813
|
+
* @public
|
|
4814
|
+
* @documentationMaturity preview
|
|
4815
|
+
* @requiredField draftOrderId
|
|
4816
|
+
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
4817
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4818
|
+
* @applicableIdentity APP
|
|
4819
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
|
|
4820
|
+
*/
|
|
4821
|
+
declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<NonNullablePaths<CommitDraftOrderResponse, {
|
|
4822
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
4823
|
+
}[DraftOrderNonNullablePaths] | `orderAfterCommit.number` | `orderAfterCommit.lineItems` | `orderAfterCommit.lineItems.${number}._id` | `orderAfterCommit.lineItems.${number}.productName.original` | `orderAfterCommit.lineItems.${number}.catalogReference.catalogItemId` | `orderAfterCommit.lineItems.${number}.catalogReference.appId` | `orderAfterCommit.lineItems.${number}.quantity` | `orderAfterCommit.lineItems.${number}.totalDiscount.amount` | `orderAfterCommit.lineItems.${number}.totalDiscount.formattedAmount` | `orderAfterCommit.lineItems.${number}.physicalProperties.shippable` | `orderAfterCommit.lineItems.${number}.itemType.preset` | `orderAfterCommit.lineItems.${number}.itemType.custom` | `orderAfterCommit.lineItems.${number}.paymentOption` | `orderAfterCommit.lineItems.${number}.taxDetails.taxRate` | `orderAfterCommit.lineItems.${number}.taxInfo.taxIncludedInPrice` | `orderAfterCommit.lineItems.${number}.digitalFile.fileId` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.cycleNumber` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `orderAfterCommit.lineItems.${number}.priceDescription.original` | `orderAfterCommit.lineItems.${number}.taxableAddress.addressType` | `orderAfterCommit.buyerInfo.visitorId` | `orderAfterCommit.buyerInfo.memberId` | `orderAfterCommit.paymentStatus` | `orderAfterCommit.fulfillmentStatus` | `orderAfterCommit.weightUnit` | `orderAfterCommit.taxIncludedInPrices` | `orderAfterCommit.billingInfo.address.streetAddress.number` | `orderAfterCommit.billingInfo.address.streetAddress.name` | `orderAfterCommit.billingInfo.contactDetails.vatId._id` | `orderAfterCommit.billingInfo.contactDetails.vatId.type` | `orderAfterCommit.shippingInfo.title` | `orderAfterCommit.shippingInfo.logistics.pickupDetails.pickupMethod` | `orderAfterCommit.status` | `orderAfterCommit.taxInfo.taxBreakdown` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxName` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdiction` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdictionType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.rate` | `orderAfterCommit.appliedDiscounts` | `orderAfterCommit.appliedDiscounts.${number}.coupon._id` | `orderAfterCommit.appliedDiscounts.${number}.coupon.code` | `orderAfterCommit.appliedDiscounts.${number}.coupon.name` | `orderAfterCommit.appliedDiscounts.${number}.merchantDiscount.discountReason` | `orderAfterCommit.appliedDiscounts.${number}.discountRule._id` | `orderAfterCommit.appliedDiscounts.${number}.discountRule.name.original` | `orderAfterCommit.appliedDiscounts.${number}.discountType` | `orderAfterCommit.activities` | `orderAfterCommit.activities.${number}.customActivity.appId` | `orderAfterCommit.activities.${number}.customActivity.type` | `orderAfterCommit.activities.${number}.merchantComment.message` | `orderAfterCommit.activities.${number}.orderRefunded.manual` | `orderAfterCommit.activities.${number}.orderRefunded.reason` | `orderAfterCommit.activities.${number}.type` | `orderAfterCommit.attributionSource` | `orderAfterCommit.createdBy.userId` | `orderAfterCommit.createdBy.memberId` | `orderAfterCommit.createdBy.visitorId` | `orderAfterCommit.createdBy.appId` | `orderAfterCommit.channelInfo.type` | `orderAfterCommit.customFields` | `orderAfterCommit.customFields.${number}.title` | `orderAfterCommit.balanceSummary.balance.amount` | `orderAfterCommit.balanceSummary.balance.formattedAmount` | `orderAfterCommit.additionalFees` | `orderAfterCommit.additionalFees.${number}.name` | `orderAfterCommit.additionalFees.${number}._id` | `orderAfterCommit.tags.privateTags.tagIds` | `orderAfterCommit.businessLocation._id` | `orderAfterCommit.businessLocation.name`> & {
|
|
4824
|
+
__applicationErrorsType?: CommitDraftOrderApplicationErrors;
|
|
4825
|
+
}>;
|
|
4154
4826
|
interface CommitDraftOrderOptions {
|
|
4155
4827
|
/** Optional side effects to trigger. */
|
|
4156
4828
|
commitSettings?: DraftOrderCommitSettings;
|
|
@@ -4160,6 +4832,27 @@ interface CommitDraftOrderOptions {
|
|
|
4160
4832
|
*/
|
|
4161
4833
|
reason?: string | null;
|
|
4162
4834
|
}
|
|
4835
|
+
/**
|
|
4836
|
+
* Creates a new order from a draft, while specifying which side-effects are executed.
|
|
4837
|
+
*
|
|
4838
|
+
* > **Notes:**
|
|
4839
|
+
* > + The draft order's status is set to `COMMITTED`.
|
|
4840
|
+
* > + Commiting a draft order cannot be undone or reverted.
|
|
4841
|
+
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
4842
|
+
* @param draftOrderId - Draft order ID.
|
|
4843
|
+
* @public
|
|
4844
|
+
* @documentationMaturity preview
|
|
4845
|
+
* @requiredField draftOrderId
|
|
4846
|
+
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
4847
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4848
|
+
* @applicableIdentity APP
|
|
4849
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
|
|
4850
|
+
*/
|
|
4851
|
+
declare function createOrderFromDraft(draftOrderId: string, options?: CreateOrderFromDraftOptions): Promise<NonNullablePaths<CreateOrderFromDraftResponse, {
|
|
4852
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
4853
|
+
}[DraftOrderNonNullablePaths] | `createdOrder.number` | `createdOrder.lineItems` | `createdOrder.lineItems.${number}._id` | `createdOrder.lineItems.${number}.productName.original` | `createdOrder.lineItems.${number}.catalogReference.catalogItemId` | `createdOrder.lineItems.${number}.catalogReference.appId` | `createdOrder.lineItems.${number}.quantity` | `createdOrder.lineItems.${number}.totalDiscount.amount` | `createdOrder.lineItems.${number}.totalDiscount.formattedAmount` | `createdOrder.lineItems.${number}.physicalProperties.shippable` | `createdOrder.lineItems.${number}.itemType.preset` | `createdOrder.lineItems.${number}.itemType.custom` | `createdOrder.lineItems.${number}.paymentOption` | `createdOrder.lineItems.${number}.taxDetails.taxRate` | `createdOrder.lineItems.${number}.taxInfo.taxIncludedInPrice` | `createdOrder.lineItems.${number}.digitalFile.fileId` | `createdOrder.lineItems.${number}.subscriptionInfo.cycleNumber` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `createdOrder.lineItems.${number}.priceDescription.original` | `createdOrder.lineItems.${number}.taxableAddress.addressType` | `createdOrder.buyerInfo.visitorId` | `createdOrder.buyerInfo.memberId` | `createdOrder.paymentStatus` | `createdOrder.fulfillmentStatus` | `createdOrder.weightUnit` | `createdOrder.taxIncludedInPrices` | `createdOrder.billingInfo.address.streetAddress.number` | `createdOrder.billingInfo.address.streetAddress.name` | `createdOrder.billingInfo.contactDetails.vatId._id` | `createdOrder.billingInfo.contactDetails.vatId.type` | `createdOrder.shippingInfo.title` | `createdOrder.shippingInfo.logistics.pickupDetails.pickupMethod` | `createdOrder.status` | `createdOrder.taxInfo.taxBreakdown` | `createdOrder.taxInfo.taxBreakdown.${number}.taxName` | `createdOrder.taxInfo.taxBreakdown.${number}.taxType` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdiction` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdictionType` | `createdOrder.taxInfo.taxBreakdown.${number}.rate` | `createdOrder.appliedDiscounts` | `createdOrder.appliedDiscounts.${number}.coupon._id` | `createdOrder.appliedDiscounts.${number}.coupon.code` | `createdOrder.appliedDiscounts.${number}.coupon.name` | `createdOrder.appliedDiscounts.${number}.merchantDiscount.discountReason` | `createdOrder.appliedDiscounts.${number}.discountRule._id` | `createdOrder.appliedDiscounts.${number}.discountRule.name.original` | `createdOrder.appliedDiscounts.${number}.discountType` | `createdOrder.activities` | `createdOrder.activities.${number}.customActivity.appId` | `createdOrder.activities.${number}.customActivity.type` | `createdOrder.activities.${number}.merchantComment.message` | `createdOrder.activities.${number}.orderRefunded.manual` | `createdOrder.activities.${number}.orderRefunded.reason` | `createdOrder.activities.${number}.type` | `createdOrder.attributionSource` | `createdOrder.createdBy.userId` | `createdOrder.createdBy.memberId` | `createdOrder.createdBy.visitorId` | `createdOrder.createdBy.appId` | `createdOrder.channelInfo.type` | `createdOrder.customFields` | `createdOrder.customFields.${number}.title` | `createdOrder.balanceSummary.balance.amount` | `createdOrder.balanceSummary.balance.formattedAmount` | `createdOrder.additionalFees` | `createdOrder.additionalFees.${number}.name` | `createdOrder.additionalFees.${number}._id` | `createdOrder.tags.privateTags.tagIds` | `createdOrder.businessLocation._id` | `createdOrder.businessLocation.name`> & {
|
|
4854
|
+
__applicationErrorsType?: CreateOrderFromDraftApplicationErrors;
|
|
4855
|
+
}>;
|
|
4163
4856
|
interface CreateOrderFromDraftOptions {
|
|
4164
4857
|
/** Optional side effects to trigger. */
|
|
4165
4858
|
createSettings?: OrderCreateSettings;
|
|
@@ -4171,6 +4864,34 @@ interface CreateOrderFromDraftOptions {
|
|
|
4171
4864
|
/** Information about the sales channel that submitted this order. */
|
|
4172
4865
|
channelInfo?: ChannelInfo;
|
|
4173
4866
|
}
|
|
4867
|
+
/**
|
|
4868
|
+
* Deletes a draft order along with all its pending changes.
|
|
4869
|
+
*
|
|
4870
|
+
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
4871
|
+
* @param draftOrderId - Draft order ID.
|
|
4872
|
+
* @public
|
|
4873
|
+
* @documentationMaturity preview
|
|
4874
|
+
* @requiredField draftOrderId
|
|
4875
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
4876
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4877
|
+
* @applicableIdentity APP
|
|
4878
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
|
|
4879
|
+
*/
|
|
4880
|
+
declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
4881
|
+
__applicationErrorsType?: DeleteDraftOrderApplicationErrors;
|
|
4882
|
+
}>;
|
|
4883
|
+
/**
|
|
4884
|
+
* Retrieves a list of up to 100 draft orders, given the provided paging, filtering, and sorting.
|
|
4885
|
+
*
|
|
4886
|
+
* For field support, see [supported filters and sorting](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/draft-orders/supported-filters-and-sorting).
|
|
4887
|
+
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
4888
|
+
* @public
|
|
4889
|
+
* @documentationMaturity preview
|
|
4890
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4891
|
+
* @applicableIdentity APP
|
|
4892
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
4893
|
+
*/
|
|
4894
|
+
declare function queryDraftOrders(): DraftOrdersQueryBuilder;
|
|
4174
4895
|
interface QueryCursorResult {
|
|
4175
4896
|
cursors: Cursors;
|
|
4176
4897
|
hasNext: () => boolean;
|
|
@@ -4248,10 +4969,49 @@ interface DraftOrdersQueryBuilder {
|
|
|
4248
4969
|
/** @documentationMaturity preview */
|
|
4249
4970
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
4250
4971
|
}
|
|
4972
|
+
/**
|
|
4973
|
+
* Updates extended fields on a draft order.
|
|
4974
|
+
* @param _id - ID of the entity to update.
|
|
4975
|
+
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
4976
|
+
* @public
|
|
4977
|
+
* @documentationMaturity preview
|
|
4978
|
+
* @requiredField _id
|
|
4979
|
+
* @requiredField namespace
|
|
4980
|
+
* @requiredField options
|
|
4981
|
+
* @requiredField options.namespaceData
|
|
4982
|
+
* @permissionId ECOM.DRAFT_ORDER_UPDATE_EXTENDED_FIELDS
|
|
4983
|
+
* @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4984
|
+
* @applicableIdentity APP
|
|
4985
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateExtendedFields
|
|
4986
|
+
*/
|
|
4987
|
+
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
|
|
4988
|
+
[P in DraftOrderNonNullablePaths]: `draftOrder.${P}`;
|
|
4989
|
+
}[DraftOrderNonNullablePaths]> & {
|
|
4990
|
+
__applicationErrorsType?: UpdateExtendedFieldsApplicationErrors;
|
|
4991
|
+
}>;
|
|
4251
4992
|
interface UpdateExtendedFieldsOptions {
|
|
4252
4993
|
/** 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. */
|
|
4253
4994
|
namespaceData: Record<string, any> | null;
|
|
4254
4995
|
}
|
|
4996
|
+
/**
|
|
4997
|
+
* Sets whether a draft order is tax-exempt.
|
|
4998
|
+
*
|
|
4999
|
+
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
5000
|
+
* @param draftOrderId - Draft order ID.
|
|
5001
|
+
* @public
|
|
5002
|
+
* @documentationMaturity preview
|
|
5003
|
+
* @requiredField draftOrderId
|
|
5004
|
+
* @requiredField options
|
|
5005
|
+
* @requiredField options.taxExempt
|
|
5006
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
5007
|
+
* @applicableIdentity APP
|
|
5008
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
|
|
5009
|
+
*/
|
|
5010
|
+
declare function setTaxExemption(draftOrderId: string, options: NonNullablePaths<SetTaxExemptionOptions, `taxExempt`>): Promise<NonNullablePaths<SetTaxExemptionResponse, {
|
|
5011
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
5012
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
5013
|
+
__applicationErrorsType?: SetTaxExemptionApplicationErrors;
|
|
5014
|
+
}>;
|
|
4255
5015
|
interface SetTaxExemptionOptions {
|
|
4256
5016
|
/**
|
|
4257
5017
|
* Whether the draft order is exempt from tax calculations.
|
|
@@ -4260,9 +5020,27 @@ interface SetTaxExemptionOptions {
|
|
|
4260
5020
|
*/
|
|
4261
5021
|
taxExempt: boolean | null;
|
|
4262
5022
|
}
|
|
5023
|
+
/**
|
|
5024
|
+
* Sets business location on a draft order.
|
|
5025
|
+
*
|
|
5026
|
+
* When committed, the order will become associated to a specific business location. This affects who can see and manage this order, and how it is calculated in reports.
|
|
5027
|
+
* @param draftOrderId - Draft order ID.
|
|
5028
|
+
* @public
|
|
5029
|
+
* @documentationMaturity preview
|
|
5030
|
+
* @requiredField draftOrderId
|
|
5031
|
+
* @requiredField options.businessLocation._id
|
|
5032
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
5033
|
+
* @applicableIdentity APP
|
|
5034
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
|
|
5035
|
+
*/
|
|
5036
|
+
declare function setBusinessLocation(draftOrderId: string, options?: NonNullablePaths<SetBusinessLocationOptions, `businessLocation._id`>): Promise<NonNullablePaths<SetBusinessLocationResponse, {
|
|
5037
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
5038
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`> & {
|
|
5039
|
+
__applicationErrorsType?: SetBusinessLocationApplicationErrors;
|
|
5040
|
+
}>;
|
|
4263
5041
|
interface SetBusinessLocationOptions {
|
|
4264
5042
|
/** Business location. */
|
|
4265
5043
|
businessLocation?: Location;
|
|
4266
5044
|
}
|
|
4267
5045
|
|
|
4268
|
-
export {
|
|
5046
|
+
export { type ActionEvent, type Activity, type ActivityContentOneOf, ActivityType, type ActivityTypeWithLiterals, type AddLineItemsToDraftOrderApplicationErrors, type AddLineItemsToDraftOrderOptions, type AddLineItemsToDraftOrderRequest, type AddLineItemsToDraftOrderResponse, type AdditionalFee, type AdditionalFeeDetails, type AdditionalFeeOption, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, AttributionSource, type AttributionSourceWithLiterals, type AuthorizedPaymentCaptured, type AuthorizedPaymentCreated, type AuthorizedPaymentVoided, type Balance, type BalanceSummary, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingChangedDetails, type BillingDetails, type BillingDetailsChangeTypeOneOf, type BusinessLocationChangedDetails, type BusinessLocationDetails, type BusinessLocationDetailsChangeTypeOneOf, type BuyerChangedDetails, type BuyerDetails, type BuyerDetailsChangeTypeOneOf, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedDraftOrder, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type CatalogReference, type CatalogReferenceLineItem, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, type ChargebackCreated, type ChargebackReversed, type Color, type CommitDraftOrderApplicationErrors, type CommitDraftOrderOptions, type CommitDraftOrderRequest, type CommitDraftOrderResponse, type Coupon, type CreateCustomAdditionalFeesApplicationErrors, type CreateCustomAdditionalFeesOptions, type CreateCustomAdditionalFeesRequest, type CreateCustomAdditionalFeesResponse, type CreateCustomDiscountsApplicationErrors, type CreateCustomDiscountsOptions, type CreateCustomDiscountsRequest, type CreateCustomDiscountsResponse, type CreateDraftOrderApplicationErrors, type CreateDraftOrderRequest, type CreateDraftOrderResponse, type CreateEmptyDraftOrderApplicationErrors, type CreateEmptyDraftOrderRequest, type CreateEmptyDraftOrderResponse, type CreateOrderFromDraftApplicationErrors, type CreateOrderFromDraftOptions, type CreateOrderFromDraftRequest, type CreateOrderFromDraftResponse, type CreatedBy, type CreatedByStringOneOf, type CreditCardDetails, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomActivity, type CustomField, type CustomLineItem, type DeleteCustomAdditionalFeesApplicationErrors, type DeleteCustomAdditionalFeesRequest, type DeleteCustomAdditionalFeesResponse, type DeleteCustomDiscountsApplicationErrors, type DeleteCustomDiscountsRequest, type DeleteCustomDiscountsResponse, type DeleteDraftOrderApplicationErrors, type DeleteDraftOrderRequest, type DeleteDraftOrderResponse, type DeliveryLogistics, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DigitalFile, type DiscountDetails, type DiscountOption, type DiscountOptionDiscountAmountOneOf, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type DraftOrder, type DraftOrderChangesApplied, type DraftOrderCommitSettings, type DraftOrderCreatedEnvelope, type DraftOrderDeletedEnvelope, type DraftOrderUpdatedEnvelope, type DraftOrdersQueryBuilder, type DraftOrdersQueryResult, EditingStatus, type EditingStatusWithLiterals, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReceipt, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, FulfillmentStatus, type FulfillmentStatusWithLiterals, type FulfillmentStatusesAggregate, type FullAddressContactDetails, type GetDraftOrderApplicationErrors, type GetDraftOrderRequest, type GetDraftOrderResponse, type GetOrderDraftabilityStatusRequest, type GetOrderDraftabilityStatusResponse, type GiftCardPaymentRefund, type IdAndApplied, type IdentificationData, type IdentificationDataIdOneOf, type InventoryUpdate, type ItemChangedDetails, type ItemDetails, type ItemDetailsChangeTypeOneOf, type ItemModifier, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemAmount, type LineItemChangeDetails, type LineItemChanges, type LineItemDiscount, type LineItemExchangeData, type LineItemPriceChange, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MembershipPaymentRefund, type MerchantComment, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type NewExchangeOrderCreated, NonDraftableReason, type NonDraftableReasonWithLiterals, type Order, type OrderChange, type OrderChangeValueOneOf, type OrderCreateNotifications, type OrderCreateSettings, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, OrderStatus, type OrderStatusWithLiterals, type OrderTaxBreakdown, type OrderTaxInfo, type PaymentCanceled, type PaymentCanceledPaymentDetailsOneOf, type PaymentDeclined, type PaymentDeclinedPaymentDetailsOneOf, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentPending, type PaymentPendingPaymentDetailsOneOf, type PaymentRefundFailed, type PaymentRefunded, PaymentStatus, type PaymentStatusWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupDetailsPickupMethod, type PickupDetailsPickupMethodWithLiterals, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type Price, type PriceDescription, type PriceSummary, type ProductName, type QueryDraftOrdersRequest, type QueryDraftOrdersResponse, type ReceiptCreated, type ReceiptCreatedReceiptInfoOneOf, type ReceiptSent, type ReceiptSentReceiptInfoOneOf, type RecipientInfoChangedDetails, type RecipientInfoDetails, type RecipientInfoDetailsChangeTypeOneOf, type RefundInitiated, type RefundedAsStoreCredit, type RefundedPayment, type RefundedPaymentKindOneOf, type RegularPayment, type RegularPaymentPaymentMethodDetailsOneOf, type RegularPaymentRefund, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type SavedPaymentMethod, type SecuredMedia, type SetAdditionalFeesApplicationErrors, type SetAdditionalFeesRequest, type SetAdditionalFeesResponse, type SetBillingInfoApplicationErrors, type SetBillingInfoOptions, type SetBillingInfoRequest, type SetBillingInfoResponse, type SetBusinessLocationApplicationErrors, type SetBusinessLocationOptions, type SetBusinessLocationRequest, type SetBusinessLocationResponse, type SetBuyerInfoApplicationErrors, type SetBuyerInfoOptions, type SetBuyerInfoRequest, type SetBuyerInfoResponse, type SetDiscountsApplicationErrors, type SetDiscountsRequest, type SetDiscountsResponse, type SetRecipientInfoApplicationErrors, type SetRecipientInfoOptions, type SetRecipientInfoRequest, type SetRecipientInfoResponse, type SetShippingInfoApplicationErrors, type SetShippingInfoOptions, type SetShippingInfoRequest, type SetShippingInfoResponse, type SetTaxExemptionApplicationErrors, type SetTaxExemptionOptions, type SetTaxExemptionRequest, type SetTaxExemptionResponse, type ShippingChangedDetails, type ShippingDetails, type ShippingDetailsChangeTypeOneOf, type ShippingInformation, type ShippingInformationChange, type ShippingOption, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SourceType, type SourceTypeWithLiterals, type StreetAddress, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, type SubscriptionTitle, type SystemError, type TagList, type Tags, type TaxDetails, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateExtendedFieldsApplicationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateLineItemsApplicationErrors, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type UpdateShippingInfoRequest, type UpdateShippingInfoResponse, type V1BalanceSummary, type V1CreatedBy, type V1CreatedByStringOneOf, type V1DeliveryLogistics, type V1DeliveryLogisticsAddressOneOf, type V1DeliveryTimeSlot, type V1PickupDetails, type V1ShippingInformation, type V1ShippingPrice, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, type WixReceipt, addLineItemsToDraftOrder, commitDraftOrder, createCustomAdditionalFees, createCustomDiscounts, createDraftOrder, createEmptyDraftOrder, createOrderFromDraft, deleteCustomAdditionalFees, deleteCustomDiscounts, deleteDraftOrder, getDraftOrder, getOrderDraftabilityStatus, onDraftOrderCreated, onDraftOrderDeleted, onDraftOrderUpdated, queryDraftOrders, setAdditionalFees, setBillingInfo, setBusinessLocation, setBuyerInfo, setDiscounts, setRecipientInfo, setShippingInfo, setTaxExemption, updateExtendedFields, updateLineItems };
|