@wix/auto_sdk_ecom_draft-orders 1.0.24 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +18 -2
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +15 -18
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +15 -18
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +18 -20
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +213 -2
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +244 -20
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +62 -17
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +16 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +15 -18
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +15 -18
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +18 -20
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +211 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +244 -20
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +62 -17
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +18 -2
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +15 -18
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +15 -18
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +18 -20
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +213 -2
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +246 -21
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +62 -17
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +17 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +16 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +15 -18
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +15 -18
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +18 -20
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +211 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +70 -3
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +2 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +246 -21
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +62 -17
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Draft Order main entity.
|
|
4
|
+
* A temporary version of an order, allowing modifications before finalization.
|
|
5
|
+
*/
|
|
3
6
|
export interface DraftOrder {
|
|
4
7
|
/**
|
|
5
8
|
* Draft order ID.
|
|
@@ -318,6 +321,13 @@ export interface OrderLineItem {
|
|
|
318
321
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
319
322
|
*/
|
|
320
323
|
extendedFields?: ExtendedFields;
|
|
324
|
+
/**
|
|
325
|
+
* Modifier groups that were added to the item.
|
|
326
|
+
* @internal
|
|
327
|
+
* @readonly
|
|
328
|
+
* @maxSize 10
|
|
329
|
+
*/
|
|
330
|
+
modifierGroups?: ModifierGroup[];
|
|
321
331
|
}
|
|
322
332
|
export interface ProductName {
|
|
323
333
|
/**
|
|
@@ -635,7 +645,6 @@ export interface SubscriptionInfo {
|
|
|
635
645
|
subscriptionSettings?: SubscriptionSettings;
|
|
636
646
|
/**
|
|
637
647
|
* Description of the charges that will be applied for subscription.
|
|
638
|
-
* @internal
|
|
639
648
|
* @maxLength 1000
|
|
640
649
|
*/
|
|
641
650
|
chargesDescription?: string | null;
|
|
@@ -796,6 +805,63 @@ export interface ExtendedFields {
|
|
|
796
805
|
*/
|
|
797
806
|
namespaces?: Record<string, Record<string, any>>;
|
|
798
807
|
}
|
|
808
|
+
export interface ModifierGroup {
|
|
809
|
+
/**
|
|
810
|
+
* Modifier group id.
|
|
811
|
+
* @minLength 1
|
|
812
|
+
* @maxLength 36
|
|
813
|
+
*/
|
|
814
|
+
_id?: string;
|
|
815
|
+
/** Modifier group name. */
|
|
816
|
+
name?: TranslatableString;
|
|
817
|
+
/**
|
|
818
|
+
* List of modifiers in this group.
|
|
819
|
+
* @minSize 1
|
|
820
|
+
* @maxSize 10
|
|
821
|
+
*/
|
|
822
|
+
modifiers?: ItemModifier[];
|
|
823
|
+
}
|
|
824
|
+
export interface TranslatableString {
|
|
825
|
+
/**
|
|
826
|
+
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
827
|
+
*
|
|
828
|
+
* Min: 1 character.
|
|
829
|
+
* Max: 200 characters.
|
|
830
|
+
* @minLength 1
|
|
831
|
+
* @maxLength 200
|
|
832
|
+
*/
|
|
833
|
+
original?: string;
|
|
834
|
+
/**
|
|
835
|
+
* String translated into the buyer's language.
|
|
836
|
+
*
|
|
837
|
+
* Min: 1 character.
|
|
838
|
+
* Max: 400 characters.
|
|
839
|
+
* Default: Same as `original`.
|
|
840
|
+
* @minLength 1
|
|
841
|
+
* @maxLength 400
|
|
842
|
+
*/
|
|
843
|
+
translated?: string | null;
|
|
844
|
+
}
|
|
845
|
+
export interface ItemModifier {
|
|
846
|
+
/**
|
|
847
|
+
* Modifier ID.
|
|
848
|
+
* @minLength 1
|
|
849
|
+
* @maxLength 36
|
|
850
|
+
*/
|
|
851
|
+
_id?: string;
|
|
852
|
+
/**
|
|
853
|
+
* The quantity of this modifier.
|
|
854
|
+
* @min 1
|
|
855
|
+
* @max 100000
|
|
856
|
+
*/
|
|
857
|
+
quantity?: number | null;
|
|
858
|
+
/** Primary display label for the modifier. */
|
|
859
|
+
label?: TranslatableString;
|
|
860
|
+
/** Optional additional details or clarification for the modifier. */
|
|
861
|
+
details?: TranslatableString;
|
|
862
|
+
/** The price of the modifier. */
|
|
863
|
+
price?: Price;
|
|
864
|
+
}
|
|
799
865
|
export interface ItemChangedDetails {
|
|
800
866
|
/**
|
|
801
867
|
* Line item quantity before change.
|
|
@@ -1133,7 +1199,7 @@ export interface AdditionalFeeDetails {
|
|
|
1133
1199
|
* Supported values:
|
|
1134
1200
|
* + `ORIGINAL_ORDER`: This additional fee is part of the original order.
|
|
1135
1201
|
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1136
|
-
* + `CUSTOM`: This additional fee was created by the
|
|
1202
|
+
* + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
|
|
1137
1203
|
*/
|
|
1138
1204
|
source?: SourceType;
|
|
1139
1205
|
/** Whether this additional fee is applied to the order. */
|
|
@@ -1211,7 +1277,7 @@ export interface DiscountDetails {
|
|
|
1211
1277
|
*
|
|
1212
1278
|
* Supported values:
|
|
1213
1279
|
* + `ORIGINAL_ORDER`: This discount is part of the original order.
|
|
1214
|
-
* + `CUSTOM`: This discount was created by the
|
|
1280
|
+
* + `CUSTOM`: This discount was created by the Create Custom Discounts method.
|
|
1215
1281
|
*/
|
|
1216
1282
|
source?: SourceType;
|
|
1217
1283
|
/** Whether this discount is applied to the order. */
|
|
@@ -1722,7 +1788,9 @@ export interface PickupDetails {
|
|
|
1722
1788
|
}
|
|
1723
1789
|
export declare enum PickupMethod {
|
|
1724
1790
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1791
|
+
/** Store pickup. */
|
|
1725
1792
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1793
|
+
/** Pickup point. */
|
|
1726
1794
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1727
1795
|
}
|
|
1728
1796
|
export interface DeliveryTimeSlot {
|
|
@@ -3921,12 +3989,126 @@ export declare enum WebhookIdentityType {
|
|
|
3921
3989
|
WIX_USER = "WIX_USER",
|
|
3922
3990
|
APP = "APP"
|
|
3923
3991
|
}
|
|
3992
|
+
export interface BaseEventMetadata {
|
|
3993
|
+
/**
|
|
3994
|
+
* App instance ID.
|
|
3995
|
+
* @format GUID
|
|
3996
|
+
*/
|
|
3997
|
+
instanceId?: string | null;
|
|
3998
|
+
/**
|
|
3999
|
+
* Event type.
|
|
4000
|
+
* @maxLength 150
|
|
4001
|
+
*/
|
|
4002
|
+
eventType?: string;
|
|
4003
|
+
/** The identification type and identity data. */
|
|
4004
|
+
identity?: IdentificationData;
|
|
4005
|
+
}
|
|
4006
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
4007
|
+
/**
|
|
4008
|
+
* Unique event ID.
|
|
4009
|
+
* Allows clients to ignore duplicate webhooks.
|
|
4010
|
+
*/
|
|
4011
|
+
_id?: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Assumes actions are also always typed to an entity_type
|
|
4014
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
4015
|
+
*/
|
|
4016
|
+
entityFqdn?: string;
|
|
4017
|
+
/**
|
|
4018
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
4019
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
4020
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
4021
|
+
*/
|
|
4022
|
+
slug?: string;
|
|
4023
|
+
/** ID of the entity associated with the event. */
|
|
4024
|
+
entityId?: string;
|
|
4025
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4026
|
+
eventTime?: Date | null;
|
|
4027
|
+
/**
|
|
4028
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4029
|
+
* (for example, GDPR).
|
|
4030
|
+
*/
|
|
4031
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4032
|
+
/** If present, indicates the action that triggered the event. */
|
|
4033
|
+
originatedFrom?: string | null;
|
|
4034
|
+
/**
|
|
4035
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
4036
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
4037
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
4038
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
4039
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
4040
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
4041
|
+
*/
|
|
4042
|
+
entityEventSequence?: string | null;
|
|
4043
|
+
}
|
|
4044
|
+
export interface DraftOrderCreatedEnvelope {
|
|
4045
|
+
entity: DraftOrder;
|
|
4046
|
+
metadata: EventMetadata;
|
|
4047
|
+
}
|
|
4048
|
+
/**
|
|
4049
|
+
* Triggered when a draft order is created.
|
|
4050
|
+
* @permissionScope Manage Stores - all permissions
|
|
4051
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4052
|
+
* @permissionScope Manage Stores
|
|
4053
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4054
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4055
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4056
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4057
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4058
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4059
|
+
* @webhook
|
|
4060
|
+
* @eventType wix.ecom.v1.draft_order_created
|
|
4061
|
+
* @slug created
|
|
4062
|
+
* @documentationMaturity preview
|
|
4063
|
+
*/
|
|
4064
|
+
export declare function onDraftOrderCreated(handler: (event: DraftOrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4065
|
+
export interface DraftOrderDeletedEnvelope {
|
|
4066
|
+
metadata: EventMetadata;
|
|
4067
|
+
}
|
|
4068
|
+
/**
|
|
4069
|
+
* Triggered when a draft order is deleted.
|
|
4070
|
+
* @permissionScope Manage Stores - all permissions
|
|
4071
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4072
|
+
* @permissionScope Manage Stores
|
|
4073
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4074
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4075
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4076
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4077
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4078
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4079
|
+
* @webhook
|
|
4080
|
+
* @eventType wix.ecom.v1.draft_order_deleted
|
|
4081
|
+
* @slug deleted
|
|
4082
|
+
* @documentationMaturity preview
|
|
4083
|
+
*/
|
|
4084
|
+
export declare function onDraftOrderDeleted(handler: (event: DraftOrderDeletedEnvelope) => void | Promise<void>): void;
|
|
4085
|
+
export interface DraftOrderUpdatedEnvelope {
|
|
4086
|
+
entity: DraftOrder;
|
|
4087
|
+
metadata: EventMetadata;
|
|
4088
|
+
}
|
|
4089
|
+
/**
|
|
4090
|
+
* Triggered when a draft order is updated.
|
|
4091
|
+
* @permissionScope Manage Stores - all permissions
|
|
4092
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4093
|
+
* @permissionScope Manage Stores
|
|
4094
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4095
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4096
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4097
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4098
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4099
|
+
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4100
|
+
* @webhook
|
|
4101
|
+
* @eventType wix.ecom.v1.draft_order_updated
|
|
4102
|
+
* @slug updated
|
|
4103
|
+
* @documentationMaturity preview
|
|
4104
|
+
*/
|
|
4105
|
+
export declare function onDraftOrderUpdated(handler: (event: DraftOrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
3924
4106
|
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.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`;
|
|
3925
4107
|
/**
|
|
3926
|
-
* Creates or
|
|
4108
|
+
* Creates or retrieves a draft order based on the specified order ID.
|
|
3927
4109
|
*
|
|
3928
|
-
* When passing the ID of an order that is already in draft, the existing draft order
|
|
3929
|
-
* To complete a draft and update the order, call Commit Draft Order
|
|
4110
|
+
* When passing the ID of an order that is already in draft, the existing draft order is returned.
|
|
4111
|
+
* To complete a draft and update the original order, call Commit Draft Order.
|
|
3930
4112
|
* @param orderId - ID of the order to create a draft for.
|
|
3931
4113
|
* @public
|
|
3932
4114
|
* @documentationMaturity preview
|
|
@@ -3936,6 +4118,8 @@ type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `l
|
|
|
3936
4118
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3937
4119
|
* @permissionScope Manage Stores - all permissions
|
|
3938
4120
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4121
|
+
* @permissionScope Manage Stores
|
|
4122
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3939
4123
|
* @permissionScope Manage Restaurants - all permissions
|
|
3940
4124
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3941
4125
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3948,6 +4132,8 @@ export declare function createDraftOrder(orderId: string): Promise<NonNullablePa
|
|
|
3948
4132
|
}[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`>>;
|
|
3949
4133
|
/**
|
|
3950
4134
|
* Creates an empty draft order.
|
|
4135
|
+
*
|
|
4136
|
+
* After all relevant details are applied, call Create Order From Draft to convert the draft order to a regular order.
|
|
3951
4137
|
* @public
|
|
3952
4138
|
* @documentationMaturity preview
|
|
3953
4139
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE
|
|
@@ -3955,6 +4141,8 @@ export declare function createDraftOrder(orderId: string): Promise<NonNullablePa
|
|
|
3955
4141
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3956
4142
|
* @permissionScope Manage Stores - all permissions
|
|
3957
4143
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4144
|
+
* @permissionScope Manage Stores
|
|
4145
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3958
4146
|
* @permissionScope Manage Restaurants - all permissions
|
|
3959
4147
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3960
4148
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -3975,6 +4163,8 @@ export declare function createEmptyDraftOrder(): Promise<NonNullablePaths<Create
|
|
|
3975
4163
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
3976
4164
|
* @permissionScope Manage Stores - all permissions
|
|
3977
4165
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4166
|
+
* @permissionScope Manage Stores
|
|
4167
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
3978
4168
|
* @permissionScope Manage Restaurants - all permissions
|
|
3979
4169
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3980
4170
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4002,11 +4192,11 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
4002
4192
|
/**
|
|
4003
4193
|
* Updates a draft order's line items.
|
|
4004
4194
|
*
|
|
4005
|
-
*
|
|
4195
|
+
* You can update a line item's quantity, price, and description.
|
|
4006
4196
|
* > **Notes:**
|
|
4007
|
-
* > +
|
|
4197
|
+
* > + Specifying a quantity of `0` will remove the line item.
|
|
4008
4198
|
* > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
|
|
4009
|
-
* > + Quantity cannot be decreased fulfilled line items. To
|
|
4199
|
+
* > + 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)).
|
|
4010
4200
|
* @param draftOrderId - Draft order ID.
|
|
4011
4201
|
* @param lineItemChanges - Details of changes to apply per line item.
|
|
4012
4202
|
* @public
|
|
@@ -4017,6 +4207,8 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
4017
4207
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
4018
4208
|
* @permissionScope Manage Stores - all permissions
|
|
4019
4209
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4210
|
+
* @permissionScope Manage Stores
|
|
4211
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4020
4212
|
* @permissionScope Manage Restaurants - all permissions
|
|
4021
4213
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4022
4214
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4045,6 +4237,8 @@ export declare function updateLineItems(draftOrderId: string, lineItemChanges: N
|
|
|
4045
4237
|
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
4046
4238
|
* @permissionScope Manage Stores - all permissions
|
|
4047
4239
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4240
|
+
* @permissionScope Manage Stores
|
|
4241
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4048
4242
|
* @permissionScope Manage Restaurants - all permissions
|
|
4049
4243
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4050
4244
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4059,7 +4253,7 @@ export declare function setDiscounts(draftOrderId: string, discounts: NonNullabl
|
|
|
4059
4253
|
* Creates custom discounts.
|
|
4060
4254
|
*
|
|
4061
4255
|
* Newly created discounts are unapplied by default.
|
|
4062
|
-
* To apply them, use Set Discounts
|
|
4256
|
+
* To apply them, use Set Discounts.
|
|
4063
4257
|
* @param draftOrderId - Draft order ID.
|
|
4064
4258
|
* @public
|
|
4065
4259
|
* @documentationMaturity preview
|
|
@@ -4070,6 +4264,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: NonNullabl
|
|
|
4070
4264
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
4071
4265
|
* @permissionScope Manage Stores - all permissions
|
|
4072
4266
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4267
|
+
* @permissionScope Manage Stores
|
|
4268
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4073
4269
|
* @permissionScope Manage Restaurants - all permissions
|
|
4074
4270
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4075
4271
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4101,6 +4297,8 @@ export interface CreateCustomDiscountsOptions {
|
|
|
4101
4297
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
4102
4298
|
* @permissionScope Manage Stores - all permissions
|
|
4103
4299
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4300
|
+
* @permissionScope Manage Stores
|
|
4301
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4104
4302
|
* @permissionScope Manage Restaurants - all permissions
|
|
4105
4303
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4106
4304
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4129,6 +4327,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
4129
4327
|
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
4130
4328
|
* @permissionScope Manage Stores - all permissions
|
|
4131
4329
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4330
|
+
* @permissionScope Manage Stores
|
|
4331
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4132
4332
|
* @permissionScope Manage Restaurants - all permissions
|
|
4133
4333
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4134
4334
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4143,7 +4343,7 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4143
4343
|
* Creates custom additional fees on a draft order.
|
|
4144
4344
|
*
|
|
4145
4345
|
* Newly created additional fees are not applied by default.
|
|
4146
|
-
* To apply them, use Set Additional Fees
|
|
4346
|
+
* To apply them, use Set Additional Fees.
|
|
4147
4347
|
* @param draftOrderId - Draft order ID.
|
|
4148
4348
|
* @public
|
|
4149
4349
|
* @documentationMaturity preview
|
|
@@ -4154,6 +4354,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4154
4354
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
4155
4355
|
* @permissionScope Manage Stores - all permissions
|
|
4156
4356
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4357
|
+
* @permissionScope Manage Stores
|
|
4358
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4157
4359
|
* @permissionScope Manage Restaurants - all permissions
|
|
4158
4360
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4159
4361
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4185,6 +4387,8 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
4185
4387
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4186
4388
|
* @permissionScope Manage Stores - all permissions
|
|
4187
4389
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4390
|
+
* @permissionScope Manage Stores
|
|
4391
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4188
4392
|
* @permissionScope Manage Restaurants - all permissions
|
|
4189
4393
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4190
4394
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4204,6 +4408,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
4204
4408
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4205
4409
|
* @permissionScope Manage Stores - all permissions
|
|
4206
4410
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4411
|
+
* @permissionScope Manage Stores
|
|
4412
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4207
4413
|
* @permissionScope Manage Restaurants - all permissions
|
|
4208
4414
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4209
4415
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4231,6 +4437,8 @@ export interface SetShippingInfoOptions {
|
|
|
4231
4437
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4232
4438
|
* @permissionScope Manage Stores - all permissions
|
|
4233
4439
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4440
|
+
* @permissionScope Manage Stores
|
|
4441
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4234
4442
|
* @permissionScope Manage Restaurants - all permissions
|
|
4235
4443
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4236
4444
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4258,6 +4466,8 @@ export interface SetBuyerInfoOptions {
|
|
|
4258
4466
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4259
4467
|
* @permissionScope Manage Stores - all permissions
|
|
4260
4468
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4469
|
+
* @permissionScope Manage Stores
|
|
4470
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4261
4471
|
* @permissionScope Manage Restaurants - all permissions
|
|
4262
4472
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4263
4473
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4285,6 +4495,8 @@ export interface SetRecipientInfoOptions {
|
|
|
4285
4495
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4286
4496
|
* @permissionScope Manage Stores - all permissions
|
|
4287
4497
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4498
|
+
* @permissionScope Manage Stores
|
|
4499
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4288
4500
|
* @permissionScope Manage Restaurants - all permissions
|
|
4289
4501
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4290
4502
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4320,6 +4532,8 @@ export interface SetBillingInfoOptions {
|
|
|
4320
4532
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4321
4533
|
* @permissionScope Manage Stores - all permissions
|
|
4322
4534
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4535
|
+
* @permissionScope Manage Stores
|
|
4536
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4323
4537
|
* @permissionScope Manage Restaurants - all permissions
|
|
4324
4538
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4325
4539
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4339,6 +4553,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<NonNullable
|
|
|
4339
4553
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4340
4554
|
* @permissionScope Manage Stores - all permissions
|
|
4341
4555
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4556
|
+
* @permissionScope Manage Stores
|
|
4557
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4342
4558
|
* @permissionScope Manage Restaurants - all permissions
|
|
4343
4559
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4344
4560
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4363,6 +4579,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Non
|
|
|
4363
4579
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4364
4580
|
* @permissionScope Manage Stores - all permissions
|
|
4365
4581
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4582
|
+
* @permissionScope Manage Stores
|
|
4583
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4366
4584
|
* @permissionScope Manage Restaurants - all permissions
|
|
4367
4585
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4368
4586
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4397,6 +4615,8 @@ export interface CommitDraftOrderOptions {
|
|
|
4397
4615
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4398
4616
|
* @permissionScope Manage Stores - all permissions
|
|
4399
4617
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4618
|
+
* @permissionScope Manage Stores
|
|
4619
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4400
4620
|
* @permissionScope Manage Restaurants - all permissions
|
|
4401
4621
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4402
4622
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4430,6 +4650,8 @@ export interface CreateOrderFromDraftOptions {
|
|
|
4430
4650
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4431
4651
|
* @permissionScope Manage Stores - all permissions
|
|
4432
4652
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4653
|
+
* @permissionScope Manage Stores
|
|
4654
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4433
4655
|
* @permissionScope Manage Restaurants - all permissions
|
|
4434
4656
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4435
4657
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4439,21 +4661,16 @@ export interface CreateOrderFromDraftOptions {
|
|
|
4439
4661
|
*/
|
|
4440
4662
|
export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
|
|
4441
4663
|
/**
|
|
4442
|
-
* Retrieves a list of draft orders given the provided paging, filtering, and sorting.
|
|
4443
|
-
*
|
|
4444
|
-
* Refer to the table below for supported fields, filters, and sorting:
|
|
4445
|
-
* | **Property** | **Supported Filters & Sorting** | **Sortable** |
|
|
4446
|
-
* |----------------|---------------------------------------------------------------------------------|--------------|
|
|
4447
|
-
* | `_createdDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
|
|
4448
|
-
* | `_updatedDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
|
|
4449
|
-
* | `status` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()` | Sortable |
|
|
4450
|
-
* | `orderId` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `startsWith()` | |
|
|
4664
|
+
* Retrieves a list of up to 100 draft orders, given the provided paging, filtering, and sorting.
|
|
4451
4665
|
*
|
|
4666
|
+
* 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).
|
|
4452
4667
|
* To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
4453
4668
|
* @public
|
|
4454
4669
|
* @documentationMaturity preview
|
|
4455
4670
|
* @permissionScope Manage Stores - all permissions
|
|
4456
4671
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4672
|
+
* @permissionScope Manage Stores
|
|
4673
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4457
4674
|
* @permissionScope Manage Restaurants - all permissions
|
|
4458
4675
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4459
4676
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4554,12 +4771,16 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4554
4771
|
* @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4555
4772
|
* @permissionScope Manage Stores - all permissions
|
|
4556
4773
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4774
|
+
* @permissionScope Manage Stores
|
|
4775
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4557
4776
|
* @permissionScope Manage Restaurants - all permissions
|
|
4558
4777
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4559
4778
|
* @permissionScope Manage eCommerce - all permissions
|
|
4560
4779
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4561
4780
|
* @permissionScope Manage Stores - all permissions
|
|
4562
4781
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4782
|
+
* @permissionScope Manage Stores
|
|
4783
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4563
4784
|
* @permissionScope Manage Restaurants - all permissions
|
|
4564
4785
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4565
4786
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4589,6 +4810,8 @@ export interface UpdateExtendedFieldsOptions {
|
|
|
4589
4810
|
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4590
4811
|
* @permissionScope Manage Stores - all permissions
|
|
4591
4812
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4813
|
+
* @permissionScope Manage Stores
|
|
4814
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4592
4815
|
* @permissionScope Manage Restaurants - all permissions
|
|
4593
4816
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4594
4817
|
* @permissionScope Manage eCommerce - all permissions
|
|
@@ -4619,6 +4842,8 @@ export interface SetTaxExemptionOptions {
|
|
|
4619
4842
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4620
4843
|
* @permissionScope Manage Stores - all permissions
|
|
4621
4844
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4845
|
+
* @permissionScope Manage Stores
|
|
4846
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4622
4847
|
* @permissionScope Manage Restaurants - all permissions
|
|
4623
4848
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4624
4849
|
* @permissionScope Manage eCommerce - all permissions
|