@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
package/build/es/{ecom-v1-draft-order-draft-orders.universal-BVXrKSFI.d.mts → index.typings.d.mts}
RENAMED
|
@@ -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.
|
|
@@ -433,6 +435,8 @@ declare enum DescriptionLineType {
|
|
|
433
435
|
/** Color type. */
|
|
434
436
|
COLOR = "COLOR"
|
|
435
437
|
}
|
|
438
|
+
/** @enumType */
|
|
439
|
+
type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
436
440
|
interface FocalPoint {
|
|
437
441
|
/** X-coordinate of the focal point. */
|
|
438
442
|
x?: number;
|
|
@@ -3308,6 +3312,40 @@ interface ReceiptSentReceiptInfoOneOf {
|
|
|
3308
3312
|
/** Receipt created by an external system. */
|
|
3309
3313
|
externalReceipt?: ExternalReceipt;
|
|
3310
3314
|
}
|
|
3315
|
+
interface ChargebackCreated {
|
|
3316
|
+
/**
|
|
3317
|
+
* ID of the payment that received a chargeback.
|
|
3318
|
+
* @format GUID
|
|
3319
|
+
*/
|
|
3320
|
+
paymentId?: string;
|
|
3321
|
+
/**
|
|
3322
|
+
* Chargeback ID.
|
|
3323
|
+
* @format GUID
|
|
3324
|
+
*/
|
|
3325
|
+
chargebackId?: string;
|
|
3326
|
+
/** Chargeback amount. */
|
|
3327
|
+
amount?: Price;
|
|
3328
|
+
/** Payment details. */
|
|
3329
|
+
paymentDetails?: RegularPayment;
|
|
3330
|
+
}
|
|
3331
|
+
interface ChargebackReversed {
|
|
3332
|
+
/**
|
|
3333
|
+
* ID of the payment involved with the chargeback.
|
|
3334
|
+
* @format GUID
|
|
3335
|
+
*/
|
|
3336
|
+
paymentId?: string;
|
|
3337
|
+
/**
|
|
3338
|
+
* Chargeback ID.
|
|
3339
|
+
* @format GUID
|
|
3340
|
+
*/
|
|
3341
|
+
chargebackId?: string;
|
|
3342
|
+
/** Chargeback amount. */
|
|
3343
|
+
amount?: Price;
|
|
3344
|
+
/** Chargeback reversal amount. */
|
|
3345
|
+
reversalAmount?: Price;
|
|
3346
|
+
/** Payment details. */
|
|
3347
|
+
paymentDetails?: RegularPayment;
|
|
3348
|
+
}
|
|
3311
3349
|
declare enum ActivityType {
|
|
3312
3350
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3313
3351
|
ORDER_PLACED = "ORDER_PLACED",
|
|
@@ -3855,6 +3893,235 @@ declare enum WebhookIdentityType {
|
|
|
3855
3893
|
}
|
|
3856
3894
|
/** @enumType */
|
|
3857
3895
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3896
|
+
type CreateDraftOrderApplicationErrors = {
|
|
3897
|
+
code?: 'ORDER_CANNOT_BE_EDITED';
|
|
3898
|
+
description?: string;
|
|
3899
|
+
data?: Record<string, any>;
|
|
3900
|
+
} | {
|
|
3901
|
+
code?: 'ORDER_IS_ALREADY_EDITED';
|
|
3902
|
+
description?: string;
|
|
3903
|
+
data?: Record<string, any>;
|
|
3904
|
+
} | {
|
|
3905
|
+
code?: 'FAILED_TO_FETCH_SETTINGS';
|
|
3906
|
+
description?: string;
|
|
3907
|
+
data?: Record<string, any>;
|
|
3908
|
+
} | {
|
|
3909
|
+
code?: 'NOT_AUTHORIZED_TO_READ_DRAFT_ORDERS';
|
|
3910
|
+
description?: string;
|
|
3911
|
+
data?: Record<string, any>;
|
|
3912
|
+
};
|
|
3913
|
+
type CreateEmptyDraftOrderApplicationErrors = {
|
|
3914
|
+
code?: 'FAILED_TO_FETCH_SETTINGS';
|
|
3915
|
+
description?: string;
|
|
3916
|
+
data?: Record<string, any>;
|
|
3917
|
+
};
|
|
3918
|
+
type AddLineItemsToDraftOrderApplicationErrors = {
|
|
3919
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
3920
|
+
description?: string;
|
|
3921
|
+
data?: Record<string, any>;
|
|
3922
|
+
} | {
|
|
3923
|
+
code?: 'MAX_ITEMS_REACHED';
|
|
3924
|
+
description?: string;
|
|
3925
|
+
data?: Record<string, any>;
|
|
3926
|
+
} | {
|
|
3927
|
+
code?: 'MULTIPLE_ADDS_FOR_SAME_LINE_ITEM';
|
|
3928
|
+
description?: string;
|
|
3929
|
+
data?: Record<string, any>;
|
|
3930
|
+
} | {
|
|
3931
|
+
code?: 'CATALOG_ITEM_NOT_AVAILABLE';
|
|
3932
|
+
description?: string;
|
|
3933
|
+
data?: Record<string, any>;
|
|
3934
|
+
} | {
|
|
3935
|
+
code?: 'CATALOG_ITEM_NOT_FOUND';
|
|
3936
|
+
description?: string;
|
|
3937
|
+
data?: Record<string, any>;
|
|
3938
|
+
} | {
|
|
3939
|
+
code?: 'CATALOG_ITEM_PAYMENT_OPTION_UNSUPPORTED';
|
|
3940
|
+
description?: string;
|
|
3941
|
+
data?: Record<string, any>;
|
|
3942
|
+
} | {
|
|
3943
|
+
code?: 'CATALOG_ITEM_ALREADY_EXIST';
|
|
3944
|
+
description?: string;
|
|
3945
|
+
data?: Record<string, any>;
|
|
3946
|
+
} | {
|
|
3947
|
+
code?: 'GIFT_CARD_ITEM_UNSUPPORTED';
|
|
3948
|
+
description?: string;
|
|
3949
|
+
data?: Record<string, any>;
|
|
3950
|
+
} | {
|
|
3951
|
+
code?: 'SUBSCRIPTION_ITEM_UNSUPPORTED';
|
|
3952
|
+
description?: string;
|
|
3953
|
+
data?: Record<string, any>;
|
|
3954
|
+
};
|
|
3955
|
+
type UpdateLineItemsApplicationErrors = {
|
|
3956
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
3957
|
+
description?: string;
|
|
3958
|
+
data?: Record<string, any>;
|
|
3959
|
+
} | {
|
|
3960
|
+
code?: 'LINE_ITEM_DOES_NOT_EXIST';
|
|
3961
|
+
description?: string;
|
|
3962
|
+
data?: Record<string, any>;
|
|
3963
|
+
} | {
|
|
3964
|
+
code?: 'MULTIPLE_CHANGES_FOR_SAME_LINE_ITEM';
|
|
3965
|
+
description?: string;
|
|
3966
|
+
data?: Record<string, any>;
|
|
3967
|
+
} | {
|
|
3968
|
+
code?: 'EMPTY_CHANGE_REQUEST';
|
|
3969
|
+
description?: string;
|
|
3970
|
+
data?: Record<string, any>;
|
|
3971
|
+
} | {
|
|
3972
|
+
code?: 'UPDATING_PRICE_OF_REMOVED_ITEM_IS_FORBIDDEN';
|
|
3973
|
+
description?: string;
|
|
3974
|
+
data?: Record<string, any>;
|
|
3975
|
+
} | {
|
|
3976
|
+
code?: 'UPDATING_LINE_ITEM_WITH_LOCATIONS';
|
|
3977
|
+
description?: string;
|
|
3978
|
+
data?: Record<string, any>;
|
|
3979
|
+
};
|
|
3980
|
+
type SetDiscountsApplicationErrors = {
|
|
3981
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
3982
|
+
description?: string;
|
|
3983
|
+
data?: Record<string, any>;
|
|
3984
|
+
} | {
|
|
3985
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
|
|
3986
|
+
description?: string;
|
|
3987
|
+
data?: Record<string, any>;
|
|
3988
|
+
} | {
|
|
3989
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
|
|
3990
|
+
description?: string;
|
|
3991
|
+
data?: Record<string, any>;
|
|
3992
|
+
};
|
|
3993
|
+
type CreateCustomDiscountsApplicationErrors = {
|
|
3994
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
3995
|
+
description?: string;
|
|
3996
|
+
data?: Record<string, any>;
|
|
3997
|
+
} | {
|
|
3998
|
+
code?: 'DISCOUNT_NOT_FOUND';
|
|
3999
|
+
description?: string;
|
|
4000
|
+
data?: Record<string, any>;
|
|
4001
|
+
} | {
|
|
4002
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ORDER_TOTALS';
|
|
4003
|
+
description?: string;
|
|
4004
|
+
data?: Record<string, any>;
|
|
4005
|
+
} | {
|
|
4006
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_ITEM_TOTALS';
|
|
4007
|
+
description?: string;
|
|
4008
|
+
data?: Record<string, any>;
|
|
4009
|
+
} | {
|
|
4010
|
+
code?: 'DISCOUNTS_AMOUNT_EXCEED_SHIPPING_TOTAL';
|
|
4011
|
+
description?: string;
|
|
4012
|
+
data?: Record<string, any>;
|
|
4013
|
+
};
|
|
4014
|
+
type DeleteCustomDiscountsApplicationErrors = {
|
|
4015
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4016
|
+
description?: string;
|
|
4017
|
+
data?: Record<string, any>;
|
|
4018
|
+
} | {
|
|
4019
|
+
code?: 'DISCOUNT_NOT_FOUND';
|
|
4020
|
+
description?: string;
|
|
4021
|
+
data?: Record<string, any>;
|
|
4022
|
+
} | {
|
|
4023
|
+
code?: 'DISCOUNT_REMOVE_NOT_SUPPORTED';
|
|
4024
|
+
description?: string;
|
|
4025
|
+
data?: Record<string, any>;
|
|
4026
|
+
};
|
|
4027
|
+
type SetAdditionalFeesApplicationErrors = {
|
|
4028
|
+
code?: 'ADDITIONAL_FEE_NOT_FOUND';
|
|
4029
|
+
description?: string;
|
|
4030
|
+
data?: Record<string, any>;
|
|
4031
|
+
};
|
|
4032
|
+
type CreateCustomAdditionalFeesApplicationErrors = {
|
|
4033
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4034
|
+
description?: string;
|
|
4035
|
+
data?: Record<string, any>;
|
|
4036
|
+
} | {
|
|
4037
|
+
code?: 'LINE_ITEM_NOT_FOUND';
|
|
4038
|
+
description?: string;
|
|
4039
|
+
data?: Record<string, any>;
|
|
4040
|
+
};
|
|
4041
|
+
type DeleteCustomAdditionalFeesApplicationErrors = {
|
|
4042
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4043
|
+
description?: string;
|
|
4044
|
+
data?: Record<string, any>;
|
|
4045
|
+
} | {
|
|
4046
|
+
code?: 'ADDITIONAL_FEE_NOT_FOUND';
|
|
4047
|
+
description?: string;
|
|
4048
|
+
data?: Record<string, any>;
|
|
4049
|
+
} | {
|
|
4050
|
+
code?: 'ADDITIONAL_FEE_REMOVE_NOT_SUPPORTED';
|
|
4051
|
+
description?: string;
|
|
4052
|
+
data?: Record<string, any>;
|
|
4053
|
+
};
|
|
4054
|
+
type SetShippingInfoApplicationErrors = {
|
|
4055
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4056
|
+
description?: string;
|
|
4057
|
+
data?: Record<string, any>;
|
|
4058
|
+
};
|
|
4059
|
+
type SetBuyerInfoApplicationErrors = {
|
|
4060
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4061
|
+
description?: string;
|
|
4062
|
+
data?: Record<string, any>;
|
|
4063
|
+
};
|
|
4064
|
+
type SetRecipientInfoApplicationErrors = {
|
|
4065
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4066
|
+
description?: string;
|
|
4067
|
+
data?: Record<string, any>;
|
|
4068
|
+
};
|
|
4069
|
+
type SetBillingInfoApplicationErrors = {
|
|
4070
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4071
|
+
description?: string;
|
|
4072
|
+
data?: Record<string, any>;
|
|
4073
|
+
};
|
|
4074
|
+
type GetDraftOrderApplicationErrors = {
|
|
4075
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4076
|
+
description?: string;
|
|
4077
|
+
data?: Record<string, any>;
|
|
4078
|
+
};
|
|
4079
|
+
type CommitDraftOrderApplicationErrors = {
|
|
4080
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4081
|
+
description?: string;
|
|
4082
|
+
data?: Record<string, any>;
|
|
4083
|
+
} | {
|
|
4084
|
+
code?: 'DRAFT_ORDER_COMMIT_FAILED_VALIDATIONS';
|
|
4085
|
+
description?: string;
|
|
4086
|
+
data?: Record<string, any>;
|
|
4087
|
+
};
|
|
4088
|
+
type CreateOrderFromDraftApplicationErrors = {
|
|
4089
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4090
|
+
description?: string;
|
|
4091
|
+
data?: Record<string, any>;
|
|
4092
|
+
} | {
|
|
4093
|
+
code?: 'CREATE_ORDER_FAILED_VALIDATIONS';
|
|
4094
|
+
description?: string;
|
|
4095
|
+
data?: Record<string, any>;
|
|
4096
|
+
};
|
|
4097
|
+
type DeleteDraftOrderApplicationErrors = {
|
|
4098
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4099
|
+
description?: string;
|
|
4100
|
+
data?: Record<string, any>;
|
|
4101
|
+
} | {
|
|
4102
|
+
code?: 'DRAFT_ORDER_CANNOT_BE_DELETED';
|
|
4103
|
+
description?: string;
|
|
4104
|
+
data?: Record<string, any>;
|
|
4105
|
+
};
|
|
4106
|
+
type UpdateExtendedFieldsApplicationErrors = {
|
|
4107
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4108
|
+
description?: string;
|
|
4109
|
+
data?: Record<string, any>;
|
|
4110
|
+
};
|
|
4111
|
+
type SetTaxExemptionApplicationErrors = {
|
|
4112
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4113
|
+
description?: string;
|
|
4114
|
+
data?: Record<string, any>;
|
|
4115
|
+
};
|
|
4116
|
+
type SetBusinessLocationApplicationErrors = {
|
|
4117
|
+
code?: 'DRAFT_ORDER_DOES_NOT_EXIST';
|
|
4118
|
+
description?: string;
|
|
4119
|
+
data?: Record<string, any>;
|
|
4120
|
+
} | {
|
|
4121
|
+
code?: 'BUSINESS_LOCATION_CANNOT_BE_EDITED';
|
|
4122
|
+
description?: string;
|
|
4123
|
+
data?: Record<string, any>;
|
|
4124
|
+
};
|
|
3858
4125
|
interface BaseEventMetadata {
|
|
3859
4126
|
/**
|
|
3860
4127
|
* App instance ID.
|
|
@@ -3903,13 +4170,118 @@ interface DraftOrderCreatedEnvelope {
|
|
|
3903
4170
|
entity: DraftOrder;
|
|
3904
4171
|
metadata: EventMetadata;
|
|
3905
4172
|
}
|
|
4173
|
+
/**
|
|
4174
|
+
* Triggered when a draft order is created.
|
|
4175
|
+
* @permissionScope Manage Stores - all permissions
|
|
4176
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4177
|
+
* @permissionScope Manage Stores
|
|
4178
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4179
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4180
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4181
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4182
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4183
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4184
|
+
* @webhook
|
|
4185
|
+
* @eventType wix.ecom.v1.draft_order_created
|
|
4186
|
+
* @slug created
|
|
4187
|
+
* @documentationMaturity preview
|
|
4188
|
+
*/
|
|
4189
|
+
declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
3906
4190
|
interface DraftOrderDeletedEnvelope {
|
|
3907
4191
|
metadata: EventMetadata;
|
|
3908
4192
|
}
|
|
4193
|
+
/**
|
|
4194
|
+
* Triggered when a draft order is deleted.
|
|
4195
|
+
* @permissionScope Manage Stores - all permissions
|
|
4196
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4197
|
+
* @permissionScope Manage Stores
|
|
4198
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4199
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4200
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4201
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4202
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4203
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4204
|
+
* @webhook
|
|
4205
|
+
* @eventType wix.ecom.v1.draft_order_deleted
|
|
4206
|
+
* @slug deleted
|
|
4207
|
+
* @documentationMaturity preview
|
|
4208
|
+
*/
|
|
4209
|
+
declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
3909
4210
|
interface DraftOrderUpdatedEnvelope {
|
|
3910
4211
|
entity: DraftOrder;
|
|
3911
4212
|
metadata: EventMetadata;
|
|
3912
4213
|
}
|
|
4214
|
+
/**
|
|
4215
|
+
* Triggered when a draft order is updated.
|
|
4216
|
+
* @permissionScope Manage Stores - all permissions
|
|
4217
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4218
|
+
* @permissionScope Manage Stores
|
|
4219
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4220
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4221
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4222
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4223
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4224
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4225
|
+
* @webhook
|
|
4226
|
+
* @eventType wix.ecom.v1.draft_order_updated
|
|
4227
|
+
* @slug updated
|
|
4228
|
+
* @documentationMaturity preview
|
|
4229
|
+
*/
|
|
4230
|
+
declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4231
|
+
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`;
|
|
4232
|
+
/**
|
|
4233
|
+
* Creates or retrieves a draft order based on the specified order ID.
|
|
4234
|
+
*
|
|
4235
|
+
* When passing the ID of an order that is already in draft, the existing draft order is returned.
|
|
4236
|
+
* To complete a draft and update the original order, call Commit Draft Order.
|
|
4237
|
+
* @param orderId - ID of the order to create a draft for.
|
|
4238
|
+
* @public
|
|
4239
|
+
* @documentationMaturity preview
|
|
4240
|
+
* @requiredField orderId
|
|
4241
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4242
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4243
|
+
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4244
|
+
* @applicableIdentity APP
|
|
4245
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
|
|
4246
|
+
*/
|
|
4247
|
+
declare function createDraftOrder(orderId: string): Promise<NonNullablePaths<CreateDraftOrderResponse, {
|
|
4248
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4249
|
+
}[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`> & {
|
|
4250
|
+
__applicationErrorsType?: CreateDraftOrderApplicationErrors;
|
|
4251
|
+
}>;
|
|
4252
|
+
/**
|
|
4253
|
+
* Creates an empty draft order.
|
|
4254
|
+
*
|
|
4255
|
+
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
4256
|
+
* @public
|
|
4257
|
+
* @documentationMaturity preview
|
|
4258
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
4259
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4260
|
+
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4261
|
+
* @applicableIdentity APP
|
|
4262
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
|
|
4263
|
+
*/
|
|
4264
|
+
declare function createEmptyDraftOrder(): Promise<NonNullablePaths<CreateEmptyDraftOrderResponse, {
|
|
4265
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4266
|
+
}[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`> & {
|
|
4267
|
+
__applicationErrorsType?: CreateEmptyDraftOrderApplicationErrors;
|
|
4268
|
+
}>;
|
|
4269
|
+
/**
|
|
4270
|
+
* Adds catalog or custom line items to a draft order.
|
|
4271
|
+
* @param draftOrderId - Draft order ID.
|
|
4272
|
+
* @public
|
|
4273
|
+
* @documentationMaturity preview
|
|
4274
|
+
* @requiredField draftOrderId
|
|
4275
|
+
* @requiredField options.catalogLineItems.catalogReference
|
|
4276
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
4277
|
+
* @applicableIdentity APP
|
|
4278
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
|
|
4279
|
+
*/
|
|
4280
|
+
declare function addLineItemsToDraftOrder(draftOrderId: string, options?: NonNullablePaths<AddLineItemsToDraftOrderOptions, `catalogLineItems.${number}.catalogReference`>): Promise<NonNullablePaths<AddLineItemsToDraftOrderResponse, {
|
|
4281
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4282
|
+
}[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`> & {
|
|
4283
|
+
__applicationErrorsType?: AddLineItemsToDraftOrderApplicationErrors;
|
|
4284
|
+
}>;
|
|
3913
4285
|
interface AddLineItemsToDraftOrderOptions {
|
|
3914
4286
|
/**
|
|
3915
4287
|
* Catalog line items to add to draft order.
|
|
@@ -3924,6 +4296,75 @@ interface AddLineItemsToDraftOrderOptions {
|
|
|
3924
4296
|
*/
|
|
3925
4297
|
customLineItems?: CustomLineItem[];
|
|
3926
4298
|
}
|
|
4299
|
+
/**
|
|
4300
|
+
* Updates a draft order's line items.
|
|
4301
|
+
*
|
|
4302
|
+
* You can update a line item's quantity, price, and description.
|
|
4303
|
+
* > **Notes:**
|
|
4304
|
+
* > + Specifying a quantity of `0` will remove the line item.
|
|
4305
|
+
* > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
|
|
4306
|
+
* > + 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)).
|
|
4307
|
+
* @param draftOrderId - Draft order ID.
|
|
4308
|
+
* @param lineItemChanges - Details of changes to apply per line item.
|
|
4309
|
+
* @public
|
|
4310
|
+
* @documentationMaturity preview
|
|
4311
|
+
* @requiredField draftOrderId
|
|
4312
|
+
* @requiredField lineItemChanges
|
|
4313
|
+
* @requiredField lineItemChanges.lineItemId
|
|
4314
|
+
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
4315
|
+
* @applicableIdentity APP
|
|
4316
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
4317
|
+
*/
|
|
4318
|
+
declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`>[]): Promise<NonNullablePaths<UpdateLineItemsResponse, {
|
|
4319
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4320
|
+
}[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`> & {
|
|
4321
|
+
__applicationErrorsType?: UpdateLineItemsApplicationErrors;
|
|
4322
|
+
}>;
|
|
4323
|
+
/**
|
|
4324
|
+
* Applies or unapplies discounts on a draft order.
|
|
4325
|
+
*
|
|
4326
|
+
* Unapplied discounts are still part of the draft order, but do not affect balance.
|
|
4327
|
+
* Existing discounts that are not passed in the request will keep their current state.
|
|
4328
|
+
* @param draftOrderId - Draft order ID.
|
|
4329
|
+
* @param discounts - Discounts to set on the draft order.
|
|
4330
|
+
*
|
|
4331
|
+
* Any existing discounts that are not passed will not change.
|
|
4332
|
+
* @public
|
|
4333
|
+
* @documentationMaturity preview
|
|
4334
|
+
* @requiredField discounts
|
|
4335
|
+
* @requiredField discounts._id
|
|
4336
|
+
* @requiredField discounts.applied
|
|
4337
|
+
* @requiredField draftOrderId
|
|
4338
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
4339
|
+
* @applicableIdentity APP
|
|
4340
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
|
|
4341
|
+
*/
|
|
4342
|
+
declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetDiscountsResponse, {
|
|
4343
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4344
|
+
}[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`> & {
|
|
4345
|
+
__applicationErrorsType?: SetDiscountsApplicationErrors;
|
|
4346
|
+
}>;
|
|
4347
|
+
/**
|
|
4348
|
+
* Creates custom discounts.
|
|
4349
|
+
*
|
|
4350
|
+
* Newly created discounts are unapplied by default.
|
|
4351
|
+
* To apply them, use Set Discounts.
|
|
4352
|
+
* @param draftOrderId - Draft order ID.
|
|
4353
|
+
* @public
|
|
4354
|
+
* @documentationMaturity preview
|
|
4355
|
+
* @requiredField draftOrderId
|
|
4356
|
+
* @requiredField options.discounts.amount.amount
|
|
4357
|
+
* @requiredField options.discounts.discountType
|
|
4358
|
+
* @requiredField options.discounts.priceAmount.amount
|
|
4359
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
4360
|
+
* @applicableIdentity APP
|
|
4361
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
|
|
4362
|
+
*/
|
|
4363
|
+
declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount.amount` | `discounts.${number}.discountType` | `discounts.${number}.priceAmount.amount`>): Promise<NonNullablePaths<CreateCustomDiscountsResponse, {
|
|
4364
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4365
|
+
}[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`> & {
|
|
4366
|
+
__applicationErrorsType?: CreateCustomDiscountsApplicationErrors;
|
|
4367
|
+
}>;
|
|
3927
4368
|
interface CreateCustomDiscountsOptions {
|
|
3928
4369
|
/**
|
|
3929
4370
|
* Custom discounts to create.
|
|
@@ -3934,6 +4375,68 @@ interface CreateCustomDiscountsOptions {
|
|
|
3934
4375
|
*/
|
|
3935
4376
|
discounts?: DiscountOption[];
|
|
3936
4377
|
}
|
|
4378
|
+
/**
|
|
4379
|
+
* Removes custom discounts from a draft order.
|
|
4380
|
+
* @param draftOrderId - Draft order ID.
|
|
4381
|
+
* @param discountIds - IDs of the discounts to remove from the draft order.
|
|
4382
|
+
* @public
|
|
4383
|
+
* @documentationMaturity preview
|
|
4384
|
+
* @requiredField discountIds
|
|
4385
|
+
* @requiredField draftOrderId
|
|
4386
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
4387
|
+
* @applicableIdentity APP
|
|
4388
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
|
|
4389
|
+
*/
|
|
4390
|
+
declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<NonNullablePaths<DeleteCustomDiscountsResponse, {
|
|
4391
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4392
|
+
}[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`> & {
|
|
4393
|
+
__applicationErrorsType?: DeleteCustomDiscountsApplicationErrors;
|
|
4394
|
+
}>;
|
|
4395
|
+
/**
|
|
4396
|
+
* Applies or unapplies additional fees on a draft order.
|
|
4397
|
+
*
|
|
4398
|
+
* Additional fees that are not applied are still part of the draft order, but do not affect balance.
|
|
4399
|
+
* Existing additional fees that are not passed in the request will keep their current state.
|
|
4400
|
+
* @param draftOrderId - Draft order ID.
|
|
4401
|
+
* @param additionalFees - Additional fees to set on the draft order.
|
|
4402
|
+
*
|
|
4403
|
+
* Any existing additional fees that are not passed will not change.
|
|
4404
|
+
* @public
|
|
4405
|
+
* @documentationMaturity preview
|
|
4406
|
+
* @requiredField additionalFees
|
|
4407
|
+
* @requiredField additionalFees._id
|
|
4408
|
+
* @requiredField additionalFees.applied
|
|
4409
|
+
* @requiredField draftOrderId
|
|
4410
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
4411
|
+
* @applicableIdentity APP
|
|
4412
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
|
|
4413
|
+
*/
|
|
4414
|
+
declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
|
|
4415
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4416
|
+
}[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`> & {
|
|
4417
|
+
__applicationErrorsType?: SetAdditionalFeesApplicationErrors;
|
|
4418
|
+
}>;
|
|
4419
|
+
/**
|
|
4420
|
+
* Creates custom additional fees on a draft order.
|
|
4421
|
+
*
|
|
4422
|
+
* Newly created additional fees are not applied by default.
|
|
4423
|
+
* To apply them, use Set Additional Fees.
|
|
4424
|
+
* @param draftOrderId - Draft order ID.
|
|
4425
|
+
* @public
|
|
4426
|
+
* @documentationMaturity preview
|
|
4427
|
+
* @requiredField draftOrderId
|
|
4428
|
+
* @requiredField options.customAdditionalFees.name
|
|
4429
|
+
* @requiredField options.customAdditionalFees.price
|
|
4430
|
+
* @requiredField options.customAdditionalFees.price.amount
|
|
4431
|
+
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
4432
|
+
* @applicableIdentity APP
|
|
4433
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
|
|
4434
|
+
*/
|
|
4435
|
+
declare function createCustomAdditionalFees(draftOrderId: string, options?: NonNullablePaths<CreateCustomAdditionalFeesOptions, `customAdditionalFees.${number}.name` | `customAdditionalFees.${number}.price` | `customAdditionalFees.${number}.price.amount`>): Promise<NonNullablePaths<CreateCustomAdditionalFeesResponse, {
|
|
4436
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4437
|
+
}[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`> & {
|
|
4438
|
+
__applicationErrorsType?: CreateCustomAdditionalFeesApplicationErrors;
|
|
4439
|
+
}>;
|
|
3937
4440
|
interface CreateCustomAdditionalFeesOptions {
|
|
3938
4441
|
/**
|
|
3939
4442
|
* Custom additional fees to create.
|
|
@@ -3944,6 +4447,38 @@ interface CreateCustomAdditionalFeesOptions {
|
|
|
3944
4447
|
*/
|
|
3945
4448
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
3946
4449
|
}
|
|
4450
|
+
/**
|
|
4451
|
+
* Removes custom additional fees from a draft order.
|
|
4452
|
+
* @param draftOrderId - Draft order ID.
|
|
4453
|
+
* @param customAdditionalFees - IDs of the additional fees to remove from the draft order.
|
|
4454
|
+
* @public
|
|
4455
|
+
* @documentationMaturity preview
|
|
4456
|
+
* @requiredField customAdditionalFees
|
|
4457
|
+
* @requiredField draftOrderId
|
|
4458
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4459
|
+
* @applicableIdentity APP
|
|
4460
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
|
|
4461
|
+
*/
|
|
4462
|
+
declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<NonNullablePaths<DeleteCustomAdditionalFeesResponse, {
|
|
4463
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4464
|
+
}[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`> & {
|
|
4465
|
+
__applicationErrorsType?: DeleteCustomAdditionalFeesApplicationErrors;
|
|
4466
|
+
}>;
|
|
4467
|
+
/**
|
|
4468
|
+
* Sets shipping information on a draft order.
|
|
4469
|
+
* @param draftOrderId - Draft order ID.
|
|
4470
|
+
* @public
|
|
4471
|
+
* @documentationMaturity preview
|
|
4472
|
+
* @requiredField draftOrderId
|
|
4473
|
+
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4474
|
+
* @applicableIdentity APP
|
|
4475
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
|
|
4476
|
+
*/
|
|
4477
|
+
declare function setShippingInfo(draftOrderId: string, options?: SetShippingInfoOptions): Promise<NonNullablePaths<SetShippingInfoResponse, {
|
|
4478
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4479
|
+
}[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`> & {
|
|
4480
|
+
__applicationErrorsType?: SetShippingInfoApplicationErrors;
|
|
4481
|
+
}>;
|
|
3947
4482
|
interface SetShippingInfoOptions {
|
|
3948
4483
|
/**
|
|
3949
4484
|
* Shipping info to set on the draft order.
|
|
@@ -3952,6 +4487,21 @@ interface SetShippingInfoOptions {
|
|
|
3952
4487
|
*/
|
|
3953
4488
|
shippingInfo?: V1ShippingInformation;
|
|
3954
4489
|
}
|
|
4490
|
+
/**
|
|
4491
|
+
* Sets buyer info on a draft order.
|
|
4492
|
+
* @param draftOrderId - Draft order ID.
|
|
4493
|
+
* @public
|
|
4494
|
+
* @documentationMaturity preview
|
|
4495
|
+
* @requiredField draftOrderId
|
|
4496
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4497
|
+
* @applicableIdentity APP
|
|
4498
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
|
|
4499
|
+
*/
|
|
4500
|
+
declare function setBuyerInfo(draftOrderId: string, options?: SetBuyerInfoOptions): Promise<NonNullablePaths<SetBuyerInfoResponse, {
|
|
4501
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4502
|
+
}[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`> & {
|
|
4503
|
+
__applicationErrorsType?: SetBuyerInfoApplicationErrors;
|
|
4504
|
+
}>;
|
|
3955
4505
|
interface SetBuyerInfoOptions {
|
|
3956
4506
|
/**
|
|
3957
4507
|
* Shipping info to set on the draft order.
|
|
@@ -3960,6 +4510,21 @@ interface SetBuyerInfoOptions {
|
|
|
3960
4510
|
*/
|
|
3961
4511
|
buyerInfo?: BuyerInfo;
|
|
3962
4512
|
}
|
|
4513
|
+
/**
|
|
4514
|
+
* Sets recipient info on a draft order.
|
|
4515
|
+
* @param draftOrderId - Draft order ID.
|
|
4516
|
+
* @public
|
|
4517
|
+
* @documentationMaturity preview
|
|
4518
|
+
* @requiredField draftOrderId
|
|
4519
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4520
|
+
* @applicableIdentity APP
|
|
4521
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
|
|
4522
|
+
*/
|
|
4523
|
+
declare function setRecipientInfo(draftOrderId: string, options?: SetRecipientInfoOptions): Promise<NonNullablePaths<SetRecipientInfoResponse, {
|
|
4524
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4525
|
+
}[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`> & {
|
|
4526
|
+
__applicationErrorsType?: SetRecipientInfoApplicationErrors;
|
|
4527
|
+
}>;
|
|
3963
4528
|
interface SetRecipientInfoOptions {
|
|
3964
4529
|
/**
|
|
3965
4530
|
* Recipient address and contact details.
|
|
@@ -3968,6 +4533,21 @@ interface SetRecipientInfoOptions {
|
|
|
3968
4533
|
*/
|
|
3969
4534
|
recipientInfo?: AddressWithContact;
|
|
3970
4535
|
}
|
|
4536
|
+
/**
|
|
4537
|
+
* Sets billing info on a draft order.
|
|
4538
|
+
* @param draftOrderId - Draft order ID.
|
|
4539
|
+
* @public
|
|
4540
|
+
* @documentationMaturity preview
|
|
4541
|
+
* @requiredField draftOrderId
|
|
4542
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4543
|
+
* @applicableIdentity APP
|
|
4544
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
|
|
4545
|
+
*/
|
|
4546
|
+
declare function setBillingInfo(draftOrderId: string, options?: SetBillingInfoOptions): Promise<NonNullablePaths<SetBillingInfoResponse, {
|
|
4547
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4548
|
+
}[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`> & {
|
|
4549
|
+
__applicationErrorsType?: SetBillingInfoApplicationErrors;
|
|
4550
|
+
}>;
|
|
3971
4551
|
interface SetBillingInfoOptions {
|
|
3972
4552
|
/**
|
|
3973
4553
|
* Billing address and contact details.
|
|
@@ -3976,6 +4556,66 @@ interface SetBillingInfoOptions {
|
|
|
3976
4556
|
*/
|
|
3977
4557
|
billingInfo?: AddressWithContact;
|
|
3978
4558
|
}
|
|
4559
|
+
/**
|
|
4560
|
+
* Retrieves a draft order.
|
|
4561
|
+
*
|
|
4562
|
+
* The retrieved draft order contains the latest calculations:
|
|
4563
|
+
* + Line items, shipping details, and buyer information.
|
|
4564
|
+
* + Tax details and price totals.
|
|
4565
|
+
* + Automatic discounts and automatic additional fees, along with updated eligibility.
|
|
4566
|
+
*
|
|
4567
|
+
* > **Note:** When retrieving a committed draft order, it **is not recalculated**.
|
|
4568
|
+
* @param draftOrderId - Draft order ID.
|
|
4569
|
+
* @public
|
|
4570
|
+
* @documentationMaturity preview
|
|
4571
|
+
* @requiredField draftOrderId
|
|
4572
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4573
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4574
|
+
* @applicableIdentity APP
|
|
4575
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
|
|
4576
|
+
*/
|
|
4577
|
+
declare function getDraftOrder(draftOrderId: string): Promise<NonNullablePaths<GetDraftOrderResponse, {
|
|
4578
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4579
|
+
}[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`> & {
|
|
4580
|
+
__applicationErrorsType?: GetDraftOrderApplicationErrors;
|
|
4581
|
+
}>;
|
|
4582
|
+
/**
|
|
4583
|
+
* Checks whether a draft can be created for an order.
|
|
4584
|
+
*
|
|
4585
|
+
* If `orderDraftable` returns as `true`, the order can be used to create a draft order.
|
|
4586
|
+
*
|
|
4587
|
+
* If `orderDraftable` returns as `false`, refer to the `nonDraftableReasons` array in the response to understand why the order is not draftable.
|
|
4588
|
+
* @param orderId - Order ID.
|
|
4589
|
+
* @public
|
|
4590
|
+
* @documentationMaturity preview
|
|
4591
|
+
* @requiredField orderId
|
|
4592
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4593
|
+
* @applicableIdentity APP
|
|
4594
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
|
|
4595
|
+
*/
|
|
4596
|
+
declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullablePaths<GetOrderDraftabilityStatusResponse, `orderId` | `orderDraftable` | `nonDraftableReasons`>>;
|
|
4597
|
+
/**
|
|
4598
|
+
* Finalizes a draft order and applies its modifications to the associated order.
|
|
4599
|
+
* You can also control which side-effects are executed on commit.
|
|
4600
|
+
*
|
|
4601
|
+
* > **Notes:**
|
|
4602
|
+
* > + The draft order's status is set to `COMMITTED`.
|
|
4603
|
+
* > + Commiting a draft order cannot be undone or reverted.
|
|
4604
|
+
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
4605
|
+
* @param draftOrderId - Draft order ID.
|
|
4606
|
+
* @public
|
|
4607
|
+
* @documentationMaturity preview
|
|
4608
|
+
* @requiredField draftOrderId
|
|
4609
|
+
* @permissionId ECOM.DRAFT_ORDERS_COMMIT
|
|
4610
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4611
|
+
* @applicableIdentity APP
|
|
4612
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
|
|
4613
|
+
*/
|
|
4614
|
+
declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<NonNullablePaths<CommitDraftOrderResponse, {
|
|
4615
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
4616
|
+
}[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`> & {
|
|
4617
|
+
__applicationErrorsType?: CommitDraftOrderApplicationErrors;
|
|
4618
|
+
}>;
|
|
3979
4619
|
interface CommitDraftOrderOptions {
|
|
3980
4620
|
/** Optional side effects to trigger. */
|
|
3981
4621
|
commitSettings?: DraftOrderCommitSettings;
|
|
@@ -3985,6 +4625,27 @@ interface CommitDraftOrderOptions {
|
|
|
3985
4625
|
*/
|
|
3986
4626
|
reason?: string | null;
|
|
3987
4627
|
}
|
|
4628
|
+
/**
|
|
4629
|
+
* Creates a new order from a draft, while specifying which side-effects are executed.
|
|
4630
|
+
*
|
|
4631
|
+
* > **Notes:**
|
|
4632
|
+
* > + The draft order's status is set to `COMMITTED`.
|
|
4633
|
+
* > + Commiting a draft order cannot be undone or reverted.
|
|
4634
|
+
* > + A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
|
|
4635
|
+
* @param draftOrderId - Draft order ID.
|
|
4636
|
+
* @public
|
|
4637
|
+
* @documentationMaturity preview
|
|
4638
|
+
* @requiredField draftOrderId
|
|
4639
|
+
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
4640
|
+
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4641
|
+
* @applicableIdentity APP
|
|
4642
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
|
|
4643
|
+
*/
|
|
4644
|
+
declare function createOrderFromDraft(draftOrderId: string, options?: CreateOrderFromDraftOptions): Promise<NonNullablePaths<CreateOrderFromDraftResponse, {
|
|
4645
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
4646
|
+
}[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`> & {
|
|
4647
|
+
__applicationErrorsType?: CreateOrderFromDraftApplicationErrors;
|
|
4648
|
+
}>;
|
|
3988
4649
|
interface CreateOrderFromDraftOptions {
|
|
3989
4650
|
/** Optional side effects to trigger. */
|
|
3990
4651
|
createSettings?: OrderCreateSettings;
|
|
@@ -3996,6 +4657,34 @@ interface CreateOrderFromDraftOptions {
|
|
|
3996
4657
|
/** Information about the sales channel that submitted this order. */
|
|
3997
4658
|
channelInfo?: ChannelInfo;
|
|
3998
4659
|
}
|
|
4660
|
+
/**
|
|
4661
|
+
* Deletes a draft order along with all its pending changes.
|
|
4662
|
+
*
|
|
4663
|
+
* Draft orders with status 'COMMITTED' cannot be deleted.
|
|
4664
|
+
* @param draftOrderId - Draft order ID.
|
|
4665
|
+
* @public
|
|
4666
|
+
* @documentationMaturity preview
|
|
4667
|
+
* @requiredField draftOrderId
|
|
4668
|
+
* @permissionId ECOM.DRAFT_ORDERS_DELETE
|
|
4669
|
+
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4670
|
+
* @applicableIdentity APP
|
|
4671
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
|
|
4672
|
+
*/
|
|
4673
|
+
declare function deleteDraftOrder(draftOrderId: string): Promise<void & {
|
|
4674
|
+
__applicationErrorsType?: DeleteDraftOrderApplicationErrors;
|
|
4675
|
+
}>;
|
|
4676
|
+
/**
|
|
4677
|
+
* Retrieves a list of up to 100 draft orders, given the provided paging, filtering, and sorting.
|
|
4678
|
+
*
|
|
4679
|
+
* 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).
|
|
4680
|
+
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
4681
|
+
* @public
|
|
4682
|
+
* @documentationMaturity preview
|
|
4683
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4684
|
+
* @applicableIdentity APP
|
|
4685
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
|
|
4686
|
+
*/
|
|
4687
|
+
declare function queryDraftOrders(): DraftOrdersQueryBuilder;
|
|
3999
4688
|
interface QueryCursorResult {
|
|
4000
4689
|
cursors: Cursors;
|
|
4001
4690
|
hasNext: () => boolean;
|
|
@@ -4073,10 +4762,49 @@ interface DraftOrdersQueryBuilder {
|
|
|
4073
4762
|
/** @documentationMaturity preview */
|
|
4074
4763
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
4075
4764
|
}
|
|
4765
|
+
/**
|
|
4766
|
+
* Updates extended fields on a draft order.
|
|
4767
|
+
* @param _id - ID of the entity to update.
|
|
4768
|
+
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
4769
|
+
* @public
|
|
4770
|
+
* @documentationMaturity preview
|
|
4771
|
+
* @requiredField _id
|
|
4772
|
+
* @requiredField namespace
|
|
4773
|
+
* @requiredField options
|
|
4774
|
+
* @requiredField options.namespaceData
|
|
4775
|
+
* @permissionId ECOM.DRAFT_ORDER_UPDATE_EXTENDED_FIELDS
|
|
4776
|
+
* @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4777
|
+
* @applicableIdentity APP
|
|
4778
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateExtendedFields
|
|
4779
|
+
*/
|
|
4780
|
+
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
|
|
4781
|
+
[P in DraftOrderNonNullablePaths]: `draftOrder.${P}`;
|
|
4782
|
+
}[DraftOrderNonNullablePaths]> & {
|
|
4783
|
+
__applicationErrorsType?: UpdateExtendedFieldsApplicationErrors;
|
|
4784
|
+
}>;
|
|
4076
4785
|
interface UpdateExtendedFieldsOptions {
|
|
4077
4786
|
/** 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. */
|
|
4078
4787
|
namespaceData: Record<string, any> | null;
|
|
4079
4788
|
}
|
|
4789
|
+
/**
|
|
4790
|
+
* Sets whether a draft order is tax-exempt.
|
|
4791
|
+
*
|
|
4792
|
+
* A tax exempted draft order ignores taxes during calculation. Tax information will return empty.
|
|
4793
|
+
* @param draftOrderId - Draft order ID.
|
|
4794
|
+
* @public
|
|
4795
|
+
* @documentationMaturity preview
|
|
4796
|
+
* @requiredField draftOrderId
|
|
4797
|
+
* @requiredField options
|
|
4798
|
+
* @requiredField options.taxExempt
|
|
4799
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4800
|
+
* @applicableIdentity APP
|
|
4801
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
|
|
4802
|
+
*/
|
|
4803
|
+
declare function setTaxExemption(draftOrderId: string, options: NonNullablePaths<SetTaxExemptionOptions, `taxExempt`>): Promise<NonNullablePaths<SetTaxExemptionResponse, {
|
|
4804
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4805
|
+
}[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`> & {
|
|
4806
|
+
__applicationErrorsType?: SetTaxExemptionApplicationErrors;
|
|
4807
|
+
}>;
|
|
4080
4808
|
interface SetTaxExemptionOptions {
|
|
4081
4809
|
/**
|
|
4082
4810
|
* Whether the draft order is exempt from tax calculations.
|
|
@@ -4085,9 +4813,27 @@ interface SetTaxExemptionOptions {
|
|
|
4085
4813
|
*/
|
|
4086
4814
|
taxExempt: boolean | null;
|
|
4087
4815
|
}
|
|
4816
|
+
/**
|
|
4817
|
+
* Sets business location on a draft order.
|
|
4818
|
+
*
|
|
4819
|
+
* 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.
|
|
4820
|
+
* @param draftOrderId - Draft order ID.
|
|
4821
|
+
* @public
|
|
4822
|
+
* @documentationMaturity preview
|
|
4823
|
+
* @requiredField draftOrderId
|
|
4824
|
+
* @requiredField options.businessLocation._id
|
|
4825
|
+
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4826
|
+
* @applicableIdentity APP
|
|
4827
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
|
|
4828
|
+
*/
|
|
4829
|
+
declare function setBusinessLocation(draftOrderId: string, options?: NonNullablePaths<SetBusinessLocationOptions, `businessLocation._id`>): Promise<NonNullablePaths<SetBusinessLocationResponse, {
|
|
4830
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4831
|
+
}[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`> & {
|
|
4832
|
+
__applicationErrorsType?: SetBusinessLocationApplicationErrors;
|
|
4833
|
+
}>;
|
|
4088
4834
|
interface SetBusinessLocationOptions {
|
|
4089
4835
|
/** Business location. */
|
|
4090
4836
|
businessLocation?: Location;
|
|
4091
4837
|
}
|
|
4092
4838
|
|
|
4093
|
-
export {
|
|
4839
|
+
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 };
|