@wix/auto_sdk_ecom_orders 1.0.177 → 1.0.179
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/{ecom-v1-order-orders.universal-DJjccA2m.d.ts → ecom-v1-order-orders.universal-BzyYBns1.d.ts} +52 -43
- package/build/cjs/index.d.ts +13 -19
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +6 -9
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +49 -38
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-DJjccA2m.d.mts → ecom-v1-order-orders.universal-BzyYBns1.d.mts} +52 -43
- package/build/es/index.d.mts +13 -19
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +6 -9
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +49 -38
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-2VQJF3IE.d.ts → ecom-v1-order-orders.universal-CVWkoslF.d.ts} +67 -48
- package/build/internal/cjs/index.d.ts +20 -26
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +6 -9
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +49 -38
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{ecom-v1-order-orders.universal-2VQJF3IE.d.mts → ecom-v1-order-orders.universal-CVWkoslF.d.mts} +67 -48
- package/build/internal/es/index.d.mts +20 -26
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +6 -9
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +49 -38
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* An order represents a completed purchase from a buyer. Orders are created through the checkout flow or manually via the Create Order endpoint.
|
|
5
|
+
*
|
|
6
|
+
* The order contains details about purchased items, buyer and recipient information, pricing, tax, shipping, fulfillment status, and payment status.
|
|
7
|
+
*/
|
|
3
8
|
interface Order {
|
|
4
9
|
/**
|
|
5
10
|
* Order ID.
|
|
@@ -146,10 +151,10 @@ interface Order {
|
|
|
146
151
|
*/
|
|
147
152
|
purchaseFlowId?: string | null;
|
|
148
153
|
/**
|
|
149
|
-
*
|
|
154
|
+
* Final recipient's address and contact details.
|
|
150
155
|
*
|
|
151
|
-
* This field
|
|
152
|
-
* + The chosen shipping option is pickup point or store pickup.
|
|
156
|
+
* This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when:
|
|
157
|
+
* + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location.
|
|
153
158
|
* + No shipping option is selected.
|
|
154
159
|
*/
|
|
155
160
|
recipientInfo?: AddressWithContact;
|
|
@@ -181,6 +186,7 @@ interface OrderLineItem {
|
|
|
181
186
|
_id?: string;
|
|
182
187
|
/**
|
|
183
188
|
* Item name.
|
|
189
|
+
*
|
|
184
190
|
* + Stores - `product.name`
|
|
185
191
|
* + Bookings - `service.info.name`
|
|
186
192
|
* + Events - `ticket.name`
|
|
@@ -857,15 +863,15 @@ interface ItemModifier {
|
|
|
857
863
|
/** The price of the modifier. */
|
|
858
864
|
price?: Price;
|
|
859
865
|
}
|
|
860
|
-
/** Buyer
|
|
866
|
+
/** Buyer information. */
|
|
861
867
|
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
862
868
|
/**
|
|
863
|
-
* Visitor ID
|
|
869
|
+
* Visitor ID. Returned when the buyer isn't a logged-in site member.
|
|
864
870
|
* @format GUID
|
|
865
871
|
*/
|
|
866
872
|
visitorId?: string;
|
|
867
873
|
/**
|
|
868
|
-
* Member ID
|
|
874
|
+
* Member ID. Returned when the buyer is a logged-in site member.
|
|
869
875
|
* @format GUID
|
|
870
876
|
*/
|
|
871
877
|
memberId?: string;
|
|
@@ -875,7 +881,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
875
881
|
*/
|
|
876
882
|
contactId?: string | null;
|
|
877
883
|
/**
|
|
878
|
-
* Buyer email address.
|
|
884
|
+
* Buyer's email address.
|
|
879
885
|
* @format EMAIL
|
|
880
886
|
*/
|
|
881
887
|
email?: string | null;
|
|
@@ -883,12 +889,12 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
883
889
|
/** @oneof */
|
|
884
890
|
interface BuyerInfoIdOneOf {
|
|
885
891
|
/**
|
|
886
|
-
* Visitor ID
|
|
892
|
+
* Visitor ID. Returned when the buyer isn't a logged-in site member.
|
|
887
893
|
* @format GUID
|
|
888
894
|
*/
|
|
889
895
|
visitorId?: string;
|
|
890
896
|
/**
|
|
891
|
-
* Member ID
|
|
897
|
+
* Member ID. Returned when the buyer is a logged-in site member.
|
|
892
898
|
* @format GUID
|
|
893
899
|
*/
|
|
894
900
|
memberId?: string;
|
|
@@ -978,17 +984,17 @@ interface CurrencyConversionDetails {
|
|
|
978
984
|
conversionRate?: string | null;
|
|
979
985
|
}
|
|
980
986
|
interface PriceSummary {
|
|
981
|
-
/** Subtotal of all
|
|
987
|
+
/** Subtotal of all line items, before discounts and before tax. */
|
|
982
988
|
subtotal?: Price;
|
|
983
989
|
/** Total shipping price, before discounts and before tax. */
|
|
984
990
|
shipping?: Price;
|
|
985
|
-
/** Total tax
|
|
991
|
+
/** Total tax applied to the order. */
|
|
986
992
|
tax?: Price;
|
|
987
|
-
/** Total
|
|
993
|
+
/** Total discount amount applied to the order. */
|
|
988
994
|
discount?: Price;
|
|
989
|
-
/** Order
|
|
995
|
+
/** Order's total price after discounts and tax. */
|
|
990
996
|
total?: Price;
|
|
991
|
-
/** Total
|
|
997
|
+
/** Total additional fees before tax. */
|
|
992
998
|
totalAdditionalFees?: Price;
|
|
993
999
|
}
|
|
994
1000
|
/** Billing Info and shipping details */
|
|
@@ -1131,9 +1137,9 @@ interface V1ShippingInformation {
|
|
|
1131
1137
|
region?: ShippingRegion;
|
|
1132
1138
|
}
|
|
1133
1139
|
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1134
|
-
/** Shipping address and contact details. */
|
|
1140
|
+
/** Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. */
|
|
1135
1141
|
shippingDestination?: AddressWithContact;
|
|
1136
|
-
/** Pickup details. */
|
|
1142
|
+
/** Pickup details for store pickup or pickup point orders. */
|
|
1137
1143
|
pickupDetails?: PickupDetails;
|
|
1138
1144
|
/**
|
|
1139
1145
|
* Expected delivery time in free text. For example, `"3-5 business days"`.
|
|
@@ -1141,7 +1147,7 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1141
1147
|
*/
|
|
1142
1148
|
deliveryTime?: string | null;
|
|
1143
1149
|
/**
|
|
1144
|
-
* Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number.
|
|
1150
|
+
* Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`.
|
|
1145
1151
|
* @maxLength 1000
|
|
1146
1152
|
*/
|
|
1147
1153
|
instructions?: string | null;
|
|
@@ -1150,14 +1156,14 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1150
1156
|
* @deprecated
|
|
1151
1157
|
*/
|
|
1152
1158
|
deliverByDate?: Date | null;
|
|
1153
|
-
/** Expected delivery time. */
|
|
1159
|
+
/** Expected delivery time slot with start and end times. */
|
|
1154
1160
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1155
1161
|
}
|
|
1156
1162
|
/** @oneof */
|
|
1157
1163
|
interface DeliveryLogisticsAddressOneOf {
|
|
1158
|
-
/** Shipping address and contact details. */
|
|
1164
|
+
/** Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. */
|
|
1159
1165
|
shippingDestination?: AddressWithContact;
|
|
1160
|
-
/** Pickup details. */
|
|
1166
|
+
/** Pickup details for store pickup or pickup point orders. */
|
|
1161
1167
|
pickupDetails?: PickupDetails;
|
|
1162
1168
|
}
|
|
1163
1169
|
interface PickupDetails {
|
|
@@ -1265,14 +1271,14 @@ declare enum OrderStatus {
|
|
|
1265
1271
|
/**
|
|
1266
1272
|
* Order approved.
|
|
1267
1273
|
*
|
|
1268
|
-
* This happens when either an online payment is received **or** when `
|
|
1274
|
+
* This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order).
|
|
1269
1275
|
* Offline orders (cash payment) are automatically approved.
|
|
1270
1276
|
*/
|
|
1271
1277
|
APPROVED = "APPROVED",
|
|
1272
|
-
/** Order canceled by the
|
|
1278
|
+
/** Order canceled by the merchant or buyer. */
|
|
1273
1279
|
CANCELED = "CANCELED",
|
|
1274
1280
|
/**
|
|
1275
|
-
* Order
|
|
1281
|
+
* Order is waiting for the buyer to complete checkout.
|
|
1276
1282
|
* @documentationMaturity preview
|
|
1277
1283
|
*/
|
|
1278
1284
|
PENDING = "PENDING",
|
|
@@ -1497,8 +1503,6 @@ interface ItemCombinationLineItem {
|
|
|
1497
1503
|
quantity?: number;
|
|
1498
1504
|
}
|
|
1499
1505
|
interface Activity extends ActivityContentOneOf {
|
|
1500
|
-
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1501
|
-
customActivity?: CustomActivity;
|
|
1502
1506
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1503
1507
|
merchantComment?: MerchantComment;
|
|
1504
1508
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
@@ -1579,8 +1583,6 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1579
1583
|
}
|
|
1580
1584
|
/** @oneof */
|
|
1581
1585
|
interface ActivityContentOneOf {
|
|
1582
|
-
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1583
|
-
customActivity?: CustomActivity;
|
|
1584
1586
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1585
1587
|
merchantComment?: MerchantComment;
|
|
1586
1588
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
@@ -2556,15 +2558,19 @@ interface CreatedByStringOneOf {
|
|
|
2556
2558
|
appId?: string;
|
|
2557
2559
|
}
|
|
2558
2560
|
interface ChannelInfo {
|
|
2559
|
-
/**
|
|
2561
|
+
/**
|
|
2562
|
+
* Sales channel that submitted the order.
|
|
2563
|
+
*
|
|
2564
|
+
* When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`.
|
|
2565
|
+
*/
|
|
2560
2566
|
type?: ChannelTypeWithLiterals;
|
|
2561
2567
|
/**
|
|
2562
|
-
* Reference to an order ID from an external system.
|
|
2568
|
+
* Reference to an order ID from an external system. Relevant when recording orders from external platforms.
|
|
2563
2569
|
* @maxLength 100
|
|
2564
2570
|
*/
|
|
2565
2571
|
externalOrderId?: string | null;
|
|
2566
2572
|
/**
|
|
2567
|
-
* URL to the order in the external system.
|
|
2573
|
+
* URL to the order in the external system. Relevant when recording orders from external platforms.
|
|
2568
2574
|
* @maxLength 300
|
|
2569
2575
|
*/
|
|
2570
2576
|
externalOrderUrl?: string | null;
|
|
@@ -3973,6 +3979,11 @@ interface TriggerRefundResponse {
|
|
|
3973
3979
|
/** Payment ID's that the refund execution had failed for */
|
|
3974
3980
|
failedPaymentIds?: ItemMetadata[];
|
|
3975
3981
|
}
|
|
3982
|
+
/**
|
|
3983
|
+
* A record of all payments and refunds associated with an order.
|
|
3984
|
+
*
|
|
3985
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
3986
|
+
*/
|
|
3976
3987
|
interface OrderTransactions {
|
|
3977
3988
|
/**
|
|
3978
3989
|
* Order ID.
|
|
@@ -7187,7 +7198,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
|
|
|
7187
7198
|
* @returns Fulfilled - The requested order.
|
|
7188
7199
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
7189
7200
|
*/
|
|
7190
|
-
declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.
|
|
7201
|
+
declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
7191
7202
|
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
7192
7203
|
}>;
|
|
7193
7204
|
interface OrderSearchSpec extends SearchSpec {
|
|
@@ -7342,7 +7353,7 @@ type OrderSearch = {
|
|
|
7342
7353
|
* @returns Newly created order.
|
|
7343
7354
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
7344
7355
|
*/
|
|
7345
|
-
declare function createOrder(order: NonNullablePaths<Order, `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 5>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.
|
|
7356
|
+
declare function createOrder(order: NonNullablePaths<Order, `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 5>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
7346
7357
|
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
7347
7358
|
}>;
|
|
7348
7359
|
interface CreateOrderOptions {
|
|
@@ -7385,7 +7396,7 @@ interface CreateOrderOptions {
|
|
|
7385
7396
|
* @returns Newly created order.
|
|
7386
7397
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
7387
7398
|
*/
|
|
7388
|
-
declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.
|
|
7399
|
+
declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`, 6> & {
|
|
7389
7400
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
7390
7401
|
}>;
|
|
7391
7402
|
interface UpdateOrder {
|
|
@@ -7534,10 +7545,10 @@ interface UpdateOrder {
|
|
|
7534
7545
|
*/
|
|
7535
7546
|
purchaseFlowId?: string | null;
|
|
7536
7547
|
/**
|
|
7537
|
-
*
|
|
7548
|
+
* Final recipient's address and contact details.
|
|
7538
7549
|
*
|
|
7539
|
-
* This field
|
|
7540
|
-
* + The chosen shipping option is pickup point or store pickup.
|
|
7550
|
+
* This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when:
|
|
7551
|
+
* + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location.
|
|
7541
7552
|
* + No shipping option is selected.
|
|
7542
7553
|
*/
|
|
7543
7554
|
recipientInfo?: AddressWithContact;
|
|
@@ -7626,6 +7637,7 @@ interface UpdateOrderLineItem {
|
|
|
7626
7637
|
_id?: string;
|
|
7627
7638
|
/**
|
|
7628
7639
|
* Item name.
|
|
7640
|
+
*
|
|
7629
7641
|
* + Stores - `product.name`
|
|
7630
7642
|
* + Bookings - `service.info.name`
|
|
7631
7643
|
* + Events - `ticket.name`
|
|
@@ -7752,11 +7764,8 @@ interface UpdateOrderLineItem {
|
|
|
7752
7764
|
/**
|
|
7753
7765
|
* Adds up to 300 activities to an order in a single request.
|
|
7754
7766
|
*
|
|
7755
|
-
*
|
|
7756
|
-
*
|
|
7757
|
-
* + Order lifecycle events, such as order placement, payment confirmation, and fulfillment.
|
|
7758
|
-
* + Payment processing statuses and events, such as payment authorization, refunds, and captures.
|
|
7759
|
-
* + Order operations, customer communications, and other order-related actions.
|
|
7767
|
+
*
|
|
7768
|
+
* An order activity is a record of an action taken on an order. Use this endpoint to add merchant comments or record order-related events.
|
|
7760
7769
|
* @param orderId - ID of the order to add activities to.
|
|
7761
7770
|
* @public
|
|
7762
7771
|
* @documentationMaturity preview
|
|
@@ -7766,7 +7775,7 @@ interface UpdateOrderLineItem {
|
|
|
7766
7775
|
* @applicableIdentity APP
|
|
7767
7776
|
* @fqn com.wix.ecom.orders.v1.Orders.AddActivities
|
|
7768
7777
|
*/
|
|
7769
|
-
declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`, 4>): Promise<NonNullablePaths<AddActivitiesResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.
|
|
7778
|
+
declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`, 4>): Promise<NonNullablePaths<AddActivitiesResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `activityIds`, 7>>;
|
|
7770
7779
|
interface AddActivitiesOptions {
|
|
7771
7780
|
/**
|
|
7772
7781
|
* Activities to add to the order.
|
|
@@ -7812,7 +7821,7 @@ interface DeleteActivityIdentifiers {
|
|
|
7812
7821
|
* @applicableIdentity APP
|
|
7813
7822
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
7814
7823
|
*/
|
|
7815
|
-
declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.
|
|
7824
|
+
declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name`, 7> & {
|
|
7816
7825
|
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
7817
7826
|
}>;
|
|
7818
7827
|
interface CancelOrderOptions {
|