@wix/auto_sdk_ecom_orders 1.0.295 → 1.0.297
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-DlLhZyNg.d.ts → ecom-v1-order-orders.universal-bwI02x7H.d.ts} +15 -18
- package/build/cjs/index.d.ts +17 -17
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-DlLhZyNg.d.mts → ecom-v1-order-orders.universal-bwI02x7H.d.mts} +15 -18
- package/build/es/index.d.mts +17 -17
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +2 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DwXimT2J.d.ts → ecom-v1-order-orders.universal-Dc35C-D8.d.ts} +27 -30
- package/build/internal/cjs/index.d.ts +29 -29
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +2 -5
- package/build/internal/es/{ecom-v1-order-orders.universal-DwXimT2J.d.mts → ecom-v1-order-orders.universal-Dc35C-D8.d.mts} +27 -30
- package/build/internal/es/index.d.mts +29 -29
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +2 -5
- package/package.json +2 -2
|
@@ -728,10 +728,7 @@ interface SubscriptionInfo {
|
|
|
728
728
|
* @targetRemovalDate 2025-10-01
|
|
729
729
|
*/
|
|
730
730
|
subscriptionOptionDescription?: string | null;
|
|
731
|
-
/**
|
|
732
|
-
* Subscription detailed information.
|
|
733
|
-
* @immutable
|
|
734
|
-
*/
|
|
731
|
+
/** Subscription detailed information. */
|
|
735
732
|
subscriptionSettings?: SubscriptionSettings;
|
|
736
733
|
/**
|
|
737
734
|
* Description of the charges that will be applied for subscription.
|
|
@@ -8382,7 +8379,7 @@ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void |
|
|
|
8382
8379
|
* @applicableIdentity APP
|
|
8383
8380
|
* @fqn com.wix.ecom.orders.importer.v1.OrderImports.ImportOrder
|
|
8384
8381
|
*/
|
|
8385
|
-
declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `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` | `paymentStatus` | `priceSummary` | `status`,
|
|
8382
|
+
declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `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` | `paymentStatus` | `priceSummary` | `status`, 3>): Promise<NonNullablePaths<ImportOrderResponse, `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.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `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.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 5> & {
|
|
8386
8383
|
__applicationErrorsType?: ImportOrderApplicationErrors;
|
|
8387
8384
|
}>;
|
|
8388
8385
|
/**
|
|
@@ -8401,7 +8398,7 @@ declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contact
|
|
|
8401
8398
|
* @applicableIdentity APP
|
|
8402
8399
|
* @fqn com.wix.ecom.orders.importer.v1.OrderImports.SetOrderNumberCounter
|
|
8403
8400
|
*/
|
|
8404
|
-
declare function setOrderNumberCounter(counter: string, options?: SetOrderNumberCounterOptions): Promise<NonNullablePaths<SetOrderNumberCounterResponse, `oldCounter` | `newCounter`,
|
|
8401
|
+
declare function setOrderNumberCounter(counter: string, options?: SetOrderNumberCounterOptions): Promise<NonNullablePaths<SetOrderNumberCounterResponse, `oldCounter` | `newCounter`, 0> & {
|
|
8405
8402
|
__applicationErrorsType?: SetOrderNumberCounterApplicationErrors;
|
|
8406
8403
|
}>;
|
|
8407
8404
|
interface SetOrderNumberCounterOptions {
|
|
@@ -8428,7 +8425,7 @@ interface SetOrderNumberCounterOptions {
|
|
|
8428
8425
|
* @applicableIdentity APP
|
|
8429
8426
|
* @fqn com.wix.ecom.orders.importer.v1.OrderImports.BulkDeleteImportedOrders
|
|
8430
8427
|
*/
|
|
8431
|
-
declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullablePaths<BulkDeleteImportedOrdersResponse, `jobId`,
|
|
8428
|
+
declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullablePaths<BulkDeleteImportedOrdersResponse, `jobId`, 0>>;
|
|
8432
8429
|
/**
|
|
8433
8430
|
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
8434
8431
|
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
@@ -8445,7 +8442,7 @@ declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullab
|
|
|
8445
8442
|
* @applicableIdentity APP
|
|
8446
8443
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
8447
8444
|
*/
|
|
8448
|
-
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`,
|
|
8445
|
+
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`, 0> & {
|
|
8449
8446
|
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
8450
8447
|
}>;
|
|
8451
8448
|
interface PreparePaymentCollectionOptions {
|
|
@@ -8479,7 +8476,7 @@ interface PreparePaymentCollectionOptions {
|
|
|
8479
8476
|
* @applicableIdentity APP
|
|
8480
8477
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
8481
8478
|
*/
|
|
8482
|
-
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`,
|
|
8479
|
+
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`, 1>>;
|
|
8483
8480
|
interface RecordManuallyCollectedPaymentOptions {
|
|
8484
8481
|
}
|
|
8485
8482
|
interface PaymentCollectionMarkOrderAsPaidOptions {
|
|
@@ -8515,7 +8512,7 @@ interface TriggerRefundOptions {
|
|
|
8515
8512
|
* @applicableIdentity APP
|
|
8516
8513
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
8517
8514
|
*/
|
|
8518
|
-
declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`,
|
|
8515
|
+
declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 5> & {
|
|
8519
8516
|
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
8520
8517
|
}>;
|
|
8521
8518
|
/**
|
|
@@ -8532,7 +8529,7 @@ declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[
|
|
|
8532
8529
|
* @applicableIdentity APP
|
|
8533
8530
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
8534
8531
|
*/
|
|
8535
|
-
declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`,
|
|
8532
|
+
declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`, 0>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 5> & {
|
|
8536
8533
|
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
8537
8534
|
}>;
|
|
8538
8535
|
/**
|
|
@@ -8551,7 +8548,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
|
|
|
8551
8548
|
* @returns Fulfilled - The requested order.
|
|
8552
8549
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
8553
8550
|
*/
|
|
8554
|
-
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` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `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` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`,
|
|
8551
|
+
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` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `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` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
|
|
8555
8552
|
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
8556
8553
|
}>;
|
|
8557
8554
|
interface OrderSearchSpec extends SearchSpec {
|
|
@@ -8719,7 +8716,7 @@ declare const utils: {
|
|
|
8719
8716
|
* @returns Newly created order.
|
|
8720
8717
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
8721
8718
|
*/
|
|
8722
|
-
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`,
|
|
8719
|
+
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`, 3>, 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` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `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` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
|
|
8723
8720
|
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
8724
8721
|
}>;
|
|
8725
8722
|
interface CreateOrderOptions {
|
|
@@ -8762,7 +8759,7 @@ interface CreateOrderOptions {
|
|
|
8762
8759
|
* @returns Newly created order.
|
|
8763
8760
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
8764
8761
|
*/
|
|
8765
|
-
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` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `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` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`,
|
|
8762
|
+
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` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `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` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
|
|
8766
8763
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
8767
8764
|
}>;
|
|
8768
8765
|
interface UpdateOrder {
|
|
@@ -8999,7 +8996,7 @@ interface UpdateOrder {
|
|
|
8999
8996
|
* @applicableIdentity APP
|
|
9000
8997
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
9001
8998
|
*/
|
|
9002
|
-
declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`,
|
|
8999
|
+
declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`, 1>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.number` | `results.${number}.item.buyerInfo.visitorId` | `results.${number}.item.buyerInfo.memberId` | `results.${number}.item.paymentStatus` | `results.${number}.item.fulfillmentStatus` | `results.${number}.item.weightUnit` | `results.${number}.item.taxIncludedInPrices` | `results.${number}.item.shippingInfo.title` | `results.${number}.item.status` | `results.${number}.item.attributionSource` | `results.${number}.item.createdBy.userId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.visitorId` | `results.${number}.item.createdBy.appId` | `results.${number}.item.channelInfo.type` | `results.${number}.item.businessLocation._id` | `results.${number}.item.businessLocation.name` | `results.${number}.item.imported` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
9003
9000
|
interface BulkUpdateOrdersOptions {
|
|
9004
9001
|
/**
|
|
9005
9002
|
* Whether to return the full order entities.
|
|
@@ -9184,7 +9181,7 @@ interface UpdateOrderLineItem {
|
|
|
9184
9181
|
* @applicableIdentity APP
|
|
9185
9182
|
* @fqn com.wix.ecom.orders.v1.Orders.AddActivities
|
|
9186
9183
|
*/
|
|
9187
|
-
declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`,
|
|
9184
|
+
declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`, 2>): 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.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `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.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported` | `activityIds`, 5>>;
|
|
9188
9185
|
interface AddActivitiesOptions {
|
|
9189
9186
|
/**
|
|
9190
9187
|
* Activities to add to the order.
|
|
@@ -9230,7 +9227,7 @@ interface DeleteActivityIdentifiers {
|
|
|
9230
9227
|
* @applicableIdentity APP
|
|
9231
9228
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
9232
9229
|
*/
|
|
9233
|
-
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.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `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.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`,
|
|
9230
|
+
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.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `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.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 5> & {
|
|
9234
9231
|
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
9235
9232
|
}>;
|
|
9236
9233
|
interface CancelOrderOptions {
|
|
@@ -9273,7 +9270,7 @@ interface AggregateOrdersOptions {
|
|
|
9273
9270
|
* @applicableIdentity APP
|
|
9274
9271
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
9275
9272
|
*/
|
|
9276
|
-
declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
9273
|
+
declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
9277
9274
|
interface BulkUpdateOrderTagsOptions {
|
|
9278
9275
|
/** Tags to be added to orders */
|
|
9279
9276
|
assignTags?: TagsTags;
|