@wix/auto_sdk_ecom_current-cart-v-2 1.0.237 → 1.0.239

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.
@@ -1137,8 +1137,7 @@ interface Group {
1137
1137
  /**
1138
1138
  * Details of a bundle: a single line item made up of one or more catalog items.
1139
1139
  * The bundle occupies one line item, and `quantityInfo` counts bundle units rather than
1140
- * individual bundled items. The line item carries the prices for the whole bundle, and each
1141
- * bundled item's `pricing` carries that item's own prices, for its `quantity` in one bundle.
1140
+ * individual bundled items. The line item carries the prices for the whole bundle.
1142
1141
  */
1143
1142
  interface BundleInfo {
1144
1143
  /**
@@ -1181,11 +1180,6 @@ interface BundledItem {
1181
1180
  * @maxSize 25
1182
1181
  */
1183
1182
  modifierGroups?: ModifierGroup[];
1184
- /**
1185
- * Pricing details for the bundled item, for its `quantity` in a single bundle.
1186
- * Not multiplied by the line item's `quantityInfo.confirmedQuantity`.
1187
- */
1188
- pricing?: ItemPricingInfo;
1189
1183
  }
1190
1184
  interface BundledItemSource {
1191
1185
  /** Catalog and item reference of the bundled item. */
@@ -2956,711 +2950,818 @@ interface CartCompleted {
2956
2950
  /** The completed cart. */
2957
2951
  cart?: Cart;
2958
2952
  }
2959
- interface CreateCartRequest {
2960
- /** Cart to create. */
2953
+ /**
2954
+ * Triggered asynchronously after a cart mutation, once the cart has been calculated for the
2955
+ * legacy bridge. Carries the full CalculateCartForV1 output so checkout-v1-proxy maps to the
2956
+ * legacy Checkout V1 domain events without recalculating.
2957
+ *
2958
+ * Deletes aren't bridged: they need no calculation and stay on the raw cart-v2 Deleted event.
2959
+ */
2960
+ interface CartBridgeCalculated {
2961
+ /** Mutation that produced this event. */
2962
+ action?: BridgeActionWithLiterals;
2963
+ /** The updated cart checkout-v1-proxy maps from (pre-override entity, as CalculateCartForV1 returns it). */
2961
2964
  cart?: Cart;
2962
2965
  /**
2963
- * Catalog items to add to the cart.
2964
- * @maxSize 300
2966
+ * The cart as it was immediately before this mutation.
2967
+ *
2968
+ * Available only for `UPDATED` actions.
2965
2969
  */
2966
- catalogItems?: CatalogItemInput[];
2970
+ previousCart?: Cart;
2971
+ /** The calculation summary. */
2972
+ summary?: CartSummary;
2973
+ /** Totals payload used for backward compatibility with legacy clients. */
2974
+ totalsResponse?: CalculateTotalsResponse;
2967
2975
  /**
2968
- * Custom items to add to the cart.
2969
- * Custom line items don't trigger the Catalog service plugin.
2970
- * @maxSize 300
2976
+ * Business violations in the legacy model, carried for the legacy bridge.
2977
+ *
2978
+ * Deprecated. Use `summary.violations` instead.
2979
+ * @maxSize 100
2971
2980
  */
2972
- customItems?: CustomItemInput[];
2981
+ spiViolations?: Violation[];
2982
+ /** Cart revision these calculations were produced against. */
2983
+ calculatedRevision?: string;
2984
+ }
2985
+ /** The kind of mutation that produced a CartBridgeCalculated event. */
2986
+ declare enum BridgeAction {
2987
+ UNKNOWN_BRIDGE_ACTION = "UNKNOWN_BRIDGE_ACTION",
2988
+ /** A cart was created. */
2989
+ CREATED = "CREATED",
2990
+ /** A cart was updated. */
2991
+ UPDATED = "UPDATED",
2992
+ /** A cart transitioned to order-placed. */
2993
+ COMPLETED = "COMPLETED"
2994
+ }
2995
+ /** @enumType */
2996
+ type BridgeActionWithLiterals = BridgeAction | 'UNKNOWN_BRIDGE_ACTION' | 'CREATED' | 'UPDATED' | 'COMPLETED';
2997
+ interface CalculateTotalsResponse {
2998
+ /** Calculate line items. */
2999
+ calculatedLineItems?: CalculatedLineItem[];
3000
+ /** Price summary. */
3001
+ priceSummary?: V1PriceSummary;
2973
3002
  /**
2974
- * Coupons to apply.
2975
- * Currently only one is supported.
2976
- * @maxSize 1
3003
+ * DEPRECATED: Use gift_cards instead.
3004
+ * @deprecated DEPRECATED: Use gift_cards instead.
3005
+ * @replacedBy gift_cards
3006
+ * @targetRemovalDate 2026-12-01
2977
3007
  */
2978
- coupons?: CouponInput[];
2979
- /** Delivery method to set. */
2980
- deliveryMethod?: DeliveryMethodInput;
3008
+ giftCard?: GiftCard;
3009
+ /** Tax summary. */
3010
+ taxSummary?: TaxSummary;
3011
+ /** Shipping information. */
3012
+ shippingInfo?: ShippingInformation;
2981
3013
  /**
2982
- * Gift cards to add.
2983
- * @maxSize 5
3014
+ * Applied discounts.
3015
+ * @maxSize 320
2984
3016
  */
2985
- giftCards?: GiftCardInput[];
2986
- }
2987
- interface CatalogItemInput {
2988
- /** Reference to the catalog item. */
2989
- catalogReference?: CatalogReference;
3017
+ appliedDiscounts?: AppliedDiscount[];
3018
+ /** Calculation errors. */
3019
+ calculationErrors?: CalculationErrors;
3020
+ /** Weight unit. */
3021
+ weightUnit?: WeightUnitWithLiterals;
2990
3022
  /**
2991
- * Number of catalog items the customer requested.
2992
- * @min 1
2993
- * @max 100000
3023
+ * The currency the price calculations were performed in.
3024
+ * This is the business’s default currency: the base currency configured for the site, which remains constant regardless of the [customer’s currency selection](https://support.wix.com/en/article/multicurrency-an-overview).
3025
+ * When `amountCurrency` is specified on the request, this returns that value instead.
3026
+ * @format CURRENCY
2994
3027
  */
2995
- quantity?: number;
3028
+ currency?: string;
2996
3029
  /**
2997
- * Selected membership used as payment for this item.
2998
- *
2999
- * DEPRECATED: migrate to `membershipPayment`. Removed once all clients migrate.
3000
- * @deprecated
3001
- * @replacedBy membership_payment
3002
- * @targetRemovalDate 2026-06-22
3030
+ * The currency the converted price calculations are in.
3031
+ * This is the currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview), which may differ from `currency`.
3032
+ * When `amountCurrency` is specified on the request, nothing is converted and this returns that value.
3033
+ * @readonly
3034
+ * @format CURRENCY
3003
3035
  */
3004
- selectedMembership?: V2SelectedMembership;
3005
- /** Overriding values for catalog item properties. */
3006
- catalogOverrideFields?: CatalogOverrideFields;
3036
+ conversionCurrency?: string;
3037
+ /** Whether tax is included in price. */
3038
+ taxIncludedInPrice?: boolean;
3007
3039
  /**
3008
- * Custom extended fields for the line item object.
3009
- *
3010
- * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the Checkout & Orders - Line Items Schema Plugin in the app dashboard before they can be accessed with API calls.
3040
+ * Minimal amount to pay in order to place the order.
3041
+ * @readonly
3011
3042
  */
3012
- extendedFields?: ExtendedFields;
3043
+ payNow?: V1PriceSummary;
3013
3044
  /**
3014
- * ID of the app managing inventory.
3015
- * @format GUID
3045
+ * Remaining amount for the order to be fully paid.
3046
+ * @readonly
3016
3047
  */
3017
- inventoryAppId?: string | null;
3048
+ payLater?: V1PriceSummary;
3049
+ /** Information about valid and invalid memberships, and which ones are selected for usage. */
3050
+ membershipOptions?: MembershipOptions;
3018
3051
  /**
3019
- * Membership used as payment for this item. Can be an existing membership, or a future one
3020
- * created from a plan in the same cart.
3021
- *
3022
- * Replaces `selectedMembership`.
3023
- *
3024
- * Use with `paymentOption` `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
3052
+ * Additional Fees
3053
+ * @maxSize 100
3025
3054
  */
3026
- membershipPayment?: MembershipInput;
3027
- }
3028
- interface MembershipInput extends MembershipInputMembershipOneOf {
3029
- /** Pay with an existing, already-provisioned membership. */
3030
- existingMembership?: ExistingMembershipInput;
3031
- /** Pay with a future membership, created once a plan in this cart is purchased. */
3032
- futureMembership?: FutureMembershipInput;
3033
- }
3034
- /** @oneof */
3035
- interface MembershipInputMembershipOneOf {
3036
- /** Pay with an existing, already-provisioned membership. */
3037
- existingMembership?: ExistingMembershipInput;
3038
- /** Pay with a future membership, created once a plan in this cart is purchased. */
3039
- futureMembership?: FutureMembershipInput;
3040
- }
3041
- interface ExistingMembershipInput {
3055
+ additionalFees?: AdditionalFee[];
3042
3056
  /**
3043
- * ID of the app providing the membership, for example Pricing Plans.
3044
- * @format GUID
3057
+ * The rate used when converting from the site currency to the checkout currency.
3058
+ * @readonly
3059
+ * @decimalValue options { gt:0, lte:1000000000000000 }
3045
3060
  */
3046
- appId?: string;
3061
+ checkoutConversionRate?: string | null;
3047
3062
  /**
3048
- * ID of the existing membership.
3049
- * @minLength 1
3050
- * @maxLength 200
3063
+ * The pay now total amount after all gift cards are applied.
3064
+ * @readonly
3051
3065
  */
3052
- membershipId?: string;
3053
- }
3054
- interface FutureMembershipInput {
3066
+ payNowTotalAfterGiftCard?: MultiCurrencyPrice;
3055
3067
  /**
3056
- * ID of the plan line item, already in the cart, whose future membership pays for this item.
3057
- * Add the plan line item to the cart first, then reference it by its ID.
3058
- * @format GUID
3068
+ * The total amount after all gift cards are applied.
3069
+ * @readonly
3059
3070
  */
3060
- lineItemId?: string;
3071
+ totalAfterGiftCard?: MultiCurrencyPrice;
3061
3072
  /**
3062
- * The selected unit within the plan to redeem.
3063
- * @maxLength 200
3073
+ * Payment for subscriptions after free trial period.
3074
+ * @readonly
3064
3075
  */
3065
- benefitId?: string;
3076
+ payAfterFreeTrial?: V1PriceSummary;
3066
3077
  }
3067
- interface CustomItemInput {
3068
- /** Display name for the line item. */
3069
- name?: TranslatableString;
3070
- /** Quantity details for the line item. */
3071
- quantityInfo?: CustomItemQuantityInfo;
3072
- /** Pricing details for the line item. */
3073
- pricing?: CustomItemPricingInfo;
3074
- /** Information about the line item's origin. */
3075
- source?: CustomItemSource;
3076
- /** Display details for the item. */
3077
- attributes?: CustomItemAttributes;
3078
- /** Delivery configuration for the line item. */
3079
- deliveryConfig?: CustomItemDeliveryConfig;
3080
- /** Tax configuration for the line item. */
3081
- taxConfig?: CustomItemTaxConfig;
3082
- /** Payment configuration for the line item. */
3083
- paymentConfig?: CustomItemPaymentConfig;
3078
+ interface CalculatedLineItem {
3079
+ /** Line item ID. */
3080
+ lineItemId?: string;
3081
+ /** Price breakdown for this line item. */
3082
+ pricesBreakdown?: LineItemPricesData;
3084
3083
  /**
3085
- * Modifier groups added to the item.
3086
- * @maxSize 25
3084
+ * Type of selected payment option for current item. Supported values:
3085
+ * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item will happen as part of the checkout
3086
+ * + `"FULL_PAYMENT_OFFLINE"` - The entire payment for this item will happen after the checkout
3087
+ * + `"MEMBERSHIP"` - This item cannot be paid via monetary payment options, only via non monetary option such membership. When this option is used, price must be set to 0
3088
+ * + `"DEPOSIT_ONLINE"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.
3087
3089
  */
3088
- modifierGroups?: ModifierGroup[];
3090
+ paymentOption?: PaymentOptionTypeWithLiterals;
3091
+ /** tax calculation address. */
3092
+ taxableAddress?: TaxableAddress;
3089
3093
  }
3090
- interface CustomItemQuantityInfo {
3094
+ interface LineItemPricesData {
3095
+ /** Total price after discounts, tax, and modifiers. */
3096
+ totalPriceAfterTax?: MultiCurrencyPrice;
3097
+ /** Total price after discounts and modifiers, and before tax. */
3098
+ totalPriceBeforeTax?: MultiCurrencyPrice;
3099
+ /** Tax details. */
3100
+ taxDetails?: ItemTaxFullDetails;
3101
+ /** Total discount applied for the line item. */
3102
+ totalDiscount?: MultiCurrencyPrice;
3103
+ /** Catalog price after catalog-defined discount, automatic discounts, and modifiers. */
3104
+ price?: MultiCurrencyPrice;
3091
3105
  /**
3092
- * Quantity the customer requested.
3093
- * @min 1
3094
- * @max 100000
3106
+ * Item price before automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
3107
+ * Defaults to `price` when not provided.
3095
3108
  */
3096
- requestedQuantity?: number;
3097
- /** Maximum quantity available for purchase. */
3098
- availableQuantity?: number | null;
3109
+ priceBeforeDiscounts?: MultiCurrencyPrice;
3110
+ /** Total line item price after catalog-defined discounts, automatic discounts, and modifiers. */
3111
+ lineItemPrice?: MultiCurrencyPrice;
3112
+ /** Catalog price before any discounts, with modifiers. */
3113
+ fullPrice?: MultiCurrencyPrice;
3114
+ /** Sum of all modifiers for a single unit of the item. */
3115
+ modifiers?: MultiCurrencyPrice;
3099
3116
  /**
3100
- * Whether the line item quantity is fixed and can't be changed.
3101
- *
3102
- * Default: `false`
3117
+ * Partial payment out of `price` to be paid upfront during the checkout.
3118
+ * Applies to catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
3103
3119
  */
3104
- fixedQuantity?: boolean;
3120
+ depositAmount?: MultiCurrencyPrice;
3105
3121
  }
3106
- interface CustomItemPricingInfo {
3122
+ interface ItemTaxFullDetails {
3123
+ /** Amount for which tax is calculated. */
3124
+ taxableAmount?: MultiCurrencyPrice;
3107
3125
  /**
3108
- * Sale price for a single item, without modifiers.
3109
- * Includes tax when `taxInfo.pricesIncludeTax` is true.
3126
+ * Tax rate %, as a decimal point between 0 and 1.
3127
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
3110
3128
  */
3111
- price?: ConvertedMoney;
3129
+ taxRate?: string;
3130
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
3131
+ totalTax?: MultiCurrencyPrice;
3112
3132
  /**
3113
- * Full price for a single item before discounts, without modifiers.
3114
- * Defaults to `price` when not provided.
3115
- * Includes tax when `taxInfo.pricesIncludeTax` is true.
3133
+ * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
3134
+ * @readonly
3135
+ * @deprecated
3116
3136
  */
3117
- fullPrice?: ConvertedMoney;
3137
+ rateBreakdown?: TaxRateBreakdown[];
3118
3138
  /**
3119
- * Additional price description.
3120
- * For example, when the price is `0` but you need more detail, such as "Starts at $67".
3139
+ * tax information for a line item.
3140
+ * @maxSize 1000
3141
+ * @readonly
3121
3142
  */
3122
- priceDescription?: PriceDescription;
3123
- /** Whether the price isn't yet defined and will be updated after the order is created. */
3124
- priceUndetermined?: boolean;
3143
+ taxBreakdown?: TaxBreakdown[];
3125
3144
  }
3126
- interface CustomItemSource {
3145
+ interface TaxRateBreakdown {
3127
3146
  /**
3128
- * Catalog and item reference: IDs for the item and catalog, plus optional details.
3129
- * Optional for custom line items, which don't trigger the Catalog service plugin.
3147
+ * Name of tax against which the calculation was performed.
3148
+ * @maxLength 100
3130
3149
  */
3131
- catalogReference?: CatalogReference;
3132
- /**
3133
- * When `catalogReference.catalogItemId` isn't the actual catalog item ID, this field returns the true catalog item ID.
3134
- * For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID, so this value is the service ID.
3135
- * In most cases, this matches `catalogReference.catalogItemId`.
3136
- * Used in membership validation.
3137
- * @minLength 1
3138
- * @maxLength 36
3139
- */
3140
- rootCatalogItemId?: string | null;
3150
+ name?: string;
3141
3151
  /**
3142
- * ID of the app managing inventory.
3143
- * @format GUID
3152
+ * Rate at which this tax detail was calculated.
3153
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
3144
3154
  */
3145
- inventoryAppId?: string | null;
3155
+ rate?: string;
3156
+ /** Amount of tax for this tax detail. */
3157
+ tax?: MultiCurrencyPrice;
3146
3158
  }
3147
- interface CustomItemAttributes {
3159
+ /**
3160
+ * TaxBreakdown represents tax information for a line item.
3161
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
3162
+ */
3163
+ interface TaxBreakdown {
3148
3164
  /**
3149
- * Description lines for the item.
3150
- * @maxSize 100
3165
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
3166
+ * @maxLength 200
3151
3167
  */
3152
- descriptionLines?: DescriptionLine[];
3153
- /** Item image. */
3154
- image?: Image;
3155
- /** URL of the item's page on the site. */
3156
- url?: PageUrlV2;
3157
- /** Item type: preset or custom. */
3158
- itemType?: ItemType;
3168
+ jurisdiction?: string | null;
3169
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
3170
+ nonTaxableAmount?: MultiCurrencyPrice;
3159
3171
  /**
3160
- * Physical properties of the item.
3161
- * When relevant, includes SKU, weight, and shippability.
3172
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
3173
+ * @decimalValue options { gte:0, maxScale:6 }
3162
3174
  */
3163
- physicalProperties?: PhysicalProperties;
3175
+ rate?: string | null;
3176
+ /** The amount of tax estimated for this line item. (Decimal value) */
3177
+ taxAmount?: MultiCurrencyPrice;
3178
+ /** The taxable amount of this line item. */
3179
+ taxableAmount?: MultiCurrencyPrice;
3164
3180
  /**
3165
- * Service properties.
3166
- * When relevant, includes date and number of participants.
3181
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
3182
+ * @maxLength 200
3167
3183
  */
3168
- serviceProperties?: ServiceProperties;
3184
+ taxType?: string | null;
3169
3185
  /**
3170
- * Whether the item can only be purchased by site members.
3171
- *
3172
- * Default: `false`
3186
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
3187
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
3188
+ * @maxLength 200
3173
3189
  */
3174
- membersOnly?: boolean;
3175
- /** Subscription option details. */
3176
- subscriptionInfo?: SubscriptionOptionInfo;
3190
+ taxName?: string | null;
3191
+ /** The type of the jurisdiction in which this tax detail applies. */
3192
+ jurisdictionType?: JurisdictionTypeWithLiterals;
3177
3193
  }
3178
- interface CustomItemDeliveryConfig {
3194
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3195
+ declare enum JurisdictionType {
3196
+ UNDEFINED = "UNDEFINED",
3197
+ COUNTRY = "COUNTRY",
3198
+ STATE = "STATE",
3199
+ COUNTY = "COUNTY",
3200
+ CITY = "CITY",
3201
+ SPECIAL = "SPECIAL"
3202
+ }
3203
+ /** @enumType */
3204
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
3205
+ /**
3206
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
3207
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
3208
+ *
3209
+ * The totals calculator form of `com.wix.ecommerce.platform_common.api.CrossBorderPriceAdjustment`: the same fields under the same numbers,
3210
+ * with the amounts as `MultiCurrencyPrice`. This record describes how the price was reached, not the resulting amount;
3211
+ * the repriced figures are on the line, shipping option or fee that carries it.
3212
+ */
3213
+ interface CrossBorderPriceAdjustment {
3179
3214
  /**
3180
- * Delivery profile ID.
3215
+ * ID of the tax region whose tax is built into the catalog prices.
3181
3216
  * @format GUID
3217
+ * @readonly
3182
3218
  */
3183
- deliveryProfileId?: string | null;
3184
- }
3185
- interface CustomItemTaxConfig {
3186
- /** Address used for tax calculation. */
3187
- taxableAddress?: TaxableAddress;
3219
+ baseTaxRegionId?: string;
3188
3220
  /**
3189
- * Tax group ID for this line item.
3190
- * @maxLength 50
3221
+ * ID of the tax region resolved for the destination. Absent when no region matched.
3222
+ * @format GUID
3223
+ * @readonly
3191
3224
  */
3192
- taxGroupId?: string | null;
3193
- }
3194
- interface CustomItemPaymentConfig {
3225
+ destinationTaxRegionId?: string | null;
3195
3226
  /**
3196
- * Partial payment due upfront during checkout.
3197
- * Only when `paymentOption` is `DEPOSIT_ONLINE`.
3227
+ * Price per unit as entered by the merchant, with the base region's tax inside it.
3228
+ * @readonly
3198
3229
  */
3199
- depositAmount?: ConvertedMoney;
3230
+ catalogPrice?: MultiCurrencyPrice;
3200
3231
  /**
3201
- * Selected payment option type for this item.
3202
- *
3203
- * Default: `FULL_PAYMENT_ONLINE`
3232
+ * Base region's tax removed per unit. Zero when `status` is `KEPT`, `SAME_REGION`, `SAME_COUNTRY`, `NOT_APPLICABLE`, `NOT_APPLICABLE_MODIFIERS` or `CONVERTED_CURRENCY_SUBSCRIPTION`, where nothing was removed.
3233
+ * @readonly
3204
3234
  */
3205
- paymentOption?: PaymentOptionTypeWithLiterals;
3206
- }
3207
- interface PlatformFee {
3208
- /** __Required.__ Platform fee name. */
3209
- name?: TranslatableString;
3210
- /** Platform fee charge type. */
3211
- chargeType?: V1PlatformFeeChargeTypeWithLiterals;
3235
+ baseTaxAmount?: MultiCurrencyPrice;
3212
3236
  /**
3213
- * Percentage rate charged as platform fee.
3214
- *
3215
- * The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
3216
- * @format DECIMAL_VALUE
3217
- * @decimalValue options { gt:0, lte:1, maxScale:4 }
3237
+ * Outcome of the repricing for this line.
3238
+ * @readonly
3218
3239
  */
3219
- percentageRate?: string;
3220
- }
3221
- declare enum V1PlatformFeeChargeType {
3222
- /** The platform fee is passed on to the customer. */
3223
- PASS_ON = "PASS_ON",
3224
- /** The platform fee is absorbed by the merchant. */
3225
- ABSORBED = "ABSORBED"
3226
- }
3227
- /** @enumType */
3228
- type V1PlatformFeeChargeTypeWithLiterals = V1PlatformFeeChargeType | 'PASS_ON' | 'ABSORBED';
3229
- interface CouponInput {
3240
+ status?: RepriceStatusWithLiterals;
3230
3241
  /**
3231
- * Coupon code.
3232
- * @minLength 1
3233
- * @maxLength 50
3242
+ * Where the base region's rate came from. Meaningful only when a rate was applied, that is when `status` is `APPLIED`, `STRIP_ONLY` or `NO_DESTINATION_REGION`.
3243
+ * @readonly
3234
3244
  */
3235
- code?: string;
3236
- }
3237
- interface DeliveryMethodInput {
3245
+ baseRateSource?: BaseRateSourceWithLiterals;
3238
3246
  /**
3239
- * Delivery method code.
3240
- * @maxLength 100
3247
+ * Base region's rate used to remove the tax, as a decimal numeral between 0 and 1. For example, `"0.22"`. Absent when no rate was applied.
3248
+ * @format DECIMAL_VALUE
3249
+ * @decimalValue options { gte:0, maxScale:6 }
3250
+ * @readonly
3241
3251
  */
3242
- code?: string;
3252
+ baseRate?: string | null;
3243
3253
  /**
3244
- * Carrier app id.
3245
- * @format GUID
3254
+ * When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`.
3255
+ * @readonly
3246
3256
  */
3247
- appId?: string | null;
3248
- }
3249
- interface GiftCardInput {
3257
+ baseRateCapturedDate?: Date | null;
3250
3258
  /**
3251
- * Gift card code.
3252
- * @minLength 8
3253
- * @maxLength 20
3259
+ * Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated.
3260
+ * @readonly
3254
3261
  */
3255
- code?: string;
3256
- /** The amount requested to redeem from this gift card. */
3257
- redeemAmount?: ConvertedMoney;
3262
+ destinationTaxIncluded?: boolean | null;
3258
3263
  }
3259
- interface CreateCartResponse {
3260
- /** Created cart. */
3261
- cart?: Cart;
3264
+ /** Outcome of the repricing for one line. */
3265
+ declare enum RepriceStatus {
3266
+ /** Base tax removed and the destination's tax applied. */
3267
+ APPLIED = "APPLIED",
3268
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
3269
+ KEPT = "KEPT",
3270
+ /** Base tax removed and no destination tax applied, as in a tax-exempt calculation. This is the outcome; the mode that asks for it is `CrossBorderRepricingMode.STRIP_ONLY`. */
3271
+ STRIP_ONLY = "STRIP_ONLY",
3272
+ /** The destination is the base region. Nothing was removed. */
3273
+ SAME_REGION = "SAME_REGION",
3274
+ /** The destination is in the base region's country, outside the US and Canada, so the catalog price already carries the destination's tax. Nothing was removed. */
3275
+ SAME_COUNTRY = "SAME_COUNTRY",
3276
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
3277
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
3278
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
3279
+ NOT_APPLICABLE = "NOT_APPLICABLE",
3280
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
3281
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
3282
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
3283
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
3262
3284
  }
3263
- interface ItemNotFoundInCatalogErrorData {
3264
- /**
3265
- * Line items missing from the catalog.
3266
- * @maxSize 300
3267
- */
3268
- invalidItems?: LineItemIdentifier[];
3285
+ /** @enumType */
3286
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
3287
+ /** Where the base region's rate came from. */
3288
+ declare enum BaseRateSource {
3289
+ /** The manual tax calculator computed the base tax for this calculation. */
3290
+ MANUAL_SPI = "MANUAL_SPI",
3291
+ /** The rate captured from Avalara by the embedded-rate probe. */
3292
+ AVALARA_PROBE = "AVALARA_PROBE"
3269
3293
  }
3270
- interface LineItemIdentifier extends LineItemIdentifierIdOneOf {
3294
+ /** @enumType */
3295
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
3296
+ interface CalculatedItemModifier {
3271
3297
  /**
3272
- * Line item ID.
3273
- * @format GUID
3298
+ * Modifier ID.
3299
+ * @minLength 1
3300
+ * @maxLength 36
3274
3301
  */
3275
- lineItemId?: string;
3276
- /** Catalog reference. */
3277
- catalogReference?: CatalogReference;
3278
- }
3279
- /** @oneof */
3280
- interface LineItemIdentifierIdOneOf {
3302
+ id?: string;
3281
3303
  /**
3282
- * Line item ID.
3283
- * @format GUID
3304
+ * ID of the group this modifier belongs to.
3305
+ * @minLength 1
3306
+ * @maxLength 36
3284
3307
  */
3285
- lineItemId?: string;
3286
- /** Catalog reference. */
3287
- catalogReference?: CatalogReference;
3288
- }
3289
- interface InsufficientInventoryErrorData {
3308
+ groupId?: string;
3290
3309
  /**
3291
- * Line items that don't have enough inventory.
3292
- * @maxSize 300
3310
+ * Modifier price.
3311
+ * @readonly
3293
3312
  */
3294
- invalidItems?: InsufficientInventoryEntry[];
3313
+ price?: MultiCurrencyPrice;
3295
3314
  }
3296
- interface InsufficientInventoryEntry {
3297
- /**
3298
- * Line item whose requested quantity exceeds the quantity available.
3299
- *
3300
- * Identified by `catalogReference` when the line item has one, otherwise by `lineItemId`.
3301
- * For Create Cart and Add Line Items, and their Current Cart equivalents, `lineItemId` is
3302
- * provisional: the request is rejected before the new line items are saved, so the ID doesn't
3303
- * match any line item you can retrieve.
3304
- */
3305
- id?: LineItemIdentifier;
3306
- /** Requested quantity, including what's already on the cart. */
3307
- requestedQuantity?: number;
3315
+ interface V1PriceSummary {
3316
+ /** Subtotal of all line items, before discounts and before tax. */
3317
+ subtotal?: MultiCurrencyPrice;
3318
+ /** Total shipping price, before discounts and before tax. */
3319
+ shipping?: MultiCurrencyPrice;
3320
+ /** Total tax. */
3321
+ tax?: MultiCurrencyPrice;
3322
+ /** Total calculated discount value. */
3323
+ discount?: MultiCurrencyPrice;
3324
+ /** Total price after discounts, gift cards, and tax. */
3325
+ total?: MultiCurrencyPrice;
3326
+ /** Total additional fees price before tax. */
3327
+ additionalFees?: MultiCurrencyPrice;
3328
+ }
3329
+ interface GiftCard {
3308
3330
  /**
3309
- * Quantity available.
3310
- * For a custom line item, the value set in `quantityInfo.availableQuantity`.
3331
+ * Gift Card ID.
3332
+ * @deprecated
3311
3333
  */
3312
- availableQuantity?: number;
3313
- }
3314
- interface MaxLineItemsExceededErrorData {
3315
- /** Line item count in the request. */
3316
- requestCount?: number;
3317
- /** Maximum line items allowed. */
3318
- maxCount?: number;
3319
- }
3320
- interface MaxItemModifiersExceededErrorData {
3321
- /** Modifier count in the request. */
3322
- requestCount?: number;
3323
- /** Maximum modifiers allowed. */
3324
- maxCount?: number;
3325
- }
3326
- interface DuplicateModifierGroupIdsErrorData {
3334
+ id?: string;
3335
+ /** Gift card obfuscated code. */
3336
+ obfuscatedCode?: string;
3337
+ /** Actual amount to be redeemed from the gift card. */
3338
+ amount?: MultiCurrencyPrice;
3327
3339
  /**
3328
- * Catalog items whose modifier group IDs collide.
3329
- * @maxSize 300
3340
+ * App ID of the gift card provider.
3341
+ * @format GUID
3330
3342
  */
3331
- invalidItems?: CatalogReference[];
3332
- }
3333
- interface DuplicateItemModifierIdsErrorData {
3343
+ appId?: string;
3334
3344
  /**
3335
- * Catalog items with duplicate modifier IDs in a group.
3336
- * @maxSize 300
3345
+ * External ID in the gift card provider's system.
3346
+ * Used for integration and tracking across different platforms.
3347
+ * @minLength 1
3348
+ * @maxLength 50
3337
3349
  */
3338
- invalidItems?: CatalogReference[];
3350
+ externalId?: string | null;
3351
+ /** Requested amount to redeem from the gift card. */
3352
+ requestedAmount?: MultiCurrencyPrice;
3339
3353
  }
3340
- interface LineItemPriceConflictErrorData {
3354
+ interface TaxSummary {
3341
3355
  /**
3342
- * Catalog items whose price no longer matches, when present.
3343
- * @maxSize 300
3356
+ * Amount for which tax is calculated, added from line items.
3357
+ * @readonly
3344
3358
  */
3345
- invalidItems?: CatalogReference[];
3346
- }
3347
- interface FixedQuantityItemErrorData {
3359
+ taxableAmount?: MultiCurrencyPrice;
3348
3360
  /**
3349
- * Line items that don't allow quantity changes.
3350
- * @maxSize 300
3361
+ * Calculated tax, added from line items.
3362
+ * @readonly
3351
3363
  */
3352
- invalidItems?: LineItemIdentifier[];
3353
- }
3354
- interface InvalidMembershipPaymentOptionErrorData {
3364
+ totalTax?: MultiCurrencyPrice;
3355
3365
  /**
3356
- * Line items with invalid membership payments.
3357
- * @maxSize 300
3366
+ * Tax calculator that was active when the order was created.
3367
+ * @deprecated
3358
3368
  */
3359
- invalidItems?: InvalidMembershipEntry[];
3369
+ calculationDetails?: TaxCalculationDetails;
3360
3370
  }
3361
- interface InvalidMembershipEntry {
3362
- /** Line item with an invalid membership payment choice. */
3363
- invalidItemId?: LineItemIdentifier;
3364
- /** Membership the buyer tried to use. */
3365
- selectedMembership?: V2SelectedMembership;
3371
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
3372
+ /** Reason the manual calculation was used. */
3373
+ manualRateReason?: ManualCalculationReasonWithLiterals;
3374
+ /** Details of the fallback rate calculation. */
3375
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
3376
+ /** Rate calculation type. */
3377
+ rateType?: RateTypeWithLiterals;
3366
3378
  }
3367
- interface LineItemNotFoundInCartErrorData {
3368
- /**
3369
- * Line item IDs that aren't in the cart.
3370
- * @format GUID
3371
- * @maxSize 300
3372
- */
3373
- lineItemIds?: string[];
3379
+ /** @oneof */
3380
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
3381
+ /** Reason the manual calculation was used. */
3382
+ manualRateReason?: ManualCalculationReasonWithLiterals;
3383
+ /** Details of the fallback rate calculation. */
3384
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
3374
3385
  }
3375
- interface DeliveryMethodNotFoundErrorData {
3386
+ declare enum RateType {
3387
+ /** no tax being collected for this request due to location of purchase */
3388
+ NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
3389
+ /** manual rate used for calculation */
3390
+ MANUAL_RATE = "MANUAL_RATE",
3391
+ /** autotax rate used for calculation */
3392
+ AUTO_RATE = "AUTO_RATE",
3393
+ /** fallback rate used for calculation */
3394
+ FALLBACK_RATE = "FALLBACK_RATE"
3395
+ }
3396
+ /** @enumType */
3397
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
3398
+ declare enum ManualCalculationReason {
3399
+ /** user set calculator in Business Manager to be Manual */
3400
+ GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
3401
+ /** specific region is on manual even though Global setting is Auto-tax */
3402
+ REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
3403
+ }
3404
+ /** @enumType */
3405
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
3406
+ interface AutoTaxFallbackCalculationDetails {
3407
+ /** reason for fallback */
3408
+ fallbackReason?: FallbackReasonWithLiterals;
3409
+ /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
3410
+ error?: ApplicationError;
3411
+ }
3412
+ declare enum FallbackReason {
3413
+ /** auto-tax failed to be calculated */
3414
+ AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
3415
+ /** auto-tax was temporarily deactivated on a system-level */
3416
+ AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
3417
+ }
3418
+ /** @enumType */
3419
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
3420
+ /**
3421
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
3422
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
3423
+ */
3424
+ interface AggregatedTaxBreakdown {
3376
3425
  /**
3377
- * Missing delivery method code.
3378
- * @maxLength 100
3426
+ * The name of the tax against which this tax amount was calculated.
3427
+ * @maxLength 200
3379
3428
  */
3380
- code?: string;
3429
+ taxName?: string;
3381
3430
  /**
3382
- * Delivery method app ID, if applicable.
3383
- * @maxLength 100
3431
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
3432
+ * @maxLength 200
3384
3433
  */
3385
- appId?: string | null;
3386
- }
3387
- interface GetCartRequest {
3434
+ taxType?: string;
3388
3435
  /**
3389
- * Cart ID.
3390
- * @format GUID
3436
+ * The name of the jurisdiction in which this tax detail applies.
3437
+ * @maxLength 200
3391
3438
  */
3392
- cartId?: string;
3393
- }
3394
- interface GetCartResponse {
3395
- /** Requested cart. */
3396
- cart?: Cart;
3397
- }
3398
- interface GetUpsellOptionsRequest {
3439
+ jurisdiction?: string;
3440
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3441
+ jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
3399
3442
  /**
3400
- * Cart ID.
3401
- * @format GUID
3443
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
3444
+ * @decimalValue options { gte:0, maxScale:6 }
3402
3445
  */
3403
- cartId?: string;
3446
+ rate?: string;
3447
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
3448
+ aggregatedTaxAmount?: MultiCurrencyPrice;
3449
+ /** The sum of all the taxable amount from line items for tax identifiers. */
3450
+ aggregatedTaxableAmount?: MultiCurrencyPrice;
3404
3451
  }
3405
- interface GetUpsellOptionsResponse {
3406
- /** Upsell options available for the cart's line items. */
3407
- itemsUpsells?: ItemUpsells[];
3452
+ interface ShippingInformation {
3453
+ /** Shipping region. */
3454
+ region?: ShippingRegion;
3455
+ /** Selected shipping option. */
3456
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption;
3457
+ /** All shipping options. */
3458
+ carrierServiceOptions?: CarrierServiceOption[];
3408
3459
  }
3409
- interface ItemUpsells {
3460
+ interface ShippingRegion {
3410
3461
  /**
3411
- * Line item ID.
3462
+ * Shipping region ID.
3412
3463
  * @format GUID
3464
+ * @readonly
3413
3465
  */
3414
- lineItemId?: string;
3466
+ id?: string;
3415
3467
  /**
3416
- * Upsell options available for the line item.
3417
- * @maxSize 10
3468
+ * Shipping region name.
3469
+ * @maxLength 100
3418
3470
  */
3419
- upsells?: UpsellOption[];
3471
+ name?: string;
3420
3472
  }
3421
- /**
3422
- * A single upsell offer for a line item.
3423
- * Accepting it replaces the line item's catalog reference in place, keeping the same lineItemId.
3424
- */
3425
- interface UpsellOption {
3473
+ interface SelectedCarrierServiceOption {
3426
3474
  /**
3427
- * Upsell option ID.
3428
- * @format GUID
3475
+ * Unique identifier of selected option. For example, "usps_std_overnight".
3476
+ * @maxLength 100
3429
3477
  */
3430
- id?: string;
3478
+ code?: string;
3431
3479
  /**
3432
- * Title of the upsell option.
3433
- * @maxLength 200
3480
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3481
+ * For example, "Standard" or "First-Class Package International".
3482
+ * @maxLength 250
3483
+ * @readonly
3434
3484
  */
3435
- title?: string | null;
3485
+ title?: string;
3436
3486
  /**
3437
- * Description of the upsell option.
3438
- * @maxLength 500
3487
+ * Delivery logistics.
3488
+ * @readonly
3439
3489
  */
3440
- description?: string | null;
3441
- /** Catalog reference of the item offered as an upsell to replace the existing one. */
3442
- catalogReference?: CatalogReference;
3443
- /** Metadata about the benefit of accepting this upsell option. */
3444
- metadata?: UpsellBenefitMetadata;
3445
- /** Price details of the upsell option. */
3446
- priceDetails?: PriceDetails;
3447
- }
3448
- interface UpsellBenefitMetadata {
3449
- /** Benefit type. */
3450
- benefitType?: BenefitTypeWithLiterals;
3490
+ logistics?: DeliveryLogistics;
3451
3491
  /**
3452
- * Benefit value. For percentage benefits, this is the percentage (e.g., "10" for 10%). For fixed amount/price benefits, this is the amount.
3453
- * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
3492
+ * Shipping costs.
3493
+ * @readonly
3454
3494
  */
3455
- benefitValue?: string | null;
3456
- }
3457
- declare enum BenefitType {
3458
- /** Percentage benefit. */
3459
- PERCENTAGE = "PERCENTAGE",
3460
- /** Fixed price benefit. */
3461
- FIXED_PRICE = "FIXED_PRICE",
3462
- /** Fixed amount benefit. */
3463
- FIXED_AMOUNT = "FIXED_AMOUNT"
3464
- }
3465
- /** @enumType */
3466
- type BenefitTypeWithLiterals = BenefitType | 'PERCENTAGE' | 'FIXED_PRICE' | 'FIXED_AMOUNT';
3467
- interface PriceDetails {
3468
- /** @decimalValue options { gte:0, lte:1000000000000000 } */
3469
- price?: string;
3470
- /** @maxLength 200 */
3471
- description?: string | null;
3472
- }
3473
- interface UpdateCartRequest {
3474
- /** Cart to update. May be partial. */
3475
- cart?: Cart;
3476
- }
3477
- interface UpdateCartResponse {
3478
- /** Updated cart. */
3479
- cart?: Cart;
3480
- }
3481
- interface CartAlreadyOrderedErrorData {
3495
+ cost?: SelectedCarrierServiceOptionPrices;
3482
3496
  /**
3483
- * Cart already turned into an order.
3484
- * @format GUID
3497
+ * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
3498
+ * @readonly
3485
3499
  */
3486
- cartId?: string;
3500
+ requestedShippingOption?: boolean;
3487
3501
  /**
3488
- * Matching order ID.
3489
- * @format GUID
3502
+ * Other charges
3503
+ * @deprecated Other charges
3504
+ * @replacedBy additional_fees
3505
+ * @targetRemovalDate 2025-10-01
3490
3506
  */
3491
- orderId?: string;
3492
- }
3493
- interface DeleteCartRequest {
3507
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
3494
3508
  /**
3495
- * Cart ID.
3509
+ * This carrier's unique ID
3496
3510
  * @format GUID
3497
3511
  */
3498
- cartId?: string;
3499
- }
3500
- interface DeleteCartResponse {
3501
- }
3502
- interface RefreshCartRequest {
3512
+ carrierId?: string | null;
3503
3513
  /**
3504
- * Cart ID.
3505
- * @format GUID
3514
+ * Delivery solution allocations to different delivery carriers and delivery regions
3515
+ * @maxSize 300
3506
3516
  */
3507
- cartId?: string;
3508
- }
3509
- interface RefreshCartResponse {
3510
- /** Refreshed cart. */
3511
- cart?: Cart;
3517
+ deliveryAllocations?: DeliveryAllocation[];
3518
+ /** If the delivery solution is a partial and doesn't apply to all items. */
3519
+ partial?: boolean | null;
3512
3520
  }
3513
- interface EstimateCartRequest {
3514
- /**
3515
- * Cart ID.
3516
- * @format GUID
3517
- */
3518
- cartId?: string;
3519
- /**
3520
- * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before estimating the cart.
3521
- *
3522
- * Default: `false`.
3523
- */
3524
- refreshCart?: boolean;
3525
- /** Level of business validation to run during estimation via the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction). */
3526
- validationConfig?: ValidationsConfigWithLiterals;
3521
+ interface DeliveryLogistics {
3527
3522
  /**
3528
- * Whether to calculate delivery costs.
3529
- *
3530
- * Default: `false`.
3523
+ * Expected delivery time, in free text. For example, "3-5 business days".
3524
+ * @maxLength 500
3531
3525
  */
3532
- calculateDelivery?: boolean;
3526
+ deliveryTime?: string | null;
3533
3527
  /**
3534
- * Whether to calculate additional fees.
3535
- *
3536
- * Default: `false`.
3528
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
3529
+ * @maxLength 1000
3537
3530
  */
3538
- calculateAdditionalFees?: boolean;
3531
+ instructions?: string | null;
3532
+ /** Pickup details. */
3533
+ pickupDetails?: PickupDetails;
3534
+ }
3535
+ interface PickupDetails {
3536
+ /** Pickup address. */
3537
+ address?: Address;
3539
3538
  /**
3540
- * Whether to calculate tax.
3541
- *
3542
- * Default: `false`.
3539
+ * Whether the pickup address is that of a business - this may effect tax calculation.
3540
+ * @deprecated
3543
3541
  */
3544
- calculateTax?: boolean;
3542
+ businessLocation?: boolean;
3543
+ /** Pickup method */
3544
+ pickupMethod?: PickupMethodWithLiterals;
3545
+ }
3546
+ declare enum PickupMethod {
3547
+ STORE_PICKUP = "STORE_PICKUP",
3548
+ PICKUP_POINT = "PICKUP_POINT"
3549
+ }
3550
+ /** @enumType */
3551
+ type PickupMethodWithLiterals = PickupMethod | 'STORE_PICKUP' | 'PICKUP_POINT';
3552
+ interface DeliveryTimeSlot {
3553
+ /** starting time of the delivery time slot */
3554
+ from?: Date | null;
3555
+ /** ending time of the delivery time slot */
3556
+ to?: Date | null;
3557
+ }
3558
+ interface SelectedCarrierServiceOptionPrices {
3559
+ /** Total shipping price, after discount and after tax. */
3560
+ totalPriceAfterTax?: MultiCurrencyPrice;
3561
+ /** Total price of shipping after discounts (when relevant), and before tax. */
3562
+ totalPriceBeforeTax?: MultiCurrencyPrice;
3563
+ /** Tax details. */
3564
+ taxDetails?: ItemTaxFullDetails;
3565
+ /** Shipping discount before tax. */
3566
+ totalDiscount?: MultiCurrencyPrice;
3567
+ /** Shipping price before discount and before tax. */
3568
+ price?: MultiCurrencyPrice;
3569
+ }
3570
+ interface SelectedCarrierServiceOptionOtherCharge {
3571
+ /** Type of additional cost. */
3572
+ type?: ChargeTypeWithLiterals;
3545
3573
  /**
3546
- * Whether to include the effect of gift card balances on the cart total.
3547
- * Gift cards aren't redeemed; balances are reflected for estimation only.
3548
- *
3549
- * Default: `false`.
3574
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
3575
+ * @maxLength 200
3550
3576
  */
3551
- calculateGiftCards?: boolean;
3577
+ details?: string | null;
3578
+ /** Price of added charge. */
3579
+ cost?: SelectedCarrierServiceOptionPrices;
3552
3580
  }
3553
- declare enum ValidationsConfig {
3554
- /** No business validations are performed. */
3555
- SKIP_VALIDATIONS = "SKIP_VALIDATIONS",
3556
- /** Perform cart-level business validations as defined by the service plugin implementer. */
3557
- PRE_CHECKOUT_VALIDATIONS = "PRE_CHECKOUT_VALIDATIONS",
3558
- /** Perform checkout-specific business validations as defined by the service plugin implementer. */
3559
- CHECKOUT_VALIDATIONS = "CHECKOUT_VALIDATIONS"
3581
+ declare enum ChargeType {
3582
+ HANDLING_FEE = "HANDLING_FEE",
3583
+ INSURANCE = "INSURANCE"
3560
3584
  }
3561
3585
  /** @enumType */
3562
- type ValidationsConfigWithLiterals = ValidationsConfig | 'SKIP_VALIDATIONS' | 'PRE_CHECKOUT_VALIDATIONS' | 'CHECKOUT_VALIDATIONS';
3563
- interface EstimateCartResponse {
3564
- /** Cart with estimated values. */
3565
- cart?: Cart;
3566
- /** Estimation summary. */
3567
- summary?: CartSummary;
3586
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
3587
+ interface DeliveryAllocation {
3588
+ /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
3589
+ deliveryCarrier?: Carrier;
3590
+ /** The delivery region that are relevant for this delivery solution. */
3591
+ deliveryRegion?: Region;
3592
+ /** Populated if the delivery solution is a partially supplied by this carrier. */
3593
+ applicableLineItems?: ApplicableLineItems;
3568
3594
  }
3569
- interface CalculateCartRequest {
3595
+ interface Carrier {
3570
3596
  /**
3571
- * Cart ID.
3597
+ * The carrier app id
3572
3598
  * @format GUID
3573
3599
  */
3574
- cartId?: string;
3600
+ appId?: string | null;
3575
3601
  /**
3576
- * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
3577
- *
3578
- * Default: `false`.
3602
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
3603
+ * @maxLength 250
3579
3604
  */
3580
- refreshCart?: boolean;
3581
- }
3582
- interface CalculateCartResponse {
3583
- /** Cart with calculated values. */
3584
- cart?: Cart;
3585
- /** Calculation summary. */
3586
- summary?: CartSummary;
3605
+ code?: string;
3587
3606
  }
3588
- interface CalculateCartForV1Request {
3607
+ interface Region {
3589
3608
  /**
3590
- * ID of the Cart to calculate.
3609
+ * The delivery region id.
3591
3610
  * @format GUID
3592
3611
  */
3593
- cartId?: string;
3612
+ id?: string | null;
3594
3613
  /**
3595
- * Specifies the level of **business validation** to perform during cart calculation,
3596
- * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
3614
+ * The delivery region name.
3615
+ * @maxLength 100
3597
3616
  */
3598
- validationsConfig?: ValidationsConfigWithLiterals;
3617
+ name?: string | null;
3618
+ }
3619
+ interface ApplicableLineItems {
3599
3620
  /**
3600
- * Optional custom configuration for the calculation.
3601
- * If not provided, all price components are calculated by default.
3621
+ * Line items that the delivery solution is for.
3622
+ * @maxSize 300
3623
+ * @minLength 1
3624
+ * @maxLength 100
3602
3625
  */
3603
- customCalculationConfig?: CalculationConfig;
3604
- /** Calculations overrides for backward compatibility with V1. */
3605
- calculationOverrides?: CalculationOverrides;
3606
- /** Cart revision that must still be current for the calculation to run. */
3607
- expectedRevision?: string | null;
3626
+ lineItemIds?: string[];
3608
3627
  }
3609
- interface CalculationConfig {
3628
+ interface CarrierServiceOption {
3610
3629
  /**
3611
- * Whether to calculate delivery costs.
3612
- *
3613
- * Default: `false`.
3630
+ * Carrier ID.
3631
+ * @format GUID
3614
3632
  */
3615
- calculateDelivery?: boolean;
3633
+ carrierId?: string;
3634
+ /** Shipping options offered by this carrier for this request. */
3635
+ shippingOptions?: ShippingOption[];
3636
+ }
3637
+ interface ShippingOption {
3616
3638
  /**
3617
- * Whether to calculate additional fees.
3618
- *
3619
- * Default: `false`.
3639
+ * Unique code of provided shipping option like "usps_std_overnight".
3640
+ * For legacy calculators this would be the UUID of the option.
3641
+ * @maxLength 100
3620
3642
  */
3621
- calculateAdditionalFees?: boolean;
3643
+ code?: string;
3622
3644
  /**
3623
- * Whether to calculate tax.
3624
- *
3625
- * Default: `false`.
3645
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3646
+ * For example, "Standard" or "First-Class Package International".
3647
+ * @maxLength 250
3626
3648
  */
3627
- calculateTax?: boolean;
3649
+ title?: string;
3650
+ /** Delivery logistics. */
3651
+ logistics?: DeliveryLogistics;
3652
+ /** Sipping price information. */
3653
+ cost?: ShippingPrice;
3628
3654
  /**
3629
- * Whether to include the effect of gift card balances on the cart total.
3630
- * Gift cards aren't redeemed; balances are reflected for estimation only.
3631
- *
3632
- * Default: `false`.
3655
+ * Delivery solution allocations to different delivery carriers and delivery regions
3656
+ * @maxSize 300
3633
3657
  */
3634
- calculateGiftCards?: boolean;
3658
+ deliveryAllocations?: DeliveryAllocation[];
3659
+ /** If the delivery solution is a partial and doesn't apply to all items. */
3660
+ partial?: boolean | null;
3635
3661
  }
3636
- interface CalculationOverrides {
3637
- /**
3638
- * Delivery method.
3639
- *
3640
- * Pass this field only when the cart has no delivery method yet.
3662
+ interface ShippingPrice {
3663
+ /** Shipping price. */
3664
+ price?: MultiCurrencyPrice;
3665
+ /** Other costs such as insurance, handling & packaging for fragile items, etc. */
3666
+ otherCharges?: OtherCharge[];
3667
+ }
3668
+ interface OtherCharge {
3669
+ /** Type of additional cost. */
3670
+ type?: ChargeTypeWithLiterals;
3671
+ /** Price of added cost. */
3672
+ price?: MultiCurrencyPrice;
3673
+ /**
3674
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
3675
+ * @maxLength 250
3641
3676
  */
3642
- deliveryMethod?: DeliveryMethodInput;
3677
+ details?: string | null;
3678
+ }
3679
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
3680
+ /** General shipping calculation error. */
3681
+ generalShippingCalculationError?: Details;
3682
+ /** Errors related to the delivery carrier. */
3683
+ carrierErrors?: CarrierErrors;
3684
+ /** Error related to the selected shipping option. */
3685
+ selectedShippingOptionError?: Details;
3686
+ /** Tax calculation error. */
3687
+ taxCalculationError?: Details;
3688
+ /** Coupon calculation error. */
3689
+ couponCalculationError?: Details;
3643
3690
  /**
3644
- * Delivery address.
3645
- * Used to calculate tax and shipping when applicable.
3691
+ * DEPRECATED: Use gift_card_calculation_errors instead.
3692
+ * @deprecated DEPRECATED: Use gift_card_calculation_errors instead.
3693
+ * @replacedBy gift_card_calculation_errors
3694
+ * @targetRemovalDate 2026-12-01
3646
3695
  */
3647
- deliveryAddress?: Address;
3696
+ giftCardCalculationError?: Details;
3697
+ /** Order validation errors. */
3698
+ orderValidationErrors?: ApplicationError[];
3648
3699
  /**
3649
- * Billing address.
3650
- * Used to calculate tax when all items in the cart aren't shippable.
3700
+ * Membership payment methods calculation errors
3701
+ * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
3651
3702
  */
3652
- billingAddress?: Address;
3653
- /** Selected membership payment options and the line items they apply to. */
3654
- selectedMemberships?: SelectedMemberships;
3703
+ membershipError?: Details;
3704
+ /** Discount Rule calculation error. */
3705
+ discountsCalculationError?: Details;
3655
3706
  }
3656
- interface SelectedMemberships {
3707
+ /** @oneof */
3708
+ interface CalculationErrorsShippingCalculationErrorOneOf {
3709
+ /** General shipping calculation error. */
3710
+ generalShippingCalculationError?: Details;
3711
+ /** Errors related to the delivery carrier. */
3712
+ carrierErrors?: CarrierErrors;
3713
+ /** Error related to the selected shipping option. */
3714
+ selectedShippingOptionError?: Details;
3715
+ }
3716
+ interface CarrierErrors {
3717
+ /** Carrier errors. */
3718
+ errors?: CarrierError[];
3719
+ }
3720
+ interface CarrierError {
3721
+ /** Carrier ID. */
3722
+ carrierId?: string;
3723
+ /** Error details. */
3724
+ error?: Details;
3725
+ }
3726
+ interface GiftCardCalculationError {
3727
+ /** Gift card code with most characters masked for security. */
3728
+ obfuscatedCode?: string;
3729
+ /** Error details. */
3730
+ error?: Details;
3731
+ }
3732
+ interface MembershipOptions {
3657
3733
  /**
3658
- * Selected memberships.
3734
+ * List of payment options that can be used.
3735
+ * Populated by the legacy ListEligibleMemberships flow.
3736
+ * @maxSize 300
3737
+ * @deprecated List of payment options that can be used.
3738
+ * Populated by the legacy ListEligibleMemberships flow.
3739
+ * @replacedBy validated_existing_memberships
3740
+ * @targetRemovalDate 2026-10-01
3741
+ */
3742
+ eligibleMemberships?: Membership[];
3743
+ /**
3744
+ * List of payment options that are owned by the member, but cannot be used due to reason provided.
3745
+ * Populated by the legacy ListEligibleMemberships flow.
3659
3746
  * @maxSize 300
3747
+ * @deprecated List of payment options that are owned by the member, but cannot be used due to reason provided.
3748
+ * Populated by the legacy ListEligibleMemberships flow.
3749
+ * @replacedBy validated_existing_memberships
3750
+ * @targetRemovalDate 2026-10-01
3660
3751
  */
3661
- memberships?: SelectedMembership[];
3752
+ invalidMemberships?: InvalidMembership[];
3753
+ /**
3754
+ * The selected membership payment options and which line items they apply to.
3755
+ * Populated by the legacy ListEligibleMemberships flow.
3756
+ * @maxSize 300
3757
+ * @deprecated The selected membership payment options and which line items they apply to.
3758
+ * Populated by the legacy ListEligibleMemberships flow.
3759
+ * @replacedBy validated_existing_memberships
3760
+ * @targetRemovalDate 2026-10-01
3761
+ */
3762
+ selectedMemberships?: SelectedMembership[];
3662
3763
  }
3663
- interface SelectedMembership {
3764
+ interface Membership {
3664
3765
  /**
3665
3766
  * Membership ID.
3666
3767
  * @minLength 1
@@ -3668,1332 +3769,1269 @@ interface SelectedMembership {
3668
3769
  */
3669
3770
  id?: string;
3670
3771
  /**
3671
- * ID of the app providing this payment option.
3772
+ * ID of the application providing this payment option.
3672
3773
  * @format GUID
3673
3774
  */
3674
3775
  appId?: string;
3776
+ /** The name of this membership. */
3777
+ name?: MembershipName;
3675
3778
  /**
3676
- * IDs of the line items this membership applies to.
3677
- * @minSize 1
3779
+ * Deprecated. Use `ExistingMembership.covered_line_items` to see which line items this membership covers.
3780
+ *
3781
+ * Only populated in the legacy `ListEligibleMemberships` flow, which still requires it. Empty on
3782
+ * `ListMembershipsByIds`, a by-id lookup that receives no line items to report against.
3678
3783
  * @maxSize 300
3679
3784
  * @minLength 1
3680
3785
  * @maxLength 100
3681
3786
  */
3682
3787
  lineItemIds?: string[];
3683
- }
3684
- interface CalculateCartForV1Response {
3685
- /** The Cart that was calculated. */
3686
- cart?: Cart;
3687
- /** The calculation summary. */
3688
- summary?: CartSummary;
3689
- /**
3690
- * Totals payload used for backward compatibility with legacy clients.
3691
- * Used by the Cart and Checkout proxies.
3692
- */
3693
- totalsResponse?: CalculateTotalsResponse;
3788
+ /** Membership's payment credits (balance information). */
3789
+ credits?: MembershipPaymentCredits;
3790
+ /** Membership expiration date. */
3791
+ expirationDate?: Date | null;
3694
3792
  /**
3695
- * Violations returned by the Validations service plugin, in the legacy model.
3696
- * Used by the Cart and Checkout proxies.
3697
- * @maxSize 100
3793
+ * Deprecated. Use `offering_description`.
3794
+ * @deprecated
3795
+ * @replacedBy offering_description
3796
+ * @targetRemovalDate 2026-08-30
3698
3797
  */
3699
- spiViolations?: Violation[];
3798
+ additionalData?: Record<string, any> | null;
3700
3799
  }
3701
- interface CalculateTotalsResponse {
3702
- /** Calculate line items. */
3703
- calculatedLineItems?: CalculatedLineItem[];
3704
- /** Price summary. */
3705
- priceSummary?: V1PriceSummary;
3706
- /**
3707
- * DEPRECATED: Use gift_cards instead.
3708
- * @deprecated DEPRECATED: Use gift_cards instead.
3709
- * @replacedBy gift_cards
3710
- * @targetRemovalDate 2026-12-01
3711
- */
3712
- giftCard?: GiftCard;
3713
- /** Tax summary. */
3714
- taxSummary?: TaxSummary;
3715
- /** Shipping information. */
3716
- shippingInfo?: ShippingInformation;
3800
+ interface MembershipName {
3717
3801
  /**
3718
- * Applied discounts.
3719
- * @maxSize 320
3802
+ * Membership name in the site's original language.
3803
+ * @maxLength 100
3720
3804
  */
3721
- appliedDiscounts?: AppliedDiscount[];
3722
- /** Calculation errors. */
3723
- calculationErrors?: CalculationErrors;
3724
- /** Weight unit. */
3725
- weightUnit?: WeightUnitWithLiterals;
3805
+ original?: string;
3726
3806
  /**
3727
- * The currency the price calculations were performed in.
3728
- * This is the business’s default currency: the base currency configured for the site, which remains constant regardless of the [customer’s currency selection](https://support.wix.com/en/article/multicurrency-an-overview).
3729
- * When `amountCurrency` is specified on the request, this returns that value instead.
3730
- * @format CURRENCY
3807
+ * Membership name translated into the buyer's language.
3808
+ *
3809
+ * Default: The value of `original`
3810
+ * @maxLength 100
3731
3811
  */
3732
- currency?: string;
3812
+ translated?: string | null;
3813
+ }
3814
+ interface MembershipPaymentCredits {
3733
3815
  /**
3734
- * The currency the converted price calculations are in.
3735
- * This is the currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview), which may differ from `currency`.
3736
- * When `amountCurrency` is specified on the request, nothing is converted and this returns that value.
3737
- * @readonly
3738
- * @format CURRENCY
3816
+ * Membership's initial balance.
3817
+ * @min 1
3739
3818
  */
3740
- conversionCurrency?: string;
3741
- /** Whether tax is included in price. */
3742
- taxIncludedInPrice?: boolean;
3819
+ total?: number;
3820
+ /** Membership's remaining balance. */
3821
+ remaining?: number;
3743
3822
  /**
3744
- * Minimal amount to pay in order to place the order.
3745
- * @readonly
3823
+ * How the membership's balance is measured.
3824
+ *
3825
+ * Use the same value as `Benefit.quota.limitedQuota.limitedQuotaType` for the benefit this membership came from in [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans). This way the balance keeps the same unit before and after purchase.
3826
+ *
3827
+ * Default: `PUNCH_CARD`.
3746
3828
  */
3747
- payNow?: V1PriceSummary;
3829
+ balanceType?: BalanceTypeWithLiterals;
3830
+ }
3831
+ declare enum BalanceType {
3832
+ /** Balance is measured in discrete uses, such as sessions or visits. */
3833
+ PUNCH_CARD = "PUNCH_CARD",
3834
+ /** Balance is measured in a currency-like value, such as points. */
3835
+ CREDIT = "CREDIT"
3836
+ }
3837
+ /** @enumType */
3838
+ type BalanceTypeWithLiterals = BalanceType | 'PUNCH_CARD' | 'CREDIT';
3839
+ interface InvalidMembership {
3840
+ /** Membership details. */
3841
+ membership?: Membership;
3748
3842
  /**
3749
- * Remaining amount for the order to be fully paid.
3750
- * @readonly
3843
+ * Reason why this membership is invalid and cannot be used.
3844
+ * @minLength 1
3845
+ * @maxLength 100
3751
3846
  */
3752
- payLater?: V1PriceSummary;
3753
- /** Information about valid and invalid memberships, and which ones are selected for usage. */
3754
- membershipOptions?: MembershipOptions;
3847
+ reason?: string;
3848
+ }
3849
+ interface SelectedMembership {
3755
3850
  /**
3756
- * Additional Fees
3757
- * @maxSize 100
3851
+ * Membership ID.
3852
+ * @minLength 1
3853
+ * @maxLength 200
3758
3854
  */
3759
- additionalFees?: AdditionalFee[];
3855
+ id?: string;
3760
3856
  /**
3761
- * The rate used when converting from the site currency to the checkout currency.
3762
- * @readonly
3763
- * @decimalValue options { gt:0, lte:1000000000000000 }
3857
+ * ID of the app providing this payment option.
3858
+ * @format GUID
3764
3859
  */
3765
- checkoutConversionRate?: string | null;
3860
+ appId?: string;
3766
3861
  /**
3767
- * The pay now total amount after all gift cards are applied.
3768
- * @readonly
3862
+ * IDs of the line items this membership applies to.
3863
+ * @minSize 1
3864
+ * @maxSize 300
3865
+ * @minLength 1
3866
+ * @maxLength 100
3769
3867
  */
3770
- payNowTotalAfterGiftCard?: MultiCurrencyPrice;
3868
+ lineItemIds?: string[];
3869
+ }
3870
+ /** The validated existing memberships. Same shape as `ListExistingMembershipsResponse.memberships`. */
3871
+ interface ValidatedExistingMemberships {
3771
3872
  /**
3772
- * The total amount after all gift cards are applied.
3773
- * @readonly
3873
+ * The selected memberships, each paired with the line items it can pay for and the cost to redeem
3874
+ * each.
3875
+ * @maxSize 300
3774
3876
  */
3775
- totalAfterGiftCard?: MultiCurrencyPrice;
3776
- /**
3777
- * Payment for subscriptions after free trial period.
3778
- * @readonly
3779
- */
3780
- payAfterFreeTrial?: V1PriceSummary;
3877
+ memberships?: ExistingMembership[];
3781
3878
  }
3782
- interface CalculatedLineItem {
3783
- /** Line item ID. */
3784
- lineItemId?: string;
3785
- /** Price breakdown for this line item. */
3786
- pricesBreakdown?: LineItemPricesData;
3879
+ /**
3880
+ * A membership the member owns, together with the given line items it can pay for.
3881
+ *
3882
+ * A membership is a single benefit granted by a plan the member has already paid for, so its coverage
3883
+ * is nested directly here. No `benefitId` link is needed, unlike a plan that grants several benefits.
3884
+ */
3885
+ interface ExistingMembership {
3886
+ /** The membership the member owns. */
3887
+ membership?: V1Membership;
3787
3888
  /**
3788
- * Type of selected payment option for current item. Supported values:
3789
- * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item will happen as part of the checkout
3790
- * + `"FULL_PAYMENT_OFFLINE"` - The entire payment for this item will happen after the checkout
3791
- * + `"MEMBERSHIP"` - This item cannot be paid via monetary payment options, only via non monetary option such membership. When this option is used, price must be set to 0
3792
- * + `"DEPOSIT_ONLINE"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.
3889
+ * Line items this membership can pay for, and the cost to redeem each.
3890
+ * @maxSize 300
3793
3891
  */
3794
- paymentOption?: PaymentOptionTypeWithLiterals;
3795
- /** tax calculation address. */
3796
- taxableAddress?: TaxableAddress;
3892
+ coveredLineItems?: CoveredLineItem[];
3797
3893
  }
3798
- interface LineItemPricesData {
3799
- /** Total price after discounts, tax, and modifiers. */
3800
- totalPriceAfterTax?: MultiCurrencyPrice;
3801
- /** Total price after discounts and modifiers, and before tax. */
3802
- totalPriceBeforeTax?: MultiCurrencyPrice;
3803
- /** Tax details. */
3804
- taxDetails?: ItemTaxFullDetails;
3805
- /** Total discount applied for the line item. */
3806
- totalDiscount?: MultiCurrencyPrice;
3807
- /** Catalog price after catalog-defined discount, automatic discounts, and modifiers. */
3808
- price?: MultiCurrencyPrice;
3894
+ interface V1Membership {
3809
3895
  /**
3810
- * Item price before automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
3811
- * Defaults to `price` when not provided.
3896
+ * Membership ID.
3897
+ * @minLength 1
3898
+ * @maxLength 200
3812
3899
  */
3813
- priceBeforeDiscounts?: MultiCurrencyPrice;
3814
- /** Total line item price after catalog-defined discounts, automatic discounts, and modifiers. */
3815
- lineItemPrice?: MultiCurrencyPrice;
3816
- /** Catalog price before any discounts, with modifiers. */
3817
- fullPrice?: MultiCurrencyPrice;
3818
- /** Sum of all modifiers for a single unit of the item. */
3819
- modifiers?: MultiCurrencyPrice;
3900
+ id?: string;
3901
+ /** Membership name. */
3902
+ name?: MembershipName;
3820
3903
  /**
3821
- * Partial payment out of `price` to be paid upfront during the checkout.
3822
- * Applies to catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
3904
+ * Deprecated. Use `ExistingMembership.coveredLineItems` to see which line items this membership
3905
+ * covers.
3906
+ *
3907
+ * Populate this only in the legacy [List Eligible Memberships](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-eligible-memberships) flow, which still requires it and rejects a membership that omits it. Leave it empty everywhere else. [List Memberships By IDs](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-memberships-by-ids) receives no line items at all, so there's nothing to report there.
3908
+ * @maxSize 300
3909
+ * @minLength 1
3910
+ * @maxLength 100
3911
+ * @deprecated
3912
+ * @replacedBy ExistingMembership.covered_line_items.line_item_id
3913
+ * @targetRemovalDate 2026-08-30
3823
3914
  */
3824
- depositAmount?: MultiCurrencyPrice;
3825
- }
3826
- interface ItemTaxFullDetails {
3827
- /** Amount for which tax is calculated. */
3828
- taxableAmount?: MultiCurrencyPrice;
3915
+ lineItemIds?: string[];
3829
3916
  /**
3830
- * Tax rate %, as a decimal point between 0 and 1.
3831
- * @decimalValue options { gte:0, lte:1, maxScale:6 }
3917
+ * Membership's balance.
3918
+ *
3919
+ * Omit this field for an unlimited membership, which has no balance to draw down. Every
3920
+ * `ExistingMembership.coveredLineItems.redemptionCost` is then `0`. Unlike a plan's benefit, a
3921
+ * membership carries no explicit unlimited marker: the absence of a balance is the marker.
3832
3922
  */
3833
- taxRate?: string;
3834
- /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
3835
- totalTax?: MultiCurrencyPrice;
3923
+ credits?: MembershipPaymentCredits;
3924
+ /** Date and time the membership expires. */
3925
+ expirationDate?: Date | null;
3836
3926
  /**
3837
- * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
3838
- * @readonly
3927
+ * Deprecated. Use `offeringDescription` for human-readable data about the offering.
3839
3928
  * @deprecated
3929
+ * @replacedBy offering_description
3930
+ * @targetRemovalDate 2026-08-30
3840
3931
  */
3841
- rateBreakdown?: TaxRateBreakdown[];
3842
- /**
3843
- * tax information for a line item.
3844
- * @maxSize 1000
3845
- * @readonly
3846
- */
3847
- taxBreakdown?: TaxBreakdown[];
3932
+ additionalData?: Record<string, any> | null;
3848
3933
  }
3849
- interface TaxRateBreakdown {
3934
+ /** A line item a membership can pay for, and the cost to redeem it. */
3935
+ interface CoveredLineItem {
3850
3936
  /**
3851
- * Name of tax against which the calculation was performed.
3937
+ * ID of the line item this membership can pay for. Matches the `id` of one of the given line items.
3938
+ * @minLength 1
3852
3939
  * @maxLength 100
3853
3940
  */
3854
- name?: string;
3941
+ lineItemId?: string;
3855
3942
  /**
3856
- * Rate at which this tax detail was calculated.
3857
- * @decimalValue options { gte:0, lte:1, maxScale:6 }
3943
+ * Amount deducted from the membership's remaining balance (`credits.remaining`) when this line item
3944
+ * is redeemed.
3945
+ *
3946
+ * Always `0` for an unlimited membership, which is expressed by omitting `credits` and decrements
3947
+ * nothing.
3858
3948
  */
3859
- rate?: string;
3860
- /** Amount of tax for this tax detail. */
3861
- tax?: MultiCurrencyPrice;
3949
+ redemptionCost?: number;
3862
3950
  }
3863
- /**
3864
- * TaxBreakdown represents tax information for a line item.
3865
- * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
3866
- */
3867
- interface TaxBreakdown {
3868
- /**
3869
- * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
3870
- * @maxLength 200
3871
- */
3872
- jurisdiction?: string | null;
3873
- /** The amount of this line item price that was considered nontaxable. (Decimal value) */
3874
- nonTaxableAmount?: MultiCurrencyPrice;
3875
- /**
3876
- * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
3877
- * @decimalValue options { gte:0, maxScale:6 }
3878
- */
3879
- rate?: string | null;
3880
- /** The amount of tax estimated for this line item. (Decimal value) */
3881
- taxAmount?: MultiCurrencyPrice;
3882
- /** The taxable amount of this line item. */
3883
- taxableAmount?: MultiCurrencyPrice;
3951
+ /** The validated purchasable plans. Same shape as `ListPurchasablePlansResponse`. */
3952
+ interface ValidatedPurchasablePlans {
3884
3953
  /**
3885
- * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
3886
- * @maxLength 200
3954
+ * The selected plans.
3955
+ * @maxSize 300
3887
3956
  */
3888
- taxType?: string | null;
3957
+ purchasablePlans?: PurchasablePlan[];
3889
3958
  /**
3890
- * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
3891
- * This name should be explicit enough to allow the merchant to understand what tax was calculated.
3892
- * @maxLength 200
3959
+ * How the plans' benefits cover the line items, each entry naming its benefit by `benefitId`.
3960
+ * @maxSize 300
3893
3961
  */
3894
- taxName?: string | null;
3895
- /** The type of the jurisdiction in which this tax detail applies. */
3896
- jurisdictionType?: JurisdictionTypeWithLiterals;
3897
- }
3898
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3899
- declare enum JurisdictionType {
3900
- UNDEFINED = "UNDEFINED",
3901
- COUNTRY = "COUNTRY",
3902
- STATE = "STATE",
3903
- COUNTY = "COUNTY",
3904
- CITY = "CITY",
3905
- SPECIAL = "SPECIAL"
3962
+ coverages?: LineItemCoverage[];
3906
3963
  }
3907
- /** @enumType */
3908
- type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
3909
- /**
3910
- * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
3911
- * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
3912
- *
3913
- * The totals calculator form of `com.wix.ecommerce.platform_common.api.CrossBorderPriceAdjustment`: the same fields under the same numbers,
3914
- * with the amounts as `MultiCurrencyPrice`. This record describes how the price was reached, not the resulting amount;
3915
- * the repriced figures are on the line, shipping option or fee that carries it.
3916
- */
3917
- interface CrossBorderPriceAdjustment {
3964
+ interface PurchasablePlan {
3918
3965
  /**
3919
- * ID of the tax region whose tax is built into the catalog prices.
3920
- * @format GUID
3921
- * @readonly
3966
+ * Catalog and item reference identifying both the plan and the pricing variant.
3967
+ *
3968
+ * A purchasable plan has no ID of its own. The reference carries the plan in `catalogItemId` and
3969
+ * the chosen pricing variant in `options`, so the same plan appears once per variant with a
3970
+ * different reference each time. The plan ID alone repeats across entries; the full reference
3971
+ * doesn't.
3972
+ *
3973
+ * When the plan needs nothing further from the buyer, the reference can be added to the cart as it
3974
+ * stands. When it does, for example a plan carrying a form, a custom start date, or a buyer-chosen
3975
+ * price, the reference has to be completed with that input first. See `infoCollectionUrl`.
3922
3976
  */
3923
- baseTaxRegionId?: string;
3977
+ catalogReference?: CatalogReference;
3978
+ /** Plan name. */
3979
+ name?: MembershipName;
3924
3980
  /**
3925
- * ID of the tax region resolved for the destination. Absent when no region matched.
3926
- * @format GUID
3927
- * @readonly
3981
+ * Benefits the plan grants once purchased.
3982
+ *
3983
+ * A plan can grant several, for example a bundle granting separate yoga and pilates credits. Each
3984
+ * benefit becomes its own membership after purchase.
3985
+ * @minSize 1
3986
+ * @maxSize 50
3928
3987
  */
3929
- destinationTaxRegionId?: string | null;
3988
+ benefits?: Benefit[];
3930
3989
  /**
3931
- * Price per unit as entered by the merchant, with the base region's tax inside it.
3932
- * @readonly
3990
+ * Human-readable summary of what the plan offers, for display. For example, `8 yoga classes and 4
3991
+ * pilates classes, billed monthly`.
3992
+ *
3993
+ * Describe the offering here and the price in `priceDescription`.
3994
+ * @maxLength 500
3933
3995
  */
3934
- catalogPrice?: MultiCurrencyPrice;
3996
+ offeringDescription?: string | null;
3935
3997
  /**
3936
- * Base region's tax removed per unit. Zero when `status` is `KEPT`, `SAME_REGION`, `SAME_COUNTRY`, `NOT_APPLICABLE`, `NOT_APPLICABLE_MODIFIERS` or `CONVERTED_CURRENCY_SUBSCRIPTION`, where nothing was removed.
3937
- * @readonly
3998
+ * URL of the page that collects the extra input this plan needs before it can be purchased.
3999
+ *
4000
+ * Return it only for a plan that needs more from the buyer, such as one carrying a form, a custom
4001
+ * start date, or a buyer-chosen price. Omitting it means the plan needs nothing further, and the
4002
+ * caller builds the cart itself.
4003
+ *
4004
+ * The buyer reaches this page before any cart exists, rather than from the checkout page, and
4005
+ * there's no return trip. The page receives the caller's already-created items, then builds the
4006
+ * cart and checkout from the plan plus those items. There's no return URL, no cart ID, no
4007
+ * preserved selection, and no completion signal: the purchase reaches Wix through the ordinary
4008
+ * checkout and order flow, and the membership through Membership Ready To Be Charged.
4009
+ *
4010
+ * The page covers a single plan. Items that plan covers can be mixed with directly-paid ones, but
4011
+ * a selection spanning two plans isn't supported here.
4012
+ * @format WEB_URL
3938
4013
  */
3939
- baseTaxAmount?: MultiCurrencyPrice;
4014
+ infoCollectionUrl?: string | null;
3940
4015
  /**
3941
- * Outcome of the repricing for this line.
3942
- * @readonly
4016
+ * Plan price, in the plan's own configured currency.
4017
+ *
4018
+ * No currency accompanies the amount and none is converted, so prices from different plans aren't
4019
+ * comparable and the currency reaches the buyer only through `priceDescription`. Name the currency
4020
+ * there.
4021
+ * @decimalValue options { gte:0, maxScale:3 }
3943
4022
  */
3944
- status?: RepriceStatusWithLiterals;
4023
+ price?: string;
3945
4024
  /**
3946
- * Where the base region's rate came from. Meaningful only when a rate was applied, that is when `status` is `APPLIED`, `STRIP_ONLY` or `NO_DESTINATION_REGION`.
3947
- * @readonly
4025
+ * Human-readable summary of the plan price, for display. For example, `First month free, then
4026
+ * $20/month`.
4027
+ *
4028
+ * Use `price` for the bare amount, which is what sorting and comparison rely on, and this field for
4029
+ * pricing a buyer needs prose to understand.
4030
+ * @maxLength 500
3948
4031
  */
3949
- baseRateSource?: BaseRateSourceWithLiterals;
3950
- /**
3951
- * Base region's rate used to remove the tax, as a decimal numeral between 0 and 1. For example, `"0.22"`. Absent when no rate was applied.
3952
- * @format DECIMAL_VALUE
3953
- * @decimalValue options { gte:0, maxScale:6 }
3954
- * @readonly
3955
- */
3956
- baseRate?: string | null;
4032
+ priceDescription?: string | null;
4033
+ }
4034
+ /**
4035
+ * A single redeemable benefit granted by a plan.
4036
+ *
4037
+ * A purchasable plan grants one or more benefits in `benefits`. Once the plan is paid for, each benefit
4038
+ * becomes its own membership, charged by `membershipId`.
4039
+ */
4040
+ interface Benefit extends BenefitQuotaOneOf {
4041
+ limitedQuota?: LimitedQuota;
3957
4042
  /**
3958
- * When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`.
3959
- * @readonly
4043
+ * Identifier for this benefit, unique within its plan.
4044
+ *
4045
+ * Not unique across the response. A plan is returned once per pricing variant, and every variant
4046
+ * repeats that plan's benefit IDs. Two different plans can also share an ID when they grant the
4047
+ * same benefit, and a coverage entry naming it is then true for both.
4048
+ *
4049
+ * Never give two different benefits the same ID. That's the one case a caller can't recover from,
4050
+ * because a cost computed for one benefit would be applied to the other.
4051
+ * @minLength 1
4052
+ * @maxLength 200
3960
4053
  */
3961
- baseRateCapturedDate?: Date | null;
4054
+ benefitId?: string;
3962
4055
  /**
3963
- * Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated.
3964
- * @readonly
4056
+ * Human-readable label for this benefit. For example, `Manicure` or `Pedicure` on a multi-set
4057
+ * punch card.
4058
+ * @maxLength 200
3965
4059
  */
3966
- destinationTaxIncluded?: boolean | null;
4060
+ label?: string | null;
4061
+ /** Kind of quota this benefit grants. */
4062
+ quotaType?: QuotaTypeWithLiterals;
3967
4063
  }
3968
- /** Outcome of the repricing for one line. */
3969
- declare enum RepriceStatus {
3970
- /** Base tax removed and the destination's tax applied. */
3971
- APPLIED = "APPLIED",
3972
- /** The caller asked for the line to be left at its price. Nothing was removed. */
3973
- KEPT = "KEPT",
3974
- /** Base tax removed and no destination tax applied, as in a tax-exempt calculation. This is the outcome; the mode that asks for it is `CrossBorderRepricingMode.STRIP_ONLY`. */
3975
- STRIP_ONLY = "STRIP_ONLY",
3976
- /** The destination is the base region. Nothing was removed. */
3977
- SAME_REGION = "SAME_REGION",
3978
- /** The destination is in the base region's country, outside the US and Canada, so the catalog price already carries the destination's tax. Nothing was removed. */
3979
- SAME_COUNTRY = "SAME_COUNTRY",
3980
- /** No tax region matched the destination. Base tax removed and no destination tax applied. */
3981
- NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
3982
- /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
3983
- NOT_APPLICABLE = "NOT_APPLICABLE",
3984
- /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
3985
- NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
3986
- /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
3987
- CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
4064
+ /** @oneof */
4065
+ interface BenefitQuotaOneOf {
4066
+ limitedQuota?: LimitedQuota;
4067
+ }
4068
+ declare enum QuotaType {
4069
+ /** The benefit grants a countable quota that's drawn down on redemption. */
4070
+ LIMITED = "LIMITED",
4071
+ /** The benefit is unlimited and is never drawn down. */
4072
+ UNLIMITED = "UNLIMITED"
3988
4073
  }
3989
4074
  /** @enumType */
3990
- type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
3991
- /** Where the base region's rate came from. */
3992
- declare enum BaseRateSource {
3993
- /** The manual tax calculator computed the base tax for this calculation. */
3994
- MANUAL_SPI = "MANUAL_SPI",
3995
- /** The rate captured from Avalara by the embedded-rate probe. */
3996
- AVALARA_PROBE = "AVALARA_PROBE"
4075
+ type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
4076
+ /** A limited, countable redeemable amount. */
4077
+ interface LimitedQuota {
4078
+ /**
4079
+ * Quota's initial value.
4080
+ * @min 1
4081
+ */
4082
+ total?: number;
4083
+ /** Quota's remaining value. */
4084
+ remaining?: number;
4085
+ /**
4086
+ * How the quota is measured.
4087
+ *
4088
+ * The same vocabulary as `MembershipPaymentCredits.balanceType` on the existing-membership side.
4089
+ */
4090
+ limitedQuotaType?: LimitedQuotaTypeWithLiterals;
4091
+ }
4092
+ declare enum LimitedQuotaType {
4093
+ /** Quota is measured in discrete uses, such as sessions or visits. */
4094
+ PUNCH_CARD = "PUNCH_CARD",
4095
+ /** Quota is measured in a currency-like value, such as points. */
4096
+ CREDIT = "CREDIT"
3997
4097
  }
3998
4098
  /** @enumType */
3999
- type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
4000
- interface CalculatedItemModifier {
4099
+ type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
4100
+ /**
4101
+ * Maps one of a plan's benefits to a line item it can cover, and at what cost.
4102
+ *
4103
+ * One entry per benefit and line item pair, returned by [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans) alongside `purchasablePlans`.
4104
+ *
4105
+ * An entry names a benefit and carries no plan identity, so match its `benefitId` against the
4106
+ * `benefits` of the returned plans and apply it to every entry that grants that benefit. Entries for
4107
+ * the same plan repeat it once per pricing variant, and two different plans sharing a benefit ID
4108
+ * grant the same benefit, so the entry holds for each of them. A caller that stops at the first
4109
+ * match shows nothing incorrect, but hides the other entries, which cover the item too.
4110
+ *
4111
+ * The cost is identical across a plan's variants, so there's one entry per benefit rather than one
4112
+ * per variant.
4113
+ *
4114
+ * For memberships the member already owns, the equivalent mapping is
4115
+ * `ExistingMembership.coveredLineItems`, which needs no `benefitId` because a membership is a single
4116
+ * benefit.
4117
+ */
4118
+ interface LineItemCoverage {
4001
4119
  /**
4002
- * Modifier ID.
4120
+ * ID of the benefit that covers the line item, as returned in `Benefit.benefitId`.
4121
+ *
4122
+ * Identifies a benefit within its plan, and repeats across that plan's pricing variants.
4003
4123
  * @minLength 1
4004
- * @maxLength 36
4124
+ * @maxLength 200
4005
4125
  */
4006
- id?: string;
4126
+ benefitId?: string;
4007
4127
  /**
4008
- * ID of the group this modifier belongs to.
4128
+ * ID of the line item this benefit covers.
4009
4129
  * @minLength 1
4010
- * @maxLength 36
4130
+ * @maxLength 100
4011
4131
  */
4012
- groupId?: string;
4132
+ lineItemId?: string;
4013
4133
  /**
4014
- * Modifier price.
4015
- * @readonly
4134
+ * Amount deducted from the benefit's `limitedQuota.remaining` value when this line item is redeemed.
4135
+ *
4136
+ * Always `0` for an unlimited benefit, which decrements nothing.
4016
4137
  */
4017
- price?: MultiCurrencyPrice;
4018
- }
4019
- interface V1PriceSummary {
4020
- /** Subtotal of all line items, before discounts and before tax. */
4021
- subtotal?: MultiCurrencyPrice;
4022
- /** Total shipping price, before discounts and before tax. */
4023
- shipping?: MultiCurrencyPrice;
4024
- /** Total tax. */
4025
- tax?: MultiCurrencyPrice;
4026
- /** Total calculated discount value. */
4027
- discount?: MultiCurrencyPrice;
4028
- /** Total price after discounts, gift cards, and tax. */
4029
- total?: MultiCurrencyPrice;
4030
- /** Total additional fees price before tax. */
4031
- additionalFees?: MultiCurrencyPrice;
4138
+ redemptionCost?: number;
4032
4139
  }
4033
- interface GiftCard {
4034
- /**
4035
- * Gift Card ID.
4036
- * @deprecated
4037
- */
4038
- id?: string;
4039
- /** Gift card obfuscated code. */
4040
- obfuscatedCode?: string;
4041
- /** Actual amount to be redeemed from the gift card. */
4042
- amount?: MultiCurrencyPrice;
4140
+ interface AdditionalFee {
4043
4141
  /**
4044
- * App ID of the gift card provider.
4045
- * @format GUID
4142
+ * Additional fee's unique code (or ID) for future processing.
4143
+ * @minLength 1
4144
+ * @maxLength 100
4046
4145
  */
4047
- appId?: string;
4146
+ code?: string | null;
4048
4147
  /**
4049
- * External ID in the gift card provider's system.
4050
- * Used for integration and tracking across different platforms.
4148
+ * Additional fee's name.
4051
4149
  * @minLength 1
4052
4150
  * @maxLength 50
4053
4151
  */
4054
- externalId?: string | null;
4055
- /** Requested amount to redeem from the gift card. */
4056
- requestedAmount?: MultiCurrencyPrice;
4057
- }
4058
- interface TaxSummary {
4152
+ name?: string;
4153
+ /** Additional fee's price. */
4154
+ price?: MultiCurrencyPrice;
4155
+ /** Tax details. */
4156
+ taxDetails?: ItemTaxFullDetails;
4059
4157
  /**
4060
- * Amount for which tax is calculated, added from line items.
4061
- * @readonly
4158
+ * Provider's app id.
4159
+ * @minLength 1
4160
+ * @maxLength 100
4062
4161
  */
4063
- taxableAmount?: MultiCurrencyPrice;
4162
+ providerAppId?: string | null;
4163
+ /** Additional fee's price before tax. */
4164
+ priceBeforeTax?: MultiCurrencyPrice;
4165
+ /** Additional fee's price after tax. */
4166
+ priceAfterTax?: MultiCurrencyPrice;
4064
4167
  /**
4065
- * Calculated tax, added from line items.
4066
- * @readonly
4168
+ * Optional - Line items associated with this additional fee.
4169
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
4170
+ * @format GUID
4067
4171
  */
4068
- totalTax?: MultiCurrencyPrice;
4172
+ lineItemIds?: string[];
4173
+ /** the source the additional fee was added from */
4174
+ source?: AdditionalFeeSourceWithLiterals;
4069
4175
  /**
4070
- * Tax calculator that was active when the order was created.
4071
- * @deprecated
4176
+ * The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
4177
+ * @minLength 1
4178
+ * @maxLength 50
4072
4179
  */
4073
- calculationDetails?: TaxCalculationDetails;
4074
- }
4075
- interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
4076
- /** Reason the manual calculation was used. */
4077
- manualRateReason?: ManualCalculationReasonWithLiterals;
4078
- /** Details of the fallback rate calculation. */
4079
- autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
4080
- /** Rate calculation type. */
4081
- rateType?: RateTypeWithLiterals;
4082
- }
4083
- /** @oneof */
4084
- interface TaxCalculationDetailsCalculationDetailsOneOf {
4085
- /** Reason the manual calculation was used. */
4086
- manualRateReason?: ManualCalculationReasonWithLiterals;
4087
- /** Details of the fallback rate calculation. */
4088
- autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
4089
- }
4090
- declare enum RateType {
4091
- /** no tax being collected for this request due to location of purchase */
4092
- NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
4093
- /** manual rate used for calculation */
4094
- MANUAL_RATE = "MANUAL_RATE",
4095
- /** autotax rate used for calculation */
4096
- AUTO_RATE = "AUTO_RATE",
4097
- /** fallback rate used for calculation */
4098
- FALLBACK_RATE = "FALLBACK_RATE"
4099
- }
4100
- /** @enumType */
4101
- type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
4102
- declare enum ManualCalculationReason {
4103
- /** user set calculator in Business Manager to be Manual */
4104
- GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
4105
- /** specific region is on manual even though Global setting is Auto-tax */
4106
- REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
4107
- }
4108
- /** @enumType */
4109
- type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
4110
- interface AutoTaxFallbackCalculationDetails {
4111
- /** reason for fallback */
4112
- fallbackReason?: FallbackReasonWithLiterals;
4113
- /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
4114
- error?: ApplicationError;
4180
+ translatedName?: string | null;
4181
+ /** Address type tax was calculated against for this fee. */
4182
+ taxableAddress?: TaxableAddress;
4115
4183
  }
4116
- declare enum FallbackReason {
4117
- /** auto-tax failed to be calculated */
4118
- AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
4119
- /** auto-tax was temporarily deactivated on a system-level */
4120
- AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
4184
+ declare enum AdditionalFeeSource {
4185
+ UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
4186
+ /** The additional fee was added by an additional fee service plugin */
4187
+ SERVICE_PLUGIN = "SERVICE_PLUGIN",
4188
+ /** The additional fee was added on the item either via the catalog or on custom line item */
4189
+ ITEM = "ITEM",
4190
+ /** The additional fee was added manually on the request */
4191
+ MANUAL = "MANUAL",
4192
+ /** The additional fee was added by the shipping provider */
4193
+ SHIPPING = "SHIPPING",
4194
+ /** The additional fee was added by a Wix vertical and represents a Wix platform fee */
4195
+ PLATFORM = "PLATFORM"
4121
4196
  }
4122
4197
  /** @enumType */
4123
- type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
4124
- /**
4125
- * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
4126
- * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
4127
- */
4128
- interface AggregatedTaxBreakdown {
4129
- /**
4130
- * The name of the tax against which this tax amount was calculated.
4131
- * @maxLength 200
4132
- */
4133
- taxName?: string;
4198
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING' | 'PLATFORM';
4199
+ interface PlatformFeeSummary {
4200
+ /** Total platform fee amount. */
4201
+ total?: MultiCurrencyPrice;
4202
+ /** Total platform fee passed on to the customer. */
4203
+ totalPassOn?: MultiCurrencyPrice;
4204
+ /** Total platform fee absorbed by the merchant. */
4205
+ totalAbsorbed?: MultiCurrencyPrice;
4134
4206
  /**
4135
- * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
4136
- * @maxLength 200
4207
+ * Calculated platform fees.
4208
+ * @maxSize 100
4137
4209
  */
4138
- taxType?: string;
4210
+ calculatedPlatformFees?: CalculatedPlatformFee[];
4211
+ }
4212
+ interface CalculatedPlatformFee {
4213
+ /** Platform fee name. */
4214
+ name?: TranslatableString;
4215
+ /** Platform fee amount. */
4216
+ amount?: MultiCurrencyPrice;
4139
4217
  /**
4140
- * The name of the jurisdiction in which this tax detail applies.
4141
- * @maxLength 200
4218
+ * ID of the line item the platform fee applies to.
4219
+ * @format GUID
4142
4220
  */
4143
- jurisdiction?: string;
4144
- /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
4145
- jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
4221
+ lineItemId?: string;
4222
+ /** Platform fee charge type. */
4223
+ chargeType?: PlatformFeeChargeTypeWithLiterals;
4146
4224
  /**
4147
- * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
4148
- * @decimalValue options { gte:0, maxScale:6 }
4225
+ * Percentage rate charged as platform fee.
4226
+ * The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
4227
+ * @format DECIMAL_VALUE
4228
+ * @decimalValue options { gt:0, lte:1, maxScale:4 }
4149
4229
  */
4150
- rate?: string;
4151
- /** The sum of all the tax from line items that calculated by the tax identifiers. */
4152
- aggregatedTaxAmount?: MultiCurrencyPrice;
4153
- /** The sum of all the taxable amount from line items for tax identifiers. */
4154
- aggregatedTaxableAmount?: MultiCurrencyPrice;
4230
+ percentageRate?: string;
4155
4231
  }
4156
- interface ShippingInformation {
4157
- /** Shipping region. */
4158
- region?: ShippingRegion;
4159
- /** Selected shipping option. */
4160
- selectedCarrierServiceOption?: SelectedCarrierServiceOption;
4161
- /** All shipping options. */
4162
- carrierServiceOptions?: CarrierServiceOption[];
4232
+ declare enum PlatformFeeChargeType {
4233
+ /** The platform fee is passed on to the customer. */
4234
+ PASS_ON = "PASS_ON",
4235
+ /** The platform fee is absorbed by the merchant. */
4236
+ ABSORBED = "ABSORBED"
4163
4237
  }
4164
- interface ShippingRegion {
4238
+ /** @enumType */
4239
+ type PlatformFeeChargeTypeWithLiterals = PlatformFeeChargeType | 'PASS_ON' | 'ABSORBED';
4240
+ /** Cart-level outcome of the cross-border repricing in one calculation. The per-line records are `CrossBorderPriceAdjustment`. */
4241
+ interface CrossBorderRepricingResult {
4165
4242
  /**
4166
- * Shipping region ID.
4167
- * @format GUID
4243
+ * Whether the calculation repriced the line items for the destination's tax.
4244
+ *
4245
+ * Default: `false`
4168
4246
  * @readonly
4169
4247
  */
4170
- id?: string;
4248
+ applied?: boolean;
4171
4249
  /**
4172
- * Shipping region name.
4173
- * @maxLength 100
4250
+ * ID of the tax region whose tax is built into the catalog prices, as used in this calculation.
4251
+ * @format GUID
4252
+ * @readonly
4174
4253
  */
4175
- name?: string;
4176
- }
4177
- interface SelectedCarrierServiceOption {
4254
+ baseTaxRegionId?: string | null;
4178
4255
  /**
4179
- * Unique identifier of selected option. For example, "usps_std_overnight".
4180
- * @maxLength 100
4256
+ * App ID of the base region's tax calculator.
4257
+ * @format GUID
4258
+ * @readonly
4181
4259
  */
4182
- code?: string;
4260
+ baseCalculatorId?: string | null;
4183
4261
  /**
4184
- * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
4185
- * For example, "Standard" or "First-Class Package International".
4186
- * @maxLength 250
4262
+ * Why the calculation didn't reprice. Set when `applied` is `false`, or when the line items were repriced and the shipping option or the fees were not.
4187
4263
  * @readonly
4188
4264
  */
4189
- title?: string;
4265
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
4190
4266
  /**
4191
- * Delivery logistics.
4267
+ * Mode the calculation ran in. `FULL` when the request set none. Callers copy it onto the order's tax info.
4192
4268
  * @readonly
4193
4269
  */
4194
- logistics?: DeliveryLogistics;
4270
+ mode?: CrossBorderRepricingModeWithLiterals;
4195
4271
  /**
4196
- * Shipping costs.
4272
+ * Request ID of the calculation, for log correlation.
4273
+ * @maxLength 100
4197
4274
  * @readonly
4198
4275
  */
4199
- cost?: SelectedCarrierServiceOptionPrices;
4276
+ requestId?: string | null;
4277
+ }
4278
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
4279
+ declare enum CrossBorderNotApplicableReason {
4280
+ /** The repricing feature toggle is off. */
4281
+ FEATURE_DISABLED = "FEATURE_DISABLED",
4282
+ /** The site hasn't opted in to cross-border repricing. */
4283
+ NOT_OPTED_IN = "NOT_OPTED_IN",
4284
+ /** The site's prices no longer include tax. */
4285
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
4286
+ /** The base tax region doesn't exist on the site. */
4287
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
4288
+ /** The base region uses the manual calculator and has no tax mapping. */
4289
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
4290
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
4291
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
4292
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
4293
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
4294
+ /** The line items were repriced. Repricing the shipping option failed. */
4295
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
4296
+ /** The line items were repriced. Repricing the additional fees failed. */
4297
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
4298
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
4299
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
4300
+ }
4301
+ /** @enumType */
4302
+ type CrossBorderNotApplicableReasonWithLiterals = CrossBorderNotApplicableReason | 'FEATURE_DISABLED' | 'NOT_OPTED_IN' | 'TAX_INCLUSIVE_PRICING_OFF' | 'BASE_TAX_REGION_NOT_FOUND' | 'BASE_REGION_HAS_NO_MANUAL_MAPPING' | 'EMBEDDED_RATE_MISSING' | 'CROSS_BORDER_REPRICING_FAILED' | 'SHIPPING_REPRICING_FAILED' | 'FEES_REPRICING_FAILED' | 'SETTINGS_UNAVAILABLE';
4303
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
4304
+ declare enum CrossBorderRepricingMode {
4305
+ /** Nothing is repriced. */
4306
+ DISABLED = "DISABLED",
4307
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
4308
+ STRIP_ONLY = "STRIP_ONLY",
4309
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
4310
+ FULL = "FULL"
4311
+ }
4312
+ /** @enumType */
4313
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
4314
+ interface CreateCartRequest {
4315
+ /** Cart to create. */
4316
+ cart?: Cart;
4200
4317
  /**
4201
- * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
4202
- * @readonly
4318
+ * Catalog items to add to the cart.
4319
+ * @maxSize 300
4203
4320
  */
4204
- requestedShippingOption?: boolean;
4321
+ catalogItems?: CatalogItemInput[];
4205
4322
  /**
4206
- * Other charges
4207
- * @deprecated Other charges
4208
- * @replacedBy additional_fees
4209
- * @targetRemovalDate 2025-10-01
4323
+ * Custom items to add to the cart.
4324
+ * Custom line items don't trigger the Catalog service plugin.
4325
+ * @maxSize 300
4210
4326
  */
4211
- otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
4327
+ customItems?: CustomItemInput[];
4212
4328
  /**
4213
- * This carrier's unique ID
4214
- * @format GUID
4329
+ * Coupons to apply.
4330
+ * Currently only one is supported.
4331
+ * @maxSize 1
4215
4332
  */
4216
- carrierId?: string | null;
4333
+ coupons?: CouponInput[];
4334
+ /** Delivery method to set. */
4335
+ deliveryMethod?: DeliveryMethodInput;
4217
4336
  /**
4218
- * Delivery solution allocations to different delivery carriers and delivery regions
4219
- * @maxSize 300
4337
+ * Gift cards to add.
4338
+ * @maxSize 5
4220
4339
  */
4221
- deliveryAllocations?: DeliveryAllocation[];
4222
- /** If the delivery solution is a partial and doesn't apply to all items. */
4223
- partial?: boolean | null;
4340
+ giftCards?: GiftCardInput[];
4224
4341
  }
4225
- interface DeliveryLogistics {
4342
+ interface CatalogItemInput {
4343
+ /** Reference to the catalog item. */
4344
+ catalogReference?: CatalogReference;
4226
4345
  /**
4227
- * Expected delivery time, in free text. For example, "3-5 business days".
4228
- * @maxLength 500
4346
+ * Number of catalog items the customer requested.
4347
+ * @min 1
4348
+ * @max 100000
4229
4349
  */
4230
- deliveryTime?: string | null;
4350
+ quantity?: number;
4231
4351
  /**
4232
- * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
4233
- * @maxLength 1000
4352
+ * Selected membership used as payment for this item.
4353
+ *
4354
+ * DEPRECATED: migrate to `membershipPayment`. Removed once all clients migrate.
4355
+ * @deprecated
4356
+ * @replacedBy membership_payment
4357
+ * @targetRemovalDate 2026-06-22
4234
4358
  */
4235
- instructions?: string | null;
4236
- /** Pickup details. */
4237
- pickupDetails?: PickupDetails;
4238
- }
4239
- interface PickupDetails {
4240
- /** Pickup address. */
4241
- address?: Address;
4359
+ selectedMembership?: V2SelectedMembership;
4360
+ /** Overriding values for catalog item properties. */
4361
+ catalogOverrideFields?: CatalogOverrideFields;
4242
4362
  /**
4243
- * Whether the pickup address is that of a business - this may effect tax calculation.
4244
- * @deprecated
4363
+ * Custom extended fields for the line item object.
4364
+ *
4365
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the Checkout & Orders - Line Items Schema Plugin in the app dashboard before they can be accessed with API calls.
4245
4366
  */
4246
- businessLocation?: boolean;
4247
- /** Pickup method */
4248
- pickupMethod?: PickupMethodWithLiterals;
4249
- }
4250
- declare enum PickupMethod {
4251
- STORE_PICKUP = "STORE_PICKUP",
4252
- PICKUP_POINT = "PICKUP_POINT"
4253
- }
4254
- /** @enumType */
4255
- type PickupMethodWithLiterals = PickupMethod | 'STORE_PICKUP' | 'PICKUP_POINT';
4256
- interface DeliveryTimeSlot {
4257
- /** starting time of the delivery time slot */
4258
- from?: Date | null;
4259
- /** ending time of the delivery time slot */
4260
- to?: Date | null;
4261
- }
4262
- interface SelectedCarrierServiceOptionPrices {
4263
- /** Total shipping price, after discount and after tax. */
4264
- totalPriceAfterTax?: MultiCurrencyPrice;
4265
- /** Total price of shipping after discounts (when relevant), and before tax. */
4266
- totalPriceBeforeTax?: MultiCurrencyPrice;
4267
- /** Tax details. */
4268
- taxDetails?: ItemTaxFullDetails;
4269
- /** Shipping discount before tax. */
4270
- totalDiscount?: MultiCurrencyPrice;
4271
- /** Shipping price before discount and before tax. */
4272
- price?: MultiCurrencyPrice;
4273
- }
4274
- interface SelectedCarrierServiceOptionOtherCharge {
4275
- /** Type of additional cost. */
4276
- type?: ChargeTypeWithLiterals;
4367
+ extendedFields?: ExtendedFields;
4277
4368
  /**
4278
- * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
4279
- * @maxLength 200
4369
+ * ID of the app managing inventory.
4370
+ * @format GUID
4280
4371
  */
4281
- details?: string | null;
4282
- /** Price of added charge. */
4283
- cost?: SelectedCarrierServiceOptionPrices;
4372
+ inventoryAppId?: string | null;
4373
+ /**
4374
+ * Membership used as payment for this item. Can be an existing membership, or a future one
4375
+ * created from a plan in the same cart.
4376
+ *
4377
+ * Replaces `selectedMembership`.
4378
+ *
4379
+ * Use with `paymentOption` `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
4380
+ */
4381
+ membershipPayment?: MembershipInput;
4284
4382
  }
4285
- declare enum ChargeType {
4286
- HANDLING_FEE = "HANDLING_FEE",
4287
- INSURANCE = "INSURANCE"
4383
+ interface MembershipInput extends MembershipInputMembershipOneOf {
4384
+ /** Pay with an existing, already-provisioned membership. */
4385
+ existingMembership?: ExistingMembershipInput;
4386
+ /** Pay with a future membership, created once a plan in this cart is purchased. */
4387
+ futureMembership?: FutureMembershipInput;
4288
4388
  }
4289
- /** @enumType */
4290
- type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
4291
- interface DeliveryAllocation {
4292
- /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
4293
- deliveryCarrier?: Carrier;
4294
- /** The delivery region that are relevant for this delivery solution. */
4295
- deliveryRegion?: Region;
4296
- /** Populated if the delivery solution is a partially supplied by this carrier. */
4297
- applicableLineItems?: ApplicableLineItems;
4389
+ /** @oneof */
4390
+ interface MembershipInputMembershipOneOf {
4391
+ /** Pay with an existing, already-provisioned membership. */
4392
+ existingMembership?: ExistingMembershipInput;
4393
+ /** Pay with a future membership, created once a plan in this cart is purchased. */
4394
+ futureMembership?: FutureMembershipInput;
4298
4395
  }
4299
- interface Carrier {
4396
+ interface ExistingMembershipInput {
4300
4397
  /**
4301
- * The carrier app id
4398
+ * ID of the app providing the membership, for example Pricing Plans.
4302
4399
  * @format GUID
4303
4400
  */
4304
- appId?: string | null;
4401
+ appId?: string;
4305
4402
  /**
4306
- * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
4307
- * @maxLength 250
4403
+ * ID of the existing membership.
4404
+ * @minLength 1
4405
+ * @maxLength 200
4308
4406
  */
4309
- code?: string;
4407
+ membershipId?: string;
4310
4408
  }
4311
- interface Region {
4409
+ interface FutureMembershipInput {
4312
4410
  /**
4313
- * The delivery region id.
4411
+ * ID of the plan line item, already in the cart, whose future membership pays for this item.
4412
+ * Add the plan line item to the cart first, then reference it by its ID.
4314
4413
  * @format GUID
4315
4414
  */
4316
- id?: string | null;
4415
+ lineItemId?: string;
4317
4416
  /**
4318
- * The delivery region name.
4319
- * @maxLength 100
4417
+ * The selected unit within the plan to redeem.
4418
+ * @maxLength 200
4320
4419
  */
4321
- name?: string | null;
4420
+ benefitId?: string;
4322
4421
  }
4323
- interface ApplicableLineItems {
4422
+ interface CustomItemInput {
4423
+ /** Display name for the line item. */
4424
+ name?: TranslatableString;
4425
+ /** Quantity details for the line item. */
4426
+ quantityInfo?: CustomItemQuantityInfo;
4427
+ /** Pricing details for the line item. */
4428
+ pricing?: CustomItemPricingInfo;
4429
+ /** Information about the line item's origin. */
4430
+ source?: CustomItemSource;
4431
+ /** Display details for the item. */
4432
+ attributes?: CustomItemAttributes;
4433
+ /** Delivery configuration for the line item. */
4434
+ deliveryConfig?: CustomItemDeliveryConfig;
4435
+ /** Tax configuration for the line item. */
4436
+ taxConfig?: CustomItemTaxConfig;
4437
+ /** Payment configuration for the line item. */
4438
+ paymentConfig?: CustomItemPaymentConfig;
4324
4439
  /**
4325
- * Line items that the delivery solution is for.
4326
- * @maxSize 300
4327
- * @minLength 1
4328
- * @maxLength 100
4440
+ * Modifier groups added to the item.
4441
+ * @maxSize 25
4329
4442
  */
4330
- lineItemIds?: string[];
4443
+ modifierGroups?: ModifierGroup[];
4331
4444
  }
4332
- interface CarrierServiceOption {
4445
+ interface CustomItemQuantityInfo {
4333
4446
  /**
4334
- * Carrier ID.
4335
- * @format GUID
4447
+ * Quantity the customer requested.
4448
+ * @min 1
4449
+ * @max 100000
4336
4450
  */
4337
- carrierId?: string;
4338
- /** Shipping options offered by this carrier for this request. */
4339
- shippingOptions?: ShippingOption[];
4451
+ requestedQuantity?: number;
4452
+ /** Maximum quantity available for purchase. */
4453
+ availableQuantity?: number | null;
4454
+ /**
4455
+ * Whether the line item quantity is fixed and can't be changed.
4456
+ *
4457
+ * Default: `false`
4458
+ */
4459
+ fixedQuantity?: boolean;
4340
4460
  }
4341
- interface ShippingOption {
4461
+ interface CustomItemPricingInfo {
4342
4462
  /**
4343
- * Unique code of provided shipping option like "usps_std_overnight".
4344
- * For legacy calculators this would be the UUID of the option.
4345
- * @maxLength 100
4463
+ * Sale price for a single item, without modifiers.
4464
+ * Includes tax when `taxInfo.pricesIncludeTax` is true.
4346
4465
  */
4347
- code?: string;
4466
+ price?: ConvertedMoney;
4348
4467
  /**
4349
- * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
4350
- * For example, "Standard" or "First-Class Package International".
4351
- * @maxLength 250
4468
+ * Full price for a single item before discounts, without modifiers.
4469
+ * Defaults to `price` when not provided.
4470
+ * Includes tax when `taxInfo.pricesIncludeTax` is true.
4352
4471
  */
4353
- title?: string;
4354
- /** Delivery logistics. */
4355
- logistics?: DeliveryLogistics;
4356
- /** Sipping price information. */
4357
- cost?: ShippingPrice;
4472
+ fullPrice?: ConvertedMoney;
4358
4473
  /**
4359
- * Delivery solution allocations to different delivery carriers and delivery regions
4360
- * @maxSize 300
4474
+ * Additional price description.
4475
+ * For example, when the price is `0` but you need more detail, such as "Starts at $67".
4361
4476
  */
4362
- deliveryAllocations?: DeliveryAllocation[];
4363
- /** If the delivery solution is a partial and doesn't apply to all items. */
4364
- partial?: boolean | null;
4365
- }
4366
- interface ShippingPrice {
4367
- /** Shipping price. */
4368
- price?: MultiCurrencyPrice;
4369
- /** Other costs such as insurance, handling & packaging for fragile items, etc. */
4370
- otherCharges?: OtherCharge[];
4477
+ priceDescription?: PriceDescription;
4478
+ /** Whether the price isn't yet defined and will be updated after the order is created. */
4479
+ priceUndetermined?: boolean;
4371
4480
  }
4372
- interface OtherCharge {
4373
- /** Type of additional cost. */
4374
- type?: ChargeTypeWithLiterals;
4375
- /** Price of added cost. */
4376
- price?: MultiCurrencyPrice;
4481
+ interface CustomItemSource {
4377
4482
  /**
4378
- * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
4379
- * @maxLength 250
4483
+ * Catalog and item reference: IDs for the item and catalog, plus optional details.
4484
+ * Optional for custom line items, which don't trigger the Catalog service plugin.
4380
4485
  */
4381
- details?: string | null;
4382
- }
4383
- interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
4384
- /** General shipping calculation error. */
4385
- generalShippingCalculationError?: Details;
4386
- /** Errors related to the delivery carrier. */
4387
- carrierErrors?: CarrierErrors;
4388
- /** Error related to the selected shipping option. */
4389
- selectedShippingOptionError?: Details;
4390
- /** Tax calculation error. */
4391
- taxCalculationError?: Details;
4392
- /** Coupon calculation error. */
4393
- couponCalculationError?: Details;
4486
+ catalogReference?: CatalogReference;
4394
4487
  /**
4395
- * DEPRECATED: Use gift_card_calculation_errors instead.
4396
- * @deprecated DEPRECATED: Use gift_card_calculation_errors instead.
4397
- * @replacedBy gift_card_calculation_errors
4398
- * @targetRemovalDate 2026-12-01
4488
+ * When `catalogReference.catalogItemId` isn't the actual catalog item ID, this field returns the true catalog item ID.
4489
+ * For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID, so this value is the service ID.
4490
+ * In most cases, this matches `catalogReference.catalogItemId`.
4491
+ * Used in membership validation.
4492
+ * @minLength 1
4493
+ * @maxLength 36
4399
4494
  */
4400
- giftCardCalculationError?: Details;
4401
- /** Order validation errors. */
4402
- orderValidationErrors?: ApplicationError[];
4495
+ rootCatalogItemId?: string | null;
4403
4496
  /**
4404
- * Membership payment methods calculation errors
4405
- * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
4497
+ * ID of the app managing inventory.
4498
+ * @format GUID
4406
4499
  */
4407
- membershipError?: Details;
4408
- /** Discount Rule calculation error. */
4409
- discountsCalculationError?: Details;
4410
- }
4411
- /** @oneof */
4412
- interface CalculationErrorsShippingCalculationErrorOneOf {
4413
- /** General shipping calculation error. */
4414
- generalShippingCalculationError?: Details;
4415
- /** Errors related to the delivery carrier. */
4416
- carrierErrors?: CarrierErrors;
4417
- /** Error related to the selected shipping option. */
4418
- selectedShippingOptionError?: Details;
4419
- }
4420
- interface CarrierErrors {
4421
- /** Carrier errors. */
4422
- errors?: CarrierError[];
4423
- }
4424
- interface CarrierError {
4425
- /** Carrier ID. */
4426
- carrierId?: string;
4427
- /** Error details. */
4428
- error?: Details;
4429
- }
4430
- interface GiftCardCalculationError {
4431
- /** Gift card code with most characters masked for security. */
4432
- obfuscatedCode?: string;
4433
- /** Error details. */
4434
- error?: Details;
4500
+ inventoryAppId?: string | null;
4435
4501
  }
4436
- interface MembershipOptions {
4502
+ interface CustomItemAttributes {
4437
4503
  /**
4438
- * List of payment options that can be used.
4439
- * Populated by the legacy ListEligibleMemberships flow.
4440
- * @maxSize 300
4441
- * @deprecated List of payment options that can be used.
4442
- * Populated by the legacy ListEligibleMemberships flow.
4443
- * @replacedBy validated_existing_memberships
4444
- * @targetRemovalDate 2026-10-01
4504
+ * Description lines for the item.
4505
+ * @maxSize 100
4445
4506
  */
4446
- eligibleMemberships?: Membership[];
4507
+ descriptionLines?: DescriptionLine[];
4508
+ /** Item image. */
4509
+ image?: Image;
4510
+ /** URL of the item's page on the site. */
4511
+ url?: PageUrlV2;
4512
+ /** Item type: preset or custom. */
4513
+ itemType?: ItemType;
4447
4514
  /**
4448
- * List of payment options that are owned by the member, but cannot be used due to reason provided.
4449
- * Populated by the legacy ListEligibleMemberships flow.
4450
- * @maxSize 300
4451
- * @deprecated List of payment options that are owned by the member, but cannot be used due to reason provided.
4452
- * Populated by the legacy ListEligibleMemberships flow.
4453
- * @replacedBy validated_existing_memberships
4454
- * @targetRemovalDate 2026-10-01
4515
+ * Physical properties of the item.
4516
+ * When relevant, includes SKU, weight, and shippability.
4455
4517
  */
4456
- invalidMemberships?: InvalidMembership[];
4518
+ physicalProperties?: PhysicalProperties;
4457
4519
  /**
4458
- * The selected membership payment options and which line items they apply to.
4459
- * Populated by the legacy ListEligibleMemberships flow.
4460
- * @maxSize 300
4461
- * @deprecated The selected membership payment options and which line items they apply to.
4462
- * Populated by the legacy ListEligibleMemberships flow.
4463
- * @replacedBy validated_existing_memberships
4464
- * @targetRemovalDate 2026-10-01
4520
+ * Service properties.
4521
+ * When relevant, includes date and number of participants.
4522
+ */
4523
+ serviceProperties?: ServiceProperties;
4524
+ /**
4525
+ * Whether the item can only be purchased by site members.
4526
+ *
4527
+ * Default: `false`
4528
+ */
4529
+ membersOnly?: boolean;
4530
+ /** Subscription option details. */
4531
+ subscriptionInfo?: SubscriptionOptionInfo;
4532
+ }
4533
+ interface CustomItemDeliveryConfig {
4534
+ /**
4535
+ * Delivery profile ID.
4536
+ * @format GUID
4537
+ */
4538
+ deliveryProfileId?: string | null;
4539
+ }
4540
+ interface CustomItemTaxConfig {
4541
+ /** Address used for tax calculation. */
4542
+ taxableAddress?: TaxableAddress;
4543
+ /**
4544
+ * Tax group ID for this line item.
4545
+ * @maxLength 50
4465
4546
  */
4466
- selectedMemberships?: SelectedMembership[];
4547
+ taxGroupId?: string | null;
4467
4548
  }
4468
- interface Membership {
4549
+ interface CustomItemPaymentConfig {
4469
4550
  /**
4470
- * Membership ID.
4471
- * @minLength 1
4472
- * @maxLength 200
4551
+ * Partial payment due upfront during checkout.
4552
+ * Only when `paymentOption` is `DEPOSIT_ONLINE`.
4473
4553
  */
4474
- id?: string;
4554
+ depositAmount?: ConvertedMoney;
4475
4555
  /**
4476
- * ID of the application providing this payment option.
4477
- * @format GUID
4556
+ * Selected payment option type for this item.
4557
+ *
4558
+ * Default: `FULL_PAYMENT_ONLINE`
4478
4559
  */
4479
- appId?: string;
4480
- /** The name of this membership. */
4481
- name?: MembershipName;
4560
+ paymentOption?: PaymentOptionTypeWithLiterals;
4561
+ }
4562
+ interface PlatformFee {
4563
+ /** __Required.__ Platform fee name. */
4564
+ name?: TranslatableString;
4565
+ /** Platform fee charge type. */
4566
+ chargeType?: V1PlatformFeeChargeTypeWithLiterals;
4482
4567
  /**
4483
- * Deprecated. Use `ExistingMembership.covered_line_items` to see which line items this membership covers.
4568
+ * Percentage rate charged as platform fee.
4484
4569
  *
4485
- * Only populated in the legacy `ListEligibleMemberships` flow, which still requires it. Empty on
4486
- * `ListMembershipsByIds`, a by-id lookup that receives no line items to report against.
4487
- * @maxSize 300
4488
- * @minLength 1
4489
- * @maxLength 100
4570
+ * The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
4571
+ * @format DECIMAL_VALUE
4572
+ * @decimalValue options { gt:0, lte:1, maxScale:4 }
4490
4573
  */
4491
- lineItemIds?: string[];
4492
- /** Membership's payment credits (balance information). */
4493
- credits?: MembershipPaymentCredits;
4494
- /** Membership expiration date. */
4495
- expirationDate?: Date | null;
4574
+ percentageRate?: string;
4575
+ }
4576
+ declare enum V1PlatformFeeChargeType {
4577
+ /** The platform fee is passed on to the customer. */
4578
+ PASS_ON = "PASS_ON",
4579
+ /** The platform fee is absorbed by the merchant. */
4580
+ ABSORBED = "ABSORBED"
4581
+ }
4582
+ /** @enumType */
4583
+ type V1PlatformFeeChargeTypeWithLiterals = V1PlatformFeeChargeType | 'PASS_ON' | 'ABSORBED';
4584
+ interface CouponInput {
4496
4585
  /**
4497
- * Deprecated. Use `offering_description`.
4498
- * @deprecated
4499
- * @replacedBy offering_description
4500
- * @targetRemovalDate 2026-08-30
4586
+ * Coupon code.
4587
+ * @minLength 1
4588
+ * @maxLength 50
4501
4589
  */
4502
- additionalData?: Record<string, any> | null;
4590
+ code?: string;
4503
4591
  }
4504
- interface MembershipName {
4592
+ interface DeliveryMethodInput {
4505
4593
  /**
4506
- * Membership name in the site's original language.
4594
+ * Delivery method code.
4507
4595
  * @maxLength 100
4508
4596
  */
4509
- original?: string;
4597
+ code?: string;
4510
4598
  /**
4511
- * Membership name translated into the buyer's language.
4512
- *
4513
- * Default: The value of `original`
4514
- * @maxLength 100
4599
+ * Carrier app id.
4600
+ * @format GUID
4515
4601
  */
4516
- translated?: string | null;
4602
+ appId?: string | null;
4517
4603
  }
4518
- interface MembershipPaymentCredits {
4604
+ interface GiftCardInput {
4519
4605
  /**
4520
- * Membership's initial balance.
4521
- * @min 1
4606
+ * Gift card code.
4607
+ * @minLength 8
4608
+ * @maxLength 20
4522
4609
  */
4523
- total?: number;
4524
- /** Membership's remaining balance. */
4525
- remaining?: number;
4610
+ code?: string;
4611
+ /** The amount requested to redeem from this gift card. */
4612
+ redeemAmount?: ConvertedMoney;
4613
+ }
4614
+ interface CreateCartResponse {
4615
+ /** Created cart. */
4616
+ cart?: Cart;
4617
+ }
4618
+ interface ItemNotFoundInCatalogErrorData {
4526
4619
  /**
4527
- * How the membership's balance is measured.
4528
- *
4529
- * Use the same value as `Benefit.quota.limitedQuota.limitedQuotaType` for the benefit this membership came from in [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans). This way the balance keeps the same unit before and after purchase.
4530
- *
4531
- * Default: `PUNCH_CARD`.
4620
+ * Line items missing from the catalog.
4621
+ * @maxSize 300
4532
4622
  */
4533
- balanceType?: BalanceTypeWithLiterals;
4534
- }
4535
- declare enum BalanceType {
4536
- /** Balance is measured in discrete uses, such as sessions or visits. */
4537
- PUNCH_CARD = "PUNCH_CARD",
4538
- /** Balance is measured in a currency-like value, such as points. */
4539
- CREDIT = "CREDIT"
4623
+ invalidItems?: LineItemIdentifier[];
4540
4624
  }
4541
- /** @enumType */
4542
- type BalanceTypeWithLiterals = BalanceType | 'PUNCH_CARD' | 'CREDIT';
4543
- interface InvalidMembership {
4544
- /** Membership details. */
4545
- membership?: Membership;
4625
+ interface LineItemIdentifier extends LineItemIdentifierIdOneOf {
4546
4626
  /**
4547
- * Reason why this membership is invalid and cannot be used.
4548
- * @minLength 1
4549
- * @maxLength 100
4627
+ * Line item ID.
4628
+ * @format GUID
4550
4629
  */
4551
- reason?: string;
4630
+ lineItemId?: string;
4631
+ /** Catalog reference. */
4632
+ catalogReference?: CatalogReference;
4552
4633
  }
4553
- /** The validated existing memberships. Same shape as `ListExistingMembershipsResponse.memberships`. */
4554
- interface ValidatedExistingMemberships {
4634
+ /** @oneof */
4635
+ interface LineItemIdentifierIdOneOf {
4555
4636
  /**
4556
- * The selected memberships, each paired with the line items it can pay for and the cost to redeem
4557
- * each.
4558
- * @maxSize 300
4637
+ * Line item ID.
4638
+ * @format GUID
4559
4639
  */
4560
- memberships?: ExistingMembership[];
4640
+ lineItemId?: string;
4641
+ /** Catalog reference. */
4642
+ catalogReference?: CatalogReference;
4561
4643
  }
4562
- /**
4563
- * A membership the member owns, together with the given line items it can pay for.
4564
- *
4565
- * A membership is a single benefit granted by a plan the member has already paid for, so its coverage
4566
- * is nested directly here. No `benefitId` link is needed, unlike a plan that grants several benefits.
4567
- */
4568
- interface ExistingMembership {
4569
- /** The membership the member owns. */
4570
- membership?: V1Membership;
4644
+ interface InsufficientInventoryErrorData {
4571
4645
  /**
4572
- * Line items this membership can pay for, and the cost to redeem each.
4646
+ * Line items that don't have enough inventory.
4573
4647
  * @maxSize 300
4574
4648
  */
4575
- coveredLineItems?: CoveredLineItem[];
4649
+ invalidItems?: InsufficientInventoryEntry[];
4576
4650
  }
4577
- interface V1Membership {
4651
+ interface InsufficientInventoryEntry {
4578
4652
  /**
4579
- * Membership ID.
4580
- * @minLength 1
4581
- * @maxLength 200
4653
+ * Line item whose requested quantity exceeds the quantity available.
4654
+ *
4655
+ * Identified by `catalogReference` when the line item has one, otherwise by `lineItemId`.
4656
+ * For Create Cart and Add Line Items, and their Current Cart equivalents, `lineItemId` is
4657
+ * provisional: the request is rejected before the new line items are saved, so the ID doesn't
4658
+ * match any line item you can retrieve.
4582
4659
  */
4583
- id?: string;
4584
- /** Membership name. */
4585
- name?: MembershipName;
4660
+ id?: LineItemIdentifier;
4661
+ /** Requested quantity, including what's already on the cart. */
4662
+ requestedQuantity?: number;
4586
4663
  /**
4587
- * Deprecated. Use `ExistingMembership.coveredLineItems` to see which line items this membership
4588
- * covers.
4589
- *
4590
- * Populate this only in the legacy [List Eligible Memberships](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-eligible-memberships) flow, which still requires it and rejects a membership that omits it. Leave it empty everywhere else. [List Memberships By IDs](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-memberships-by-ids) receives no line items at all, so there's nothing to report there.
4591
- * @maxSize 300
4592
- * @minLength 1
4593
- * @maxLength 100
4594
- * @deprecated
4595
- * @replacedBy ExistingMembership.covered_line_items.line_item_id
4596
- * @targetRemovalDate 2026-08-30
4664
+ * Quantity available.
4665
+ * For a custom line item, the value set in `quantityInfo.availableQuantity`.
4597
4666
  */
4598
- lineItemIds?: string[];
4667
+ availableQuantity?: number;
4668
+ }
4669
+ interface MaxLineItemsExceededErrorData {
4670
+ /** Line item count in the request. */
4671
+ requestCount?: number;
4672
+ /** Maximum line items allowed. */
4673
+ maxCount?: number;
4674
+ }
4675
+ interface MaxItemModifiersExceededErrorData {
4676
+ /** Modifier count in the request. */
4677
+ requestCount?: number;
4678
+ /** Maximum modifiers allowed. */
4679
+ maxCount?: number;
4680
+ }
4681
+ interface DuplicateModifierGroupIdsErrorData {
4599
4682
  /**
4600
- * Membership's balance.
4601
- *
4602
- * Omit this field for an unlimited membership, which has no balance to draw down. Every
4603
- * `ExistingMembership.coveredLineItems.redemptionCost` is then `0`. Unlike a plan's benefit, a
4604
- * membership carries no explicit unlimited marker: the absence of a balance is the marker.
4683
+ * Catalog items whose modifier group IDs collide.
4684
+ * @maxSize 300
4605
4685
  */
4606
- credits?: MembershipPaymentCredits;
4607
- /** Date and time the membership expires. */
4608
- expirationDate?: Date | null;
4686
+ invalidItems?: CatalogReference[];
4687
+ }
4688
+ interface DuplicateItemModifierIdsErrorData {
4609
4689
  /**
4610
- * Deprecated. Use `offeringDescription` for human-readable data about the offering.
4611
- * @deprecated
4612
- * @replacedBy offering_description
4613
- * @targetRemovalDate 2026-08-30
4690
+ * Catalog items with duplicate modifier IDs in a group.
4691
+ * @maxSize 300
4614
4692
  */
4615
- additionalData?: Record<string, any> | null;
4693
+ invalidItems?: CatalogReference[];
4616
4694
  }
4617
- /** A line item a membership can pay for, and the cost to redeem it. */
4618
- interface CoveredLineItem {
4695
+ interface LineItemPriceConflictErrorData {
4619
4696
  /**
4620
- * ID of the line item this membership can pay for. Matches the `id` of one of the given line items.
4621
- * @minLength 1
4622
- * @maxLength 100
4697
+ * Catalog items whose price no longer matches, when present.
4698
+ * @maxSize 300
4623
4699
  */
4624
- lineItemId?: string;
4700
+ invalidItems?: CatalogReference[];
4701
+ }
4702
+ interface FixedQuantityItemErrorData {
4625
4703
  /**
4626
- * Amount deducted from the membership's remaining balance (`credits.remaining`) when this line item
4627
- * is redeemed.
4628
- *
4629
- * Always `0` for an unlimited membership, which is expressed by omitting `credits` and decrements
4630
- * nothing.
4704
+ * Line items that don't allow quantity changes.
4705
+ * @maxSize 300
4631
4706
  */
4632
- redemptionCost?: number;
4707
+ invalidItems?: LineItemIdentifier[];
4633
4708
  }
4634
- /** The validated purchasable plans. Same shape as `ListPurchasablePlansResponse`. */
4635
- interface ValidatedPurchasablePlans {
4709
+ interface InvalidMembershipPaymentOptionErrorData {
4636
4710
  /**
4637
- * The selected plans.
4711
+ * Line items with invalid membership payments.
4638
4712
  * @maxSize 300
4639
4713
  */
4640
- purchasablePlans?: PurchasablePlan[];
4714
+ invalidItems?: InvalidMembershipEntry[];
4715
+ }
4716
+ interface InvalidMembershipEntry {
4717
+ /** Line item with an invalid membership payment choice. */
4718
+ invalidItemId?: LineItemIdentifier;
4719
+ /** Membership the buyer tried to use. */
4720
+ selectedMembership?: V2SelectedMembership;
4721
+ }
4722
+ interface LineItemNotFoundInCartErrorData {
4641
4723
  /**
4642
- * How the plans' benefits cover the line items, each entry naming its benefit by `benefitId`.
4724
+ * Line item IDs that aren't in the cart.
4725
+ * @format GUID
4643
4726
  * @maxSize 300
4644
4727
  */
4645
- coverages?: LineItemCoverage[];
4728
+ lineItemIds?: string[];
4646
4729
  }
4647
- interface PurchasablePlan {
4730
+ interface DeliveryMethodNotFoundErrorData {
4648
4731
  /**
4649
- * Catalog and item reference identifying both the plan and the pricing variant.
4650
- *
4651
- * A purchasable plan has no ID of its own. The reference carries the plan in `catalogItemId` and
4652
- * the chosen pricing variant in `options`, so the same plan appears once per variant with a
4653
- * different reference each time. The plan ID alone repeats across entries; the full reference
4654
- * doesn't.
4655
- *
4656
- * When the plan needs nothing further from the buyer, the reference can be added to the cart as it
4657
- * stands. When it does, for example a plan carrying a form, a custom start date, or a buyer-chosen
4658
- * price, the reference has to be completed with that input first. See `infoCollectionUrl`.
4732
+ * Missing delivery method code.
4733
+ * @maxLength 100
4659
4734
  */
4660
- catalogReference?: CatalogReference;
4661
- /** Plan name. */
4662
- name?: MembershipName;
4735
+ code?: string;
4663
4736
  /**
4664
- * Benefits the plan grants once purchased.
4665
- *
4666
- * A plan can grant several, for example a bundle granting separate yoga and pilates credits. Each
4667
- * benefit becomes its own membership after purchase.
4668
- * @minSize 1
4669
- * @maxSize 50
4737
+ * Delivery method app ID, if applicable.
4738
+ * @maxLength 100
4670
4739
  */
4671
- benefits?: Benefit[];
4740
+ appId?: string | null;
4741
+ }
4742
+ interface GetCartRequest {
4672
4743
  /**
4673
- * Human-readable summary of what the plan offers, for display. For example, `8 yoga classes and 4
4674
- * pilates classes, billed monthly`.
4675
- *
4676
- * Describe the offering here and the price in `priceDescription`.
4677
- * @maxLength 500
4744
+ * Cart ID.
4745
+ * @format GUID
4678
4746
  */
4679
- offeringDescription?: string | null;
4747
+ cartId?: string;
4748
+ }
4749
+ interface GetCartResponse {
4750
+ /** Requested cart. */
4751
+ cart?: Cart;
4752
+ }
4753
+ interface GetUpsellOptionsRequest {
4680
4754
  /**
4681
- * URL of the page that collects the extra input this plan needs before it can be purchased.
4682
- *
4683
- * Return it only for a plan that needs more from the buyer, such as one carrying a form, a custom
4684
- * start date, or a buyer-chosen price. Omitting it means the plan needs nothing further, and the
4685
- * caller builds the cart itself.
4686
- *
4687
- * The buyer reaches this page before any cart exists, rather than from the checkout page, and
4688
- * there's no return trip. The page receives the caller's already-created items, then builds the
4689
- * cart and checkout from the plan plus those items. There's no return URL, no cart ID, no
4690
- * preserved selection, and no completion signal: the purchase reaches Wix through the ordinary
4691
- * checkout and order flow, and the membership through Membership Ready To Be Charged.
4692
- *
4693
- * The page covers a single plan. Items that plan covers can be mixed with directly-paid ones, but
4694
- * a selection spanning two plans isn't supported here.
4695
- * @format WEB_URL
4755
+ * Cart ID.
4756
+ * @format GUID
4696
4757
  */
4697
- infoCollectionUrl?: string | null;
4758
+ cartId?: string;
4759
+ }
4760
+ interface GetUpsellOptionsResponse {
4761
+ /** Upsell options available for the cart's line items. */
4762
+ itemsUpsells?: ItemUpsells[];
4763
+ }
4764
+ interface ItemUpsells {
4698
4765
  /**
4699
- * Plan price, in the plan's own configured currency.
4700
- *
4701
- * No currency accompanies the amount and none is converted, so prices from different plans aren't
4702
- * comparable and the currency reaches the buyer only through `priceDescription`. Name the currency
4703
- * there.
4704
- * @decimalValue options { gte:0, maxScale:3 }
4766
+ * Line item ID.
4767
+ * @format GUID
4705
4768
  */
4706
- price?: string;
4769
+ lineItemId?: string;
4707
4770
  /**
4708
- * Human-readable summary of the plan price, for display. For example, `First month free, then
4709
- * $20/month`.
4710
- *
4711
- * Use `price` for the bare amount, which is what sorting and comparison rely on, and this field for
4712
- * pricing a buyer needs prose to understand.
4713
- * @maxLength 500
4771
+ * Upsell options available for the line item.
4772
+ * @maxSize 10
4714
4773
  */
4715
- priceDescription?: string | null;
4774
+ upsells?: UpsellOption[];
4716
4775
  }
4717
4776
  /**
4718
- * A single redeemable benefit granted by a plan.
4719
- *
4720
- * A purchasable plan grants one or more benefits in `benefits`. Once the plan is paid for, each benefit
4721
- * becomes its own membership, charged by `membershipId`.
4777
+ * A single upsell offer for a line item.
4778
+ * Accepting it replaces the line item's catalog reference in place, keeping the same lineItemId.
4722
4779
  */
4723
- interface Benefit extends BenefitQuotaOneOf {
4724
- limitedQuota?: LimitedQuota;
4780
+ interface UpsellOption {
4725
4781
  /**
4726
- * Identifier for this benefit, unique within its plan.
4727
- *
4728
- * Not unique across the response. A plan is returned once per pricing variant, and every variant
4729
- * repeats that plan's benefit IDs. Two different plans can also share an ID when they grant the
4730
- * same benefit, and a coverage entry naming it is then true for both.
4731
- *
4732
- * Never give two different benefits the same ID. That's the one case a caller can't recover from,
4733
- * because a cost computed for one benefit would be applied to the other.
4734
- * @minLength 1
4735
- * @maxLength 200
4782
+ * Upsell option ID.
4783
+ * @format GUID
4736
4784
  */
4737
- benefitId?: string;
4785
+ id?: string;
4738
4786
  /**
4739
- * Human-readable label for this benefit. For example, `Manicure` or `Pedicure` on a multi-set
4740
- * punch card.
4787
+ * Title of the upsell option.
4741
4788
  * @maxLength 200
4742
4789
  */
4743
- label?: string | null;
4744
- /** Kind of quota this benefit grants. */
4745
- quotaType?: QuotaTypeWithLiterals;
4790
+ title?: string | null;
4791
+ /**
4792
+ * Description of the upsell option.
4793
+ * @maxLength 500
4794
+ */
4795
+ description?: string | null;
4796
+ /** Catalog reference of the item offered as an upsell to replace the existing one. */
4797
+ catalogReference?: CatalogReference;
4798
+ /** Metadata about the benefit of accepting this upsell option. */
4799
+ metadata?: UpsellBenefitMetadata;
4800
+ /** Price details of the upsell option. */
4801
+ priceDetails?: PriceDetails;
4746
4802
  }
4747
- /** @oneof */
4748
- interface BenefitQuotaOneOf {
4749
- limitedQuota?: LimitedQuota;
4803
+ interface UpsellBenefitMetadata {
4804
+ /** Benefit type. */
4805
+ benefitType?: BenefitTypeWithLiterals;
4806
+ /**
4807
+ * Benefit value. For percentage benefits, this is the percentage (e.g., "10" for 10%). For fixed amount/price benefits, this is the amount.
4808
+ * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
4809
+ */
4810
+ benefitValue?: string | null;
4750
4811
  }
4751
- declare enum QuotaType {
4752
- /** The benefit grants a countable quota that's drawn down on redemption. */
4753
- LIMITED = "LIMITED",
4754
- /** The benefit is unlimited and is never drawn down. */
4755
- UNLIMITED = "UNLIMITED"
4812
+ declare enum BenefitType {
4813
+ /** Percentage benefit. */
4814
+ PERCENTAGE = "PERCENTAGE",
4815
+ /** Fixed price benefit. */
4816
+ FIXED_PRICE = "FIXED_PRICE",
4817
+ /** Fixed amount benefit. */
4818
+ FIXED_AMOUNT = "FIXED_AMOUNT"
4756
4819
  }
4757
4820
  /** @enumType */
4758
- type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
4759
- /** A limited, countable redeemable amount. */
4760
- interface LimitedQuota {
4821
+ type BenefitTypeWithLiterals = BenefitType | 'PERCENTAGE' | 'FIXED_PRICE' | 'FIXED_AMOUNT';
4822
+ interface PriceDetails {
4823
+ /** @decimalValue options { gte:0, lte:1000000000000000 } */
4824
+ price?: string;
4825
+ /** @maxLength 200 */
4826
+ description?: string | null;
4827
+ }
4828
+ interface UpdateCartRequest {
4829
+ /** Cart to update. May be partial. */
4830
+ cart?: Cart;
4831
+ }
4832
+ interface UpdateCartResponse {
4833
+ /** Updated cart. */
4834
+ cart?: Cart;
4835
+ }
4836
+ interface CartAlreadyOrderedErrorData {
4761
4837
  /**
4762
- * Quota's initial value.
4763
- * @min 1
4838
+ * Cart already turned into an order.
4839
+ * @format GUID
4764
4840
  */
4765
- total?: number;
4766
- /** Quota's remaining value. */
4767
- remaining?: number;
4841
+ cartId?: string;
4768
4842
  /**
4769
- * How the quota is measured.
4770
- *
4771
- * The same vocabulary as `MembershipPaymentCredits.balanceType` on the existing-membership side.
4843
+ * Matching order ID.
4844
+ * @format GUID
4772
4845
  */
4773
- limitedQuotaType?: LimitedQuotaTypeWithLiterals;
4846
+ orderId?: string;
4774
4847
  }
4775
- declare enum LimitedQuotaType {
4776
- /** Quota is measured in discrete uses, such as sessions or visits. */
4777
- PUNCH_CARD = "PUNCH_CARD",
4778
- /** Quota is measured in a currency-like value, such as points. */
4779
- CREDIT = "CREDIT"
4848
+ interface DeleteCartRequest {
4849
+ /**
4850
+ * Cart ID.
4851
+ * @format GUID
4852
+ */
4853
+ cartId?: string;
4780
4854
  }
4781
- /** @enumType */
4782
- type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
4783
- /**
4784
- * Maps one of a plan's benefits to a line item it can cover, and at what cost.
4785
- *
4786
- * One entry per benefit and line item pair, returned by [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans) alongside `purchasablePlans`.
4787
- *
4788
- * An entry names a benefit and carries no plan identity, so match its `benefitId` against the
4789
- * `benefits` of the returned plans and apply it to every entry that grants that benefit. Entries for
4790
- * the same plan repeat it once per pricing variant, and two different plans sharing a benefit ID
4791
- * grant the same benefit, so the entry holds for each of them. A caller that stops at the first
4792
- * match shows nothing incorrect, but hides the other entries, which cover the item too.
4793
- *
4794
- * The cost is identical across a plan's variants, so there's one entry per benefit rather than one
4795
- * per variant.
4796
- *
4797
- * For memberships the member already owns, the equivalent mapping is
4798
- * `ExistingMembership.coveredLineItems`, which needs no `benefitId` because a membership is a single
4799
- * benefit.
4800
- */
4801
- interface LineItemCoverage {
4855
+ interface DeleteCartResponse {
4856
+ }
4857
+ interface RefreshCartRequest {
4802
4858
  /**
4803
- * ID of the benefit that covers the line item, as returned in `Benefit.benefitId`.
4804
- *
4805
- * Identifies a benefit within its plan, and repeats across that plan's pricing variants.
4806
- * @minLength 1
4807
- * @maxLength 200
4859
+ * Cart ID.
4860
+ * @format GUID
4808
4861
  */
4809
- benefitId?: string;
4862
+ cartId?: string;
4863
+ }
4864
+ interface RefreshCartResponse {
4865
+ /** Refreshed cart. */
4866
+ cart?: Cart;
4867
+ }
4868
+ interface EstimateCartRequest {
4810
4869
  /**
4811
- * ID of the line item this benefit covers.
4812
- * @minLength 1
4813
- * @maxLength 100
4870
+ * Cart ID.
4871
+ * @format GUID
4814
4872
  */
4815
- lineItemId?: string;
4873
+ cartId?: string;
4874
+ /**
4875
+ * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before estimating the cart.
4876
+ *
4877
+ * Default: `false`.
4878
+ */
4879
+ refreshCart?: boolean;
4880
+ /** Level of business validation to run during estimation via the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction). */
4881
+ validationConfig?: ValidationsConfigWithLiterals;
4816
4882
  /**
4817
- * Amount deducted from the benefit's `limitedQuota.remaining` value when this line item is redeemed.
4883
+ * Whether to calculate delivery costs.
4818
4884
  *
4819
- * Always `0` for an unlimited benefit, which decrements nothing.
4885
+ * Default: `false`.
4820
4886
  */
4821
- redemptionCost?: number;
4822
- }
4823
- interface AdditionalFee {
4887
+ calculateDelivery?: boolean;
4824
4888
  /**
4825
- * Additional fee's unique code (or ID) for future processing.
4826
- * @minLength 1
4827
- * @maxLength 100
4889
+ * Whether to calculate additional fees.
4890
+ *
4891
+ * Default: `false`.
4828
4892
  */
4829
- code?: string | null;
4893
+ calculateAdditionalFees?: boolean;
4830
4894
  /**
4831
- * Additional fee's name.
4832
- * @minLength 1
4833
- * @maxLength 50
4895
+ * Whether to calculate tax.
4896
+ *
4897
+ * Default: `false`.
4834
4898
  */
4835
- name?: string;
4836
- /** Additional fee's price. */
4837
- price?: MultiCurrencyPrice;
4838
- /** Tax details. */
4839
- taxDetails?: ItemTaxFullDetails;
4899
+ calculateTax?: boolean;
4840
4900
  /**
4841
- * Provider's app id.
4842
- * @minLength 1
4843
- * @maxLength 100
4901
+ * Whether to include the effect of gift card balances on the cart total.
4902
+ * Gift cards aren't redeemed; balances are reflected for estimation only.
4903
+ *
4904
+ * Default: `false`.
4844
4905
  */
4845
- providerAppId?: string | null;
4846
- /** Additional fee's price before tax. */
4847
- priceBeforeTax?: MultiCurrencyPrice;
4848
- /** Additional fee's price after tax. */
4849
- priceAfterTax?: MultiCurrencyPrice;
4906
+ calculateGiftCards?: boolean;
4907
+ }
4908
+ declare enum ValidationsConfig {
4909
+ /** No business validations are performed. */
4910
+ SKIP_VALIDATIONS = "SKIP_VALIDATIONS",
4911
+ /** Perform cart-level business validations as defined by the service plugin implementer. */
4912
+ PRE_CHECKOUT_VALIDATIONS = "PRE_CHECKOUT_VALIDATIONS",
4913
+ /** Perform checkout-specific business validations as defined by the service plugin implementer. */
4914
+ CHECKOUT_VALIDATIONS = "CHECKOUT_VALIDATIONS"
4915
+ }
4916
+ /** @enumType */
4917
+ type ValidationsConfigWithLiterals = ValidationsConfig | 'SKIP_VALIDATIONS' | 'PRE_CHECKOUT_VALIDATIONS' | 'CHECKOUT_VALIDATIONS';
4918
+ interface EstimateCartResponse {
4919
+ /** Cart with estimated values. */
4920
+ cart?: Cart;
4921
+ /** Estimation summary. */
4922
+ summary?: CartSummary;
4923
+ }
4924
+ interface CalculateCartRequest {
4850
4925
  /**
4851
- * Optional - Line items associated with this additional fee.
4852
- * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
4926
+ * Cart ID.
4853
4927
  * @format GUID
4854
4928
  */
4855
- lineItemIds?: string[];
4856
- /** the source the additional fee was added from */
4857
- source?: AdditionalFeeSourceWithLiterals;
4929
+ cartId?: string;
4858
4930
  /**
4859
- * The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
4860
- * @minLength 1
4861
- * @maxLength 50
4931
+ * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
4932
+ *
4933
+ * Default: `false`.
4862
4934
  */
4863
- translatedName?: string | null;
4864
- /** Address type tax was calculated against for this fee. */
4865
- taxableAddress?: TaxableAddress;
4935
+ refreshCart?: boolean;
4866
4936
  }
4867
- declare enum AdditionalFeeSource {
4868
- UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
4869
- /** The additional fee was added by an additional fee service plugin */
4870
- SERVICE_PLUGIN = "SERVICE_PLUGIN",
4871
- /** The additional fee was added on the item either via the catalog or on custom line item */
4872
- ITEM = "ITEM",
4873
- /** The additional fee was added manually on the request */
4874
- MANUAL = "MANUAL",
4875
- /** The additional fee was added by the shipping provider */
4876
- SHIPPING = "SHIPPING",
4877
- /** The additional fee was added by a Wix vertical and represents a Wix platform fee */
4878
- PLATFORM = "PLATFORM"
4937
+ interface CalculateCartResponse {
4938
+ /** Cart with calculated values. */
4939
+ cart?: Cart;
4940
+ /** Calculation summary. */
4941
+ summary?: CartSummary;
4879
4942
  }
4880
- /** @enumType */
4881
- type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING' | 'PLATFORM';
4882
- interface PlatformFeeSummary {
4883
- /** Total platform fee amount. */
4884
- total?: MultiCurrencyPrice;
4885
- /** Total platform fee passed on to the customer. */
4886
- totalPassOn?: MultiCurrencyPrice;
4887
- /** Total platform fee absorbed by the merchant. */
4888
- totalAbsorbed?: MultiCurrencyPrice;
4943
+ interface CalculateCartForV1Request {
4889
4944
  /**
4890
- * Calculated platform fees.
4891
- * @maxSize 100
4945
+ * ID of the Cart to calculate.
4946
+ * @format GUID
4892
4947
  */
4893
- calculatedPlatformFees?: CalculatedPlatformFee[];
4894
- }
4895
- interface CalculatedPlatformFee {
4896
- /** Platform fee name. */
4897
- name?: TranslatableString;
4898
- /** Platform fee amount. */
4899
- amount?: MultiCurrencyPrice;
4948
+ cartId?: string;
4900
4949
  /**
4901
- * ID of the line item the platform fee applies to.
4902
- * @format GUID
4950
+ * Specifies the level of **business validation** to perform during cart calculation,
4951
+ * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
4903
4952
  */
4904
- lineItemId?: string;
4905
- /** Platform fee charge type. */
4906
- chargeType?: PlatformFeeChargeTypeWithLiterals;
4953
+ validationsConfig?: ValidationsConfigWithLiterals;
4907
4954
  /**
4908
- * Percentage rate charged as platform fee.
4909
- * The fee rate percentage expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
4910
- * @format DECIMAL_VALUE
4911
- * @decimalValue options { gt:0, lte:1, maxScale:4 }
4955
+ * Optional custom configuration for the calculation.
4956
+ * If not provided, all price components are calculated by default.
4912
4957
  */
4913
- percentageRate?: string;
4914
- }
4915
- declare enum PlatformFeeChargeType {
4916
- /** The platform fee is passed on to the customer. */
4917
- PASS_ON = "PASS_ON",
4918
- /** The platform fee is absorbed by the merchant. */
4919
- ABSORBED = "ABSORBED"
4958
+ customCalculationConfig?: CalculationConfig;
4959
+ /** Calculations overrides for backward compatibility with V1. */
4960
+ calculationOverrides?: CalculationOverrides;
4961
+ /** Cart revision that must still be current for the calculation to run. */
4962
+ expectedRevision?: string | null;
4920
4963
  }
4921
- /** @enumType */
4922
- type PlatformFeeChargeTypeWithLiterals = PlatformFeeChargeType | 'PASS_ON' | 'ABSORBED';
4923
- /** Cart-level outcome of the cross-border repricing in one calculation. The per-line records are `CrossBorderPriceAdjustment`. */
4924
- interface CrossBorderRepricingResult {
4964
+ interface CalculationConfig {
4925
4965
  /**
4926
- * Whether the calculation repriced the line items for the destination's tax.
4966
+ * Whether to calculate delivery costs.
4927
4967
  *
4928
- * Default: `false`
4929
- * @readonly
4968
+ * Default: `false`.
4930
4969
  */
4931
- applied?: boolean;
4970
+ calculateDelivery?: boolean;
4932
4971
  /**
4933
- * ID of the tax region whose tax is built into the catalog prices, as used in this calculation.
4934
- * @format GUID
4935
- * @readonly
4972
+ * Whether to calculate additional fees.
4973
+ *
4974
+ * Default: `false`.
4936
4975
  */
4937
- baseTaxRegionId?: string | null;
4976
+ calculateAdditionalFees?: boolean;
4938
4977
  /**
4939
- * App ID of the base region's tax calculator.
4940
- * @format GUID
4941
- * @readonly
4978
+ * Whether to calculate tax.
4979
+ *
4980
+ * Default: `false`.
4942
4981
  */
4943
- baseCalculatorId?: string | null;
4982
+ calculateTax?: boolean;
4944
4983
  /**
4945
- * Why the calculation didn't reprice. Set when `applied` is `false`, or when the line items were repriced and the shipping option or the fees were not.
4946
- * @readonly
4984
+ * Whether to include the effect of gift card balances on the cart total.
4985
+ * Gift cards aren't redeemed; balances are reflected for estimation only.
4986
+ *
4987
+ * Default: `false`.
4947
4988
  */
4948
- reason?: CrossBorderNotApplicableReasonWithLiterals;
4989
+ calculateGiftCards?: boolean;
4990
+ }
4991
+ interface CalculationOverrides {
4949
4992
  /**
4950
- * Mode the calculation ran in. `FULL` when the request set none. Callers copy it onto the order's tax info.
4951
- * @readonly
4993
+ * Delivery method.
4994
+ *
4995
+ * Pass this field only when the cart has no delivery method yet.
4952
4996
  */
4953
- mode?: CrossBorderRepricingModeWithLiterals;
4997
+ deliveryMethod?: DeliveryMethodInput;
4954
4998
  /**
4955
- * Request ID of the calculation, for log correlation.
4956
- * @maxLength 100
4957
- * @readonly
4999
+ * Delivery address.
5000
+ * Used to calculate tax and shipping when applicable.
4958
5001
  */
4959
- requestId?: string | null;
5002
+ deliveryAddress?: Address;
5003
+ /**
5004
+ * Billing address.
5005
+ * Used to calculate tax when all items in the cart aren't shippable.
5006
+ */
5007
+ billingAddress?: Address;
5008
+ /** Selected membership payment options and the line items they apply to. */
5009
+ selectedMemberships?: SelectedMemberships;
4960
5010
  }
4961
- /** Why a cross-border repricing calculation didn't reprice the lines. */
4962
- declare enum CrossBorderNotApplicableReason {
4963
- /** The repricing feature toggle is off. */
4964
- FEATURE_DISABLED = "FEATURE_DISABLED",
4965
- /** The site hasn't opted in to cross-border repricing. */
4966
- NOT_OPTED_IN = "NOT_OPTED_IN",
4967
- /** The site's prices no longer include tax. */
4968
- TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
4969
- /** The base tax region doesn't exist on the site. */
4970
- BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
4971
- /** The base region uses the manual calculator and has no tax mapping. */
4972
- BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
4973
- /** No embedded rate is stored for one of the tax groups in the calculation. */
4974
- EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
4975
- /** Removing the base tax or applying the destination's tax failed for a line item. */
4976
- CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
4977
- /** The line items were repriced. Repricing the shipping option failed. */
4978
- SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
4979
- /** The line items were repriced. Repricing the additional fees failed. */
4980
- FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
4981
- /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
4982
- SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
5011
+ interface SelectedMemberships {
5012
+ /**
5013
+ * Selected memberships.
5014
+ * @maxSize 300
5015
+ */
5016
+ memberships?: SelectedMembership[];
4983
5017
  }
4984
- /** @enumType */
4985
- type CrossBorderNotApplicableReasonWithLiterals = CrossBorderNotApplicableReason | 'FEATURE_DISABLED' | 'NOT_OPTED_IN' | 'TAX_INCLUSIVE_PRICING_OFF' | 'BASE_TAX_REGION_NOT_FOUND' | 'BASE_REGION_HAS_NO_MANUAL_MAPPING' | 'EMBEDDED_RATE_MISSING' | 'CROSS_BORDER_REPRICING_FAILED' | 'SHIPPING_REPRICING_FAILED' | 'FEES_REPRICING_FAILED' | 'SETTINGS_UNAVAILABLE';
4986
- /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
4987
- declare enum CrossBorderRepricingMode {
4988
- /** Nothing is repriced. */
4989
- DISABLED = "DISABLED",
4990
- /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
4991
- STRIP_ONLY = "STRIP_ONLY",
4992
- /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
4993
- FULL = "FULL"
5018
+ interface CalculateCartForV1Response {
5019
+ /** The Cart that was calculated. */
5020
+ cart?: Cart;
5021
+ /** The calculation summary. */
5022
+ summary?: CartSummary;
5023
+ /**
5024
+ * Totals payload used for backward compatibility with legacy clients.
5025
+ * Used by the Cart and Checkout proxies.
5026
+ */
5027
+ totalsResponse?: CalculateTotalsResponse;
5028
+ /**
5029
+ * Violations returned by the Validations service plugin, in the legacy model.
5030
+ * Used by the Cart and Checkout proxies.
5031
+ * @maxSize 100
5032
+ */
5033
+ spiViolations?: Violation[];
4994
5034
  }
4995
- /** @enumType */
4996
- type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
4997
5035
  interface CartRevisionMismatchErrorData {
4998
5036
  /** Cart revision requested by the caller. */
4999
5037
  expectedRevision?: string;
@@ -6204,4 +6242,4 @@ declare function removeGiftCardFromCurrentCart(): __PublicMethodMetaInfo<'POST',
6204
6242
  declare function updateFormSubmissionsInCurrentCart(): __PublicMethodMetaInfo<'POST', {}, UpdateFormSubmissionsInCurrentCartRequest$1, UpdateFormSubmissionsInCurrentCartRequest, UpdateFormSubmissionsInCurrentCartResponse$1, UpdateFormSubmissionsInCurrentCartResponse>;
6205
6243
  declare function getUpsellOptionsForCurrentCart(): __PublicMethodMetaInfo<'GET', {}, GetUpsellOptionsForCurrentCartRequest$1, GetUpsellOptionsForCurrentCartRequest, GetUpsellOptionsForCurrentCartResponse$1, GetUpsellOptionsForCurrentCartResponse>;
6206
6244
 
6207
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddCouponRequest as AddCouponRequestOriginal, type AddCouponResponse as AddCouponResponseOriginal, type AddCouponToCurrentCartApplicationErrors as AddCouponToCurrentCartApplicationErrorsOriginal, type AddCouponToCurrentCartRequest as AddCouponToCurrentCartRequestOriginal, type AddCouponToCurrentCartResponse as AddCouponToCurrentCartResponseOriginal, type AddGiftCardRequest as AddGiftCardRequestOriginal, type AddGiftCardResponse as AddGiftCardResponseOriginal, type AddGiftCardToCurrentCartApplicationErrors as AddGiftCardToCurrentCartApplicationErrorsOriginal, type AddGiftCardToCurrentCartRequest as AddGiftCardToCurrentCartRequestOriginal, type AddGiftCardToCurrentCartResponse as AddGiftCardToCurrentCartResponseOriginal, type AddLineItemsRequest as AddLineItemsRequestOriginal, type AddLineItemsResponse as AddLineItemsResponseOriginal, type AddLineItemsToCurrentCartApplicationErrors as AddLineItemsToCurrentCartApplicationErrorsOriginal, type AddLineItemsToCurrentCartRequest as AddLineItemsToCurrentCartRequestOriginal, type AddLineItemsToCurrentCartResponse as AddLineItemsToCurrentCartResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AdditionalFeeTax as AdditionalFeeTaxOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type ApplicableLineItems as ApplicableLineItemsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetailsOriginal, BalanceType as BalanceTypeOriginal, type BalanceTypeWithLiterals as BalanceTypeWithLiteralsOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type Benefit as BenefitOriginal, type BenefitQuotaOneOf as BenefitQuotaOneOfOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BillingSettings as BillingSettingsOriginal, type BundleInfo as BundleInfoOriginal, type BundledItemAttributes as BundledItemAttributesOriginal, type BundledItem as BundledItemOriginal, type BundledItemSource as BundledItemSourceOriginal, type BusinessInfo as BusinessInfoOriginal, type CalculateCartForV1Request as CalculateCartForV1RequestOriginal, type CalculateCartForV1Response as CalculateCartForV1ResponseOriginal, type CalculateCartRequest as CalculateCartRequestOriginal, type CalculateCartResponse as CalculateCartResponseOriginal, type CalculateCurrentCartApplicationErrors as CalculateCurrentCartApplicationErrorsOriginal, type CalculateCurrentCartRequest as CalculateCurrentCartRequestOriginal, type CalculateCurrentCartResponse as CalculateCurrentCartResponseOriginal, type CalculateTotalsResponse as CalculateTotalsResponseOriginal, type CalculatedItemModifier as CalculatedItemModifierOriginal, type CalculatedLineItem as CalculatedLineItemOriginal, type CalculatedPlatformFee as CalculatedPlatformFeeOriginal, type CalculationConfig as CalculationConfigOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CalculationOverrides as CalculationOverridesOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Carrier as CarrierOriginal, type CarrierServiceOption as CarrierServiceOptionOriginal, type CartAlreadyOrderedErrorData as CartAlreadyOrderedErrorDataOriginal, type CartCompleted as CartCompletedOriginal, type CartEstimationIndicators as CartEstimationIndicatorsOriginal, type Cart as CartOriginal, type CartRevisionMismatchErrorData as CartRevisionMismatchErrorDataOriginal, type CartSettings as CartSettingsOriginal, type CartSource as CartSourceOriginal, type CartSummary as CartSummaryOriginal, type CatalogItemInput as CatalogItemInputOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type Charge as ChargeOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type ConvertedMoney as ConvertedMoneyOriginal, type CouponAdded as CouponAddedOriginal, type CouponAlreadyExistsErrorData as CouponAlreadyExistsErrorDataOriginal, type CouponDiscountValueOneOf as CouponDiscountValueOneOfOriginal, type CouponInput as CouponInputOriginal, type CouponNotFoundInCartErrorData as CouponNotFoundInCartErrorDataOriginal, type Coupon as CouponOriginal, type CouponRemoved as CouponRemovedOriginal, type CoveredLineItem as CoveredLineItemOriginal, type CreateCartRequest as CreateCartRequestOriginal, type CreateCartResponse as CreateCartResponseOriginal, type CreateCurrentCartApplicationErrors as CreateCurrentCartApplicationErrorsOriginal, type CreateCurrentCartRequest as CreateCurrentCartRequestOriginal, type CreateCurrentCartResponse as CreateCurrentCartResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricingResult as CrossBorderRepricingResultOriginal, type CustomContentReference as CustomContentReferenceOriginal, type CustomField as CustomFieldOriginal, type CustomItemAttributes as CustomItemAttributesOriginal, type CustomItemDeliveryConfig as CustomItemDeliveryConfigOriginal, type CustomItemInput as CustomItemInputOriginal, type CustomItemPaymentConfig as CustomItemPaymentConfigOriginal, type CustomItemPricingInfo as CustomItemPricingInfoOriginal, type CustomItemQuantityInfo as CustomItemQuantityInfoOriginal, type CustomItemSource as CustomItemSourceOriginal, type CustomItemTaxConfig as CustomItemTaxConfigOriginal, type CustomValidationErrorData as CustomValidationErrorDataOriginal, type CustomerInfoIdOneOf as CustomerInfoIdOneOfOriginal, type CustomerInfo as CustomerInfoOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DeleteCartRequest as DeleteCartRequestOriginal, type DeleteCartResponse as DeleteCartResponseOriginal, type DeleteCurrentCartRequest as DeleteCurrentCartRequestOriginal, type DeleteCurrentCartResponse as DeleteCurrentCartResponseOriginal, type DeliveryAllocation as DeliveryAllocationOriginal, type DeliveryInfo as DeliveryInfoOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryMethodInput as DeliveryMethodInputOriginal, type DeliveryMethodNotFoundErrorData as DeliveryMethodNotFoundErrorDataOriginal, type DeliveryMethod as DeliveryMethodOriginal, type DeliverySummary as DeliverySummaryOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type Discount as DiscountOriginal, type DiscountRuleDiscountValueOneOf as DiscountRuleDiscountValueOneOfOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountScope as DiscountScopeOriginal, type DiscountScopeWithLiterals as DiscountScopeWithLiteralsOriginal, type DiscountSource as DiscountSourceOriginal, DiscountSourceType as DiscountSourceTypeOriginal, type DiscountSourceTypeWithLiterals as DiscountSourceTypeWithLiteralsOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DiscountValueType as DiscountValueTypeOriginal, type DiscountValueTypeWithLiterals as DiscountValueTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateItemModifierIdsErrorData as DuplicateItemModifierIdsErrorDataOriginal, type DuplicateLineItemUpdatesErrorData as DuplicateLineItemUpdatesErrorDataOriginal, type DuplicateModifierGroupIdsErrorData as DuplicateModifierGroupIdsErrorDataOriginal, type EmptyLineItemUpdatesErrorData as EmptyLineItemUpdatesErrorDataOriginal, type Empty as EmptyOriginal, type EmptyPaymentTokenErrorData as EmptyPaymentTokenErrorDataOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EstimateCartRequest as EstimateCartRequestOriginal, type EstimateCartResponse as EstimateCartResponseOriginal, type EstimateCurrentCartApplicationErrors as EstimateCurrentCartApplicationErrorsOriginal, type EstimateCurrentCartRequest as EstimateCurrentCartRequestOriginal, type EstimateCurrentCartResponse as EstimateCurrentCartResponseOriginal, type ExistingMembershipInput as ExistingMembershipInputOriginal, type ExistingMembership as ExistingMembershipOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReference as ExternalReferenceOriginal, FallbackReason as FallbackReasonOriginal, type FallbackReasonWithLiterals as FallbackReasonWithLiteralsOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FixedQuantityItemErrorData as FixedQuantityItemErrorDataOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FormSubmission as FormSubmissionOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipInput as FutureMembershipInputOriginal, type FutureMembership as FutureMembershipOriginal, type GetCartRequest as GetCartRequestOriginal, type GetCartResponse as GetCartResponseOriginal, type GetCheckoutURLRequest as GetCheckoutURLRequestOriginal, type GetCheckoutURLResponse as GetCheckoutURLResponseOriginal, type GetCurrentCartRequest as GetCurrentCartRequestOriginal, type GetCurrentCartResponse as GetCurrentCartResponseOriginal, type GetUpsellOptionsForCurrentCartRequest as GetUpsellOptionsForCurrentCartRequestOriginal, type GetUpsellOptionsForCurrentCartResponse as GetUpsellOptionsForCurrentCartResponseOriginal, type GetUpsellOptionsRequest as GetUpsellOptionsRequestOriginal, type GetUpsellOptionsResponse as GetUpsellOptionsResponseOriginal, type GiftCardAdded as GiftCardAddedOriginal, type GiftCardAlreadyExistsErrorData as GiftCardAlreadyExistsErrorDataOriginal, type GiftCardCalculationError as GiftCardCalculationErrorOriginal, type GiftCardInput as GiftCardInputOriginal, type GiftCardNotFoundInCartErrorData as GiftCardNotFoundInCartErrorDataOriginal, type GiftCard as GiftCardOriginal, type GiftCardPaymentNotSupportedOnDemoCartErrorData as GiftCardPaymentNotSupportedOnDemoCartErrorDataOriginal, type GiftCardRedeemErrorData as GiftCardRedeemErrorDataOriginal, type GiftCardRemoved as GiftCardRemovedOriginal, type GiftCardSummary as GiftCardSummaryOriginal, type Group as GroupOriginal, type HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequestOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InsufficientInventoryEntry as InsufficientInventoryEntryOriginal, type InsufficientInventoryErrorData as InsufficientInventoryErrorDataOriginal, type InvalidCartErrorData as InvalidCartErrorDataOriginal, type InvalidCouponCodeErrorData as InvalidCouponCodeErrorDataOriginal, InvalidCouponReason as InvalidCouponReasonOriginal, type InvalidCouponReasonWithLiterals as InvalidCouponReasonWithLiteralsOriginal, type InvalidCouponStatusErrorDataDetailsOneOf as InvalidCouponStatusErrorDataDetailsOneOfOriginal, type InvalidCouponStatusErrorData as InvalidCouponStatusErrorDataOriginal, type InvalidGiftCardCodeErrorData as InvalidGiftCardCodeErrorDataOriginal, InvalidGiftCardReason as InvalidGiftCardReasonOriginal, type InvalidGiftCardReasonWithLiterals as InvalidGiftCardReasonWithLiteralsOriginal, type InvalidGiftCardStatusErrorData as InvalidGiftCardStatusErrorDataOriginal, type InvalidMembershipEntry as InvalidMembershipEntryOriginal, type InvalidMembershipErrorData as InvalidMembershipErrorDataOriginal, type InvalidMembership as InvalidMembershipOriginal, type InvalidMembershipPaymentOptionErrorData as InvalidMembershipPaymentOptionErrorDataOriginal, InvalidMembershipReason as InvalidMembershipReasonOriginal, type InvalidMembershipReasonWithLiterals as InvalidMembershipReasonWithLiteralsOriginal, type InvalidMembershipStatusErrorData as InvalidMembershipStatusErrorDataOriginal, type InvalidPaymentStatusErrorData as InvalidPaymentStatusErrorDataOriginal, type InvalidPriceVerificationTokenErrorData as InvalidPriceVerificationTokenErrorDataOriginal, type InvalidThirdPartyCheckoutTokenErrorData as InvalidThirdPartyCheckoutTokenErrorDataOriginal, type ItemAttributes as ItemAttributesOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemDeliveryConfig as ItemDeliveryConfigOriginal, type ItemDiscount as ItemDiscountOriginal, type ItemModifier as ItemModifierOriginal, type ItemNotFoundInCatalogErrorData as ItemNotFoundInCatalogErrorDataOriginal, type ItemPaymentConfig as ItemPaymentConfigOriginal, type ItemPriceBreakdown as ItemPriceBreakdownOriginal, type ItemPricingInfo as ItemPricingInfoOriginal, type ItemQuantityInfo as ItemQuantityInfoOriginal, type ItemSource as ItemSourceOriginal, ItemStatus as ItemStatusOriginal, type ItemStatusWithLiterals as ItemStatusWithLiteralsOriginal, type ItemTaxConfig as ItemTaxConfigOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemUpsells as ItemUpsellsOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LegacyFields as LegacyFieldsOriginal, type LimitedQuota as LimitedQuotaOriginal, LimitedQuotaType as LimitedQuotaTypeOriginal, type LimitedQuotaTypeWithLiterals as LimitedQuotaTypeWithLiteralsOriginal, type LineItemAdded as LineItemAddedOriginal, type LineItemCoverage as LineItemCoverageOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemIdentifierIdOneOf as LineItemIdentifierIdOneOfOriginal, type LineItemIdentifier as LineItemIdentifierOriginal, type LineItemNotFoundInCartErrorData as LineItemNotFoundInCartErrorDataOriginal, type LineItem as LineItemOriginal, type LineItemPriceConflictErrorData as LineItemPriceConflictErrorDataOriginal, type LineItemPricesData as LineItemPricesDataOriginal, type LineItemSummary as LineItemSummaryOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItemsOutOfStockErrorData as LineItemsOutOfStockErrorDataOriginal, ManualCalculationReason as ManualCalculationReasonOriginal, type ManualCalculationReasonWithLiterals as ManualCalculationReasonWithLiteralsOriginal, type MarkCartAsCompletedRequest as MarkCartAsCompletedRequestOriginal, type MarkCartAsCompletedResponse as MarkCartAsCompletedResponseOriginal, type MaxItemModifiersExceededErrorData as MaxItemModifiersExceededErrorDataOriginal, type MaxLineItemsExceededErrorData as MaxLineItemsExceededErrorDataOriginal, type MembersOnlyItemErrorData as MembersOnlyItemErrorDataOriginal, type MembershipInputMembershipOneOf as MembershipInputMembershipOneOfOriginal, type MembershipInput as MembershipInputOriginal, type MembershipName as MembershipNameOriginal, type MembershipOptions as MembershipOptionsOriginal, type Membership as MembershipOriginal, type MembershipPaymentCredits as MembershipPaymentCreditsOriginal, type MembershipSummaryMembershipIdentifierOneOf as MembershipSummaryMembershipIdentifierOneOfOriginal, type MembershipSummary as MembershipSummaryOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MinLineItemQuantityNotReachedDetails as MinLineItemQuantityNotReachedDetailsOriginal, type MinSubtotalNotReachedDetails as MinSubtotalNotReachedDetailsOriginal, type ModifierGroup as ModifierGroupOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type OtherCharge as OtherChargeOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentInfo as PaymentInfoOriginal, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PaymentSummary as PaymentSummaryOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlaceOrderRequest as PlaceOrderRequestOriginal, type PlaceOrderResponse as PlaceOrderResponseOriginal, type PlainTextValue as PlainTextValueOriginal, PlatformFeeChargeType as PlatformFeeChargeTypeOriginal, type PlatformFeeChargeTypeWithLiterals as PlatformFeeChargeTypeWithLiteralsOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceDetails as PriceDetailsOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PurchasablePlan as PurchasablePlanOriginal, type QuantityUpdate as QuantityUpdateOriginal, QuotaType as QuotaTypeOriginal, type QuotaTypeWithLiterals as QuotaTypeWithLiteralsOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type RawHttpResponse as RawHttpResponseOriginal, RedemptionType as RedemptionTypeOriginal, type RedemptionTypeWithLiterals as RedemptionTypeWithLiteralsOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefreshCartRequest as RefreshCartRequestOriginal, type RefreshCartResponse as RefreshCartResponseOriginal, type RefreshCurrentCartApplicationErrors as RefreshCurrentCartApplicationErrorsOriginal, type RefreshCurrentCartRequest as RefreshCurrentCartRequestOriginal, type RefreshCurrentCartResponse as RefreshCurrentCartResponseOriginal, type Region as RegionOriginal, type RemoveCouponFromCurrentCartApplicationErrors as RemoveCouponFromCurrentCartApplicationErrorsOriginal, type RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequestOriginal, type RemoveCouponFromCurrentCartResponse as RemoveCouponFromCurrentCartResponseOriginal, type RemoveCouponRequest as RemoveCouponRequestOriginal, type RemoveCouponResponse as RemoveCouponResponseOriginal, type RemoveDeliveryMethodFromCurrentCartApplicationErrors as RemoveDeliveryMethodFromCurrentCartApplicationErrorsOriginal, type RemoveDeliveryMethodFromCurrentCartRequest as RemoveDeliveryMethodFromCurrentCartRequestOriginal, type RemoveDeliveryMethodFromCurrentCartResponse as RemoveDeliveryMethodFromCurrentCartResponseOriginal, type RemoveDeliveryMethodRequest as RemoveDeliveryMethodRequestOriginal, type RemoveDeliveryMethodResponse as RemoveDeliveryMethodResponseOriginal, type RemoveGiftCardFromCurrentCartApplicationErrors as RemoveGiftCardFromCurrentCartApplicationErrorsOriginal, type RemoveGiftCardFromCurrentCartRequest as RemoveGiftCardFromCurrentCartRequestOriginal, type RemoveGiftCardFromCurrentCartResponse as RemoveGiftCardFromCurrentCartResponseOriginal, type RemoveGiftCardRequest as RemoveGiftCardRequestOriginal, type RemoveGiftCardResponse as RemoveGiftCardResponseOriginal, type RemoveLineItemsFromCurrentCartApplicationErrors as RemoveLineItemsFromCurrentCartApplicationErrorsOriginal, type RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequestOriginal, type RemoveLineItemsFromCurrentCartResponse as RemoveLineItemsFromCurrentCartResponseOriginal, type RemoveLineItemsRequest as RemoveLineItemsRequestOriginal, type RemoveLineItemsResponse as RemoveLineItemsResponseOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedCarrierServiceOption as SelectedCarrierServiceOptionOriginal, type SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherChargeOriginal, type SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPricesOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMembershipUpdate as SelectedMembershipUpdateOriginal, type SelectedMemberships as SelectedMembershipsOriginal, type ServiceProperties as ServicePropertiesOriginal, type SetDeliveryMethodForCurrentCartApplicationErrors as SetDeliveryMethodForCurrentCartApplicationErrorsOriginal, type SetDeliveryMethodForCurrentCartRequest as SetDeliveryMethodForCurrentCartRequestOriginal, type SetDeliveryMethodForCurrentCartResponse as SetDeliveryMethodForCurrentCartResponseOriginal, type SetDeliveryMethodRequest as SetDeliveryMethodRequestOriginal, type SetDeliveryMethodResponse as SetDeliveryMethodResponseOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingOption as ShippingOptionOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, Source as SourceOriginal, type SourceWithLiterals as SourceWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubtotalBelowOrderMinimumErrorData as SubtotalBelowOrderMinimumErrorDataOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOfOriginal, type TaxCalculationDetails as TaxCalculationDetailsOriginal, type TaxDetails as TaxDetailsOriginal, type TaxInfo as TaxInfoOriginal, type Tax as TaxOriginal, type TaxRateBreakdown as TaxRateBreakdownOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UnmarkAsCurrentCartRequest as UnmarkAsCurrentCartRequestOriginal, type UnmarkAsCurrentCartResponse as UnmarkAsCurrentCartResponseOriginal, type UpdateCartRequest as UpdateCartRequestOriginal, type UpdateCartResponse as UpdateCartResponseOriginal, type UpdateCurrentCartApplicationErrors as UpdateCurrentCartApplicationErrorsOriginal, type UpdateCurrentCartRequest as UpdateCurrentCartRequestOriginal, type UpdateCurrentCartResponse as UpdateCurrentCartResponseOriginal, type UpdateFormSubmissionsInCurrentCartRequest as UpdateFormSubmissionsInCurrentCartRequestOriginal, type UpdateFormSubmissionsInCurrentCartResponse as UpdateFormSubmissionsInCurrentCartResponseOriginal, type UpdateFormSubmissionsRequest as UpdateFormSubmissionsRequestOriginal, type UpdateFormSubmissionsResponse as UpdateFormSubmissionsResponseOriginal, type UpdateLineItemsInCurrentCartApplicationErrors as UpdateLineItemsInCurrentCartApplicationErrorsOriginal, type UpdateLineItemsInCurrentCartRequest as UpdateLineItemsInCurrentCartRequestOriginal, type UpdateLineItemsInCurrentCartResponse as UpdateLineItemsInCurrentCartResponseOriginal, type UpdateLineItemsRequest as UpdateLineItemsRequestOriginal, type UpdateLineItemsResponse as UpdateLineItemsResponseOriginal, type UpsellBenefitMetadata as UpsellBenefitMetadataOriginal, type UpsellOption as UpsellOptionOriginal, type V1AdditionalFee as V1AdditionalFeeOriginal, type V1Membership as V1MembershipOriginal, V1PlatformFeeChargeType as V1PlatformFeeChargeTypeOriginal, type V1PlatformFeeChargeTypeWithLiterals as V1PlatformFeeChargeTypeWithLiteralsOriginal, type V1PriceSummary as V1PriceSummaryOriginal, type V2AdditionalFee as V2AdditionalFeeOriginal, type V2CalculationErrors as V2CalculationErrorsOriginal, type V2CalculationErrorsShippingCalculationErrorOneOf as V2CalculationErrorsShippingCalculationErrorOneOfOriginal, type V2CarrierError as V2CarrierErrorOriginal, type V2CarrierErrors as V2CarrierErrorsOriginal, type V2Coupon as V2CouponOriginal, type V2ExistingMembership as V2ExistingMembershipOriginal, type V2GiftCard as V2GiftCardOriginal, type V2LineItemDiscount as V2LineItemDiscountOriginal, type V2LineItem as V2LineItemOriginal, type V2MembershipIdentifierOneOf as V2MembershipIdentifierOneOfOriginal, type V2Membership as V2MembershipOriginal, type V2PriceSummary as V2PriceSummaryOriginal, type V2SelectedMembership as V2SelectedMembershipOriginal, type V2TaxSummary as V2TaxSummaryOriginal, type V2ViolationDataOneOf as V2ViolationDataOneOfOriginal, type V2Violation as V2ViolationOriginal, type ValidatedExistingMemberships as ValidatedExistingMembershipsOriginal, type ValidatedPurchasablePlans as ValidatedPurchasablePlansOriginal, type ValidationError as ValidationErrorOriginal, ValidationsConfig as ValidationsConfigOriginal, type ValidationsConfigWithLiterals as ValidationsConfigWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, ViolationCode as ViolationCodeOriginal, type ViolationCodeWithLiterals as ViolationCodeWithLiteralsOriginal, type Violation as ViolationOriginal, ViolationScope as ViolationScopeOriginal, type ViolationScopeWithLiterals as ViolationScopeWithLiteralsOriginal, ViolationSeverity as ViolationSeverityOriginal, type ViolationSeverityWithLiterals as ViolationSeverityWithLiteralsOriginal, type ViolationWithErrorSeverityErrorData as ViolationWithErrorSeverityErrorDataOriginal, type ViolationsList as ViolationsListOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, addCouponToCurrentCart, addGiftCardToCurrentCart, addLineItemsToCurrentCart, calculateCurrentCart, createCurrentCart, deleteCurrentCart, estimateCurrentCart, getCurrentCart, getUpsellOptionsForCurrentCart, refreshCurrentCart, removeCouponFromCurrentCart, removeDeliveryMethodFromCurrentCart, removeGiftCardFromCurrentCart, removeLineItemsFromCurrentCart, setDeliveryMethodForCurrentCart, updateCurrentCart, updateFormSubmissionsInCurrentCart, updateLineItemsInCurrentCart };
6245
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddCouponRequest as AddCouponRequestOriginal, type AddCouponResponse as AddCouponResponseOriginal, type AddCouponToCurrentCartApplicationErrors as AddCouponToCurrentCartApplicationErrorsOriginal, type AddCouponToCurrentCartRequest as AddCouponToCurrentCartRequestOriginal, type AddCouponToCurrentCartResponse as AddCouponToCurrentCartResponseOriginal, type AddGiftCardRequest as AddGiftCardRequestOriginal, type AddGiftCardResponse as AddGiftCardResponseOriginal, type AddGiftCardToCurrentCartApplicationErrors as AddGiftCardToCurrentCartApplicationErrorsOriginal, type AddGiftCardToCurrentCartRequest as AddGiftCardToCurrentCartRequestOriginal, type AddGiftCardToCurrentCartResponse as AddGiftCardToCurrentCartResponseOriginal, type AddLineItemsRequest as AddLineItemsRequestOriginal, type AddLineItemsResponse as AddLineItemsResponseOriginal, type AddLineItemsToCurrentCartApplicationErrors as AddLineItemsToCurrentCartApplicationErrorsOriginal, type AddLineItemsToCurrentCartRequest as AddLineItemsToCurrentCartRequestOriginal, type AddLineItemsToCurrentCartResponse as AddLineItemsToCurrentCartResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AdditionalFeeTax as AdditionalFeeTaxOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type ApplicableLineItems as ApplicableLineItemsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetailsOriginal, BalanceType as BalanceTypeOriginal, type BalanceTypeWithLiterals as BalanceTypeWithLiteralsOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type Benefit as BenefitOriginal, type BenefitQuotaOneOf as BenefitQuotaOneOfOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BillingSettings as BillingSettingsOriginal, BridgeAction as BridgeActionOriginal, type BridgeActionWithLiterals as BridgeActionWithLiteralsOriginal, type BundleInfo as BundleInfoOriginal, type BundledItemAttributes as BundledItemAttributesOriginal, type BundledItem as BundledItemOriginal, type BundledItemSource as BundledItemSourceOriginal, type BusinessInfo as BusinessInfoOriginal, type CalculateCartForV1Request as CalculateCartForV1RequestOriginal, type CalculateCartForV1Response as CalculateCartForV1ResponseOriginal, type CalculateCartRequest as CalculateCartRequestOriginal, type CalculateCartResponse as CalculateCartResponseOriginal, type CalculateCurrentCartApplicationErrors as CalculateCurrentCartApplicationErrorsOriginal, type CalculateCurrentCartRequest as CalculateCurrentCartRequestOriginal, type CalculateCurrentCartResponse as CalculateCurrentCartResponseOriginal, type CalculateTotalsResponse as CalculateTotalsResponseOriginal, type CalculatedItemModifier as CalculatedItemModifierOriginal, type CalculatedLineItem as CalculatedLineItemOriginal, type CalculatedPlatformFee as CalculatedPlatformFeeOriginal, type CalculationConfig as CalculationConfigOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CalculationOverrides as CalculationOverridesOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Carrier as CarrierOriginal, type CarrierServiceOption as CarrierServiceOptionOriginal, type CartAlreadyOrderedErrorData as CartAlreadyOrderedErrorDataOriginal, type CartBridgeCalculated as CartBridgeCalculatedOriginal, type CartCompleted as CartCompletedOriginal, type CartEstimationIndicators as CartEstimationIndicatorsOriginal, type Cart as CartOriginal, type CartRevisionMismatchErrorData as CartRevisionMismatchErrorDataOriginal, type CartSettings as CartSettingsOriginal, type CartSource as CartSourceOriginal, type CartSummary as CartSummaryOriginal, type CatalogItemInput as CatalogItemInputOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type Charge as ChargeOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type ConvertedMoney as ConvertedMoneyOriginal, type CouponAdded as CouponAddedOriginal, type CouponAlreadyExistsErrorData as CouponAlreadyExistsErrorDataOriginal, type CouponDiscountValueOneOf as CouponDiscountValueOneOfOriginal, type CouponInput as CouponInputOriginal, type CouponNotFoundInCartErrorData as CouponNotFoundInCartErrorDataOriginal, type Coupon as CouponOriginal, type CouponRemoved as CouponRemovedOriginal, type CoveredLineItem as CoveredLineItemOriginal, type CreateCartRequest as CreateCartRequestOriginal, type CreateCartResponse as CreateCartResponseOriginal, type CreateCurrentCartApplicationErrors as CreateCurrentCartApplicationErrorsOriginal, type CreateCurrentCartRequest as CreateCurrentCartRequestOriginal, type CreateCurrentCartResponse as CreateCurrentCartResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricingResult as CrossBorderRepricingResultOriginal, type CustomContentReference as CustomContentReferenceOriginal, type CustomField as CustomFieldOriginal, type CustomItemAttributes as CustomItemAttributesOriginal, type CustomItemDeliveryConfig as CustomItemDeliveryConfigOriginal, type CustomItemInput as CustomItemInputOriginal, type CustomItemPaymentConfig as CustomItemPaymentConfigOriginal, type CustomItemPricingInfo as CustomItemPricingInfoOriginal, type CustomItemQuantityInfo as CustomItemQuantityInfoOriginal, type CustomItemSource as CustomItemSourceOriginal, type CustomItemTaxConfig as CustomItemTaxConfigOriginal, type CustomValidationErrorData as CustomValidationErrorDataOriginal, type CustomerInfoIdOneOf as CustomerInfoIdOneOfOriginal, type CustomerInfo as CustomerInfoOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DeleteCartRequest as DeleteCartRequestOriginal, type DeleteCartResponse as DeleteCartResponseOriginal, type DeleteCurrentCartRequest as DeleteCurrentCartRequestOriginal, type DeleteCurrentCartResponse as DeleteCurrentCartResponseOriginal, type DeliveryAllocation as DeliveryAllocationOriginal, type DeliveryInfo as DeliveryInfoOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryMethodInput as DeliveryMethodInputOriginal, type DeliveryMethodNotFoundErrorData as DeliveryMethodNotFoundErrorDataOriginal, type DeliveryMethod as DeliveryMethodOriginal, type DeliverySummary as DeliverySummaryOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type Discount as DiscountOriginal, type DiscountRuleDiscountValueOneOf as DiscountRuleDiscountValueOneOfOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountScope as DiscountScopeOriginal, type DiscountScopeWithLiterals as DiscountScopeWithLiteralsOriginal, type DiscountSource as DiscountSourceOriginal, DiscountSourceType as DiscountSourceTypeOriginal, type DiscountSourceTypeWithLiterals as DiscountSourceTypeWithLiteralsOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DiscountValueType as DiscountValueTypeOriginal, type DiscountValueTypeWithLiterals as DiscountValueTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateItemModifierIdsErrorData as DuplicateItemModifierIdsErrorDataOriginal, type DuplicateLineItemUpdatesErrorData as DuplicateLineItemUpdatesErrorDataOriginal, type DuplicateModifierGroupIdsErrorData as DuplicateModifierGroupIdsErrorDataOriginal, type EmptyLineItemUpdatesErrorData as EmptyLineItemUpdatesErrorDataOriginal, type Empty as EmptyOriginal, type EmptyPaymentTokenErrorData as EmptyPaymentTokenErrorDataOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EstimateCartRequest as EstimateCartRequestOriginal, type EstimateCartResponse as EstimateCartResponseOriginal, type EstimateCurrentCartApplicationErrors as EstimateCurrentCartApplicationErrorsOriginal, type EstimateCurrentCartRequest as EstimateCurrentCartRequestOriginal, type EstimateCurrentCartResponse as EstimateCurrentCartResponseOriginal, type ExistingMembershipInput as ExistingMembershipInputOriginal, type ExistingMembership as ExistingMembershipOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReference as ExternalReferenceOriginal, FallbackReason as FallbackReasonOriginal, type FallbackReasonWithLiterals as FallbackReasonWithLiteralsOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FixedQuantityItemErrorData as FixedQuantityItemErrorDataOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FormSubmission as FormSubmissionOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipInput as FutureMembershipInputOriginal, type FutureMembership as FutureMembershipOriginal, type GetCartRequest as GetCartRequestOriginal, type GetCartResponse as GetCartResponseOriginal, type GetCheckoutURLRequest as GetCheckoutURLRequestOriginal, type GetCheckoutURLResponse as GetCheckoutURLResponseOriginal, type GetCurrentCartRequest as GetCurrentCartRequestOriginal, type GetCurrentCartResponse as GetCurrentCartResponseOriginal, type GetUpsellOptionsForCurrentCartRequest as GetUpsellOptionsForCurrentCartRequestOriginal, type GetUpsellOptionsForCurrentCartResponse as GetUpsellOptionsForCurrentCartResponseOriginal, type GetUpsellOptionsRequest as GetUpsellOptionsRequestOriginal, type GetUpsellOptionsResponse as GetUpsellOptionsResponseOriginal, type GiftCardAdded as GiftCardAddedOriginal, type GiftCardAlreadyExistsErrorData as GiftCardAlreadyExistsErrorDataOriginal, type GiftCardCalculationError as GiftCardCalculationErrorOriginal, type GiftCardInput as GiftCardInputOriginal, type GiftCardNotFoundInCartErrorData as GiftCardNotFoundInCartErrorDataOriginal, type GiftCard as GiftCardOriginal, type GiftCardPaymentNotSupportedOnDemoCartErrorData as GiftCardPaymentNotSupportedOnDemoCartErrorDataOriginal, type GiftCardRedeemErrorData as GiftCardRedeemErrorDataOriginal, type GiftCardRemoved as GiftCardRemovedOriginal, type GiftCardSummary as GiftCardSummaryOriginal, type Group as GroupOriginal, type HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequestOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InsufficientInventoryEntry as InsufficientInventoryEntryOriginal, type InsufficientInventoryErrorData as InsufficientInventoryErrorDataOriginal, type InvalidCartErrorData as InvalidCartErrorDataOriginal, type InvalidCouponCodeErrorData as InvalidCouponCodeErrorDataOriginal, InvalidCouponReason as InvalidCouponReasonOriginal, type InvalidCouponReasonWithLiterals as InvalidCouponReasonWithLiteralsOriginal, type InvalidCouponStatusErrorDataDetailsOneOf as InvalidCouponStatusErrorDataDetailsOneOfOriginal, type InvalidCouponStatusErrorData as InvalidCouponStatusErrorDataOriginal, type InvalidGiftCardCodeErrorData as InvalidGiftCardCodeErrorDataOriginal, InvalidGiftCardReason as InvalidGiftCardReasonOriginal, type InvalidGiftCardReasonWithLiterals as InvalidGiftCardReasonWithLiteralsOriginal, type InvalidGiftCardStatusErrorData as InvalidGiftCardStatusErrorDataOriginal, type InvalidMembershipEntry as InvalidMembershipEntryOriginal, type InvalidMembershipErrorData as InvalidMembershipErrorDataOriginal, type InvalidMembership as InvalidMembershipOriginal, type InvalidMembershipPaymentOptionErrorData as InvalidMembershipPaymentOptionErrorDataOriginal, InvalidMembershipReason as InvalidMembershipReasonOriginal, type InvalidMembershipReasonWithLiterals as InvalidMembershipReasonWithLiteralsOriginal, type InvalidMembershipStatusErrorData as InvalidMembershipStatusErrorDataOriginal, type InvalidPaymentStatusErrorData as InvalidPaymentStatusErrorDataOriginal, type InvalidPriceVerificationTokenErrorData as InvalidPriceVerificationTokenErrorDataOriginal, type InvalidThirdPartyCheckoutTokenErrorData as InvalidThirdPartyCheckoutTokenErrorDataOriginal, type ItemAttributes as ItemAttributesOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemDeliveryConfig as ItemDeliveryConfigOriginal, type ItemDiscount as ItemDiscountOriginal, type ItemModifier as ItemModifierOriginal, type ItemNotFoundInCatalogErrorData as ItemNotFoundInCatalogErrorDataOriginal, type ItemPaymentConfig as ItemPaymentConfigOriginal, type ItemPriceBreakdown as ItemPriceBreakdownOriginal, type ItemPricingInfo as ItemPricingInfoOriginal, type ItemQuantityInfo as ItemQuantityInfoOriginal, type ItemSource as ItemSourceOriginal, ItemStatus as ItemStatusOriginal, type ItemStatusWithLiterals as ItemStatusWithLiteralsOriginal, type ItemTaxConfig as ItemTaxConfigOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemUpsells as ItemUpsellsOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LegacyFields as LegacyFieldsOriginal, type LimitedQuota as LimitedQuotaOriginal, LimitedQuotaType as LimitedQuotaTypeOriginal, type LimitedQuotaTypeWithLiterals as LimitedQuotaTypeWithLiteralsOriginal, type LineItemAdded as LineItemAddedOriginal, type LineItemCoverage as LineItemCoverageOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemIdentifierIdOneOf as LineItemIdentifierIdOneOfOriginal, type LineItemIdentifier as LineItemIdentifierOriginal, type LineItemNotFoundInCartErrorData as LineItemNotFoundInCartErrorDataOriginal, type LineItem as LineItemOriginal, type LineItemPriceConflictErrorData as LineItemPriceConflictErrorDataOriginal, type LineItemPricesData as LineItemPricesDataOriginal, type LineItemSummary as LineItemSummaryOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItemsOutOfStockErrorData as LineItemsOutOfStockErrorDataOriginal, ManualCalculationReason as ManualCalculationReasonOriginal, type ManualCalculationReasonWithLiterals as ManualCalculationReasonWithLiteralsOriginal, type MarkCartAsCompletedRequest as MarkCartAsCompletedRequestOriginal, type MarkCartAsCompletedResponse as MarkCartAsCompletedResponseOriginal, type MaxItemModifiersExceededErrorData as MaxItemModifiersExceededErrorDataOriginal, type MaxLineItemsExceededErrorData as MaxLineItemsExceededErrorDataOriginal, type MembersOnlyItemErrorData as MembersOnlyItemErrorDataOriginal, type MembershipInputMembershipOneOf as MembershipInputMembershipOneOfOriginal, type MembershipInput as MembershipInputOriginal, type MembershipName as MembershipNameOriginal, type MembershipOptions as MembershipOptionsOriginal, type Membership as MembershipOriginal, type MembershipPaymentCredits as MembershipPaymentCreditsOriginal, type MembershipSummaryMembershipIdentifierOneOf as MembershipSummaryMembershipIdentifierOneOfOriginal, type MembershipSummary as MembershipSummaryOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MinLineItemQuantityNotReachedDetails as MinLineItemQuantityNotReachedDetailsOriginal, type MinSubtotalNotReachedDetails as MinSubtotalNotReachedDetailsOriginal, type ModifierGroup as ModifierGroupOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type OtherCharge as OtherChargeOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentInfo as PaymentInfoOriginal, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PaymentSummary as PaymentSummaryOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlaceOrderRequest as PlaceOrderRequestOriginal, type PlaceOrderResponse as PlaceOrderResponseOriginal, type PlainTextValue as PlainTextValueOriginal, PlatformFeeChargeType as PlatformFeeChargeTypeOriginal, type PlatformFeeChargeTypeWithLiterals as PlatformFeeChargeTypeWithLiteralsOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceDetails as PriceDetailsOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PurchasablePlan as PurchasablePlanOriginal, type QuantityUpdate as QuantityUpdateOriginal, QuotaType as QuotaTypeOriginal, type QuotaTypeWithLiterals as QuotaTypeWithLiteralsOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type RawHttpResponse as RawHttpResponseOriginal, RedemptionType as RedemptionTypeOriginal, type RedemptionTypeWithLiterals as RedemptionTypeWithLiteralsOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefreshCartRequest as RefreshCartRequestOriginal, type RefreshCartResponse as RefreshCartResponseOriginal, type RefreshCurrentCartApplicationErrors as RefreshCurrentCartApplicationErrorsOriginal, type RefreshCurrentCartRequest as RefreshCurrentCartRequestOriginal, type RefreshCurrentCartResponse as RefreshCurrentCartResponseOriginal, type Region as RegionOriginal, type RemoveCouponFromCurrentCartApplicationErrors as RemoveCouponFromCurrentCartApplicationErrorsOriginal, type RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequestOriginal, type RemoveCouponFromCurrentCartResponse as RemoveCouponFromCurrentCartResponseOriginal, type RemoveCouponRequest as RemoveCouponRequestOriginal, type RemoveCouponResponse as RemoveCouponResponseOriginal, type RemoveDeliveryMethodFromCurrentCartApplicationErrors as RemoveDeliveryMethodFromCurrentCartApplicationErrorsOriginal, type RemoveDeliveryMethodFromCurrentCartRequest as RemoveDeliveryMethodFromCurrentCartRequestOriginal, type RemoveDeliveryMethodFromCurrentCartResponse as RemoveDeliveryMethodFromCurrentCartResponseOriginal, type RemoveDeliveryMethodRequest as RemoveDeliveryMethodRequestOriginal, type RemoveDeliveryMethodResponse as RemoveDeliveryMethodResponseOriginal, type RemoveGiftCardFromCurrentCartApplicationErrors as RemoveGiftCardFromCurrentCartApplicationErrorsOriginal, type RemoveGiftCardFromCurrentCartRequest as RemoveGiftCardFromCurrentCartRequestOriginal, type RemoveGiftCardFromCurrentCartResponse as RemoveGiftCardFromCurrentCartResponseOriginal, type RemoveGiftCardRequest as RemoveGiftCardRequestOriginal, type RemoveGiftCardResponse as RemoveGiftCardResponseOriginal, type RemoveLineItemsFromCurrentCartApplicationErrors as RemoveLineItemsFromCurrentCartApplicationErrorsOriginal, type RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequestOriginal, type RemoveLineItemsFromCurrentCartResponse as RemoveLineItemsFromCurrentCartResponseOriginal, type RemoveLineItemsRequest as RemoveLineItemsRequestOriginal, type RemoveLineItemsResponse as RemoveLineItemsResponseOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedCarrierServiceOption as SelectedCarrierServiceOptionOriginal, type SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherChargeOriginal, type SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPricesOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMembershipUpdate as SelectedMembershipUpdateOriginal, type SelectedMemberships as SelectedMembershipsOriginal, type ServiceProperties as ServicePropertiesOriginal, type SetDeliveryMethodForCurrentCartApplicationErrors as SetDeliveryMethodForCurrentCartApplicationErrorsOriginal, type SetDeliveryMethodForCurrentCartRequest as SetDeliveryMethodForCurrentCartRequestOriginal, type SetDeliveryMethodForCurrentCartResponse as SetDeliveryMethodForCurrentCartResponseOriginal, type SetDeliveryMethodRequest as SetDeliveryMethodRequestOriginal, type SetDeliveryMethodResponse as SetDeliveryMethodResponseOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingOption as ShippingOptionOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, Source as SourceOriginal, type SourceWithLiterals as SourceWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubtotalBelowOrderMinimumErrorData as SubtotalBelowOrderMinimumErrorDataOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOfOriginal, type TaxCalculationDetails as TaxCalculationDetailsOriginal, type TaxDetails as TaxDetailsOriginal, type TaxInfo as TaxInfoOriginal, type Tax as TaxOriginal, type TaxRateBreakdown as TaxRateBreakdownOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UnmarkAsCurrentCartRequest as UnmarkAsCurrentCartRequestOriginal, type UnmarkAsCurrentCartResponse as UnmarkAsCurrentCartResponseOriginal, type UpdateCartRequest as UpdateCartRequestOriginal, type UpdateCartResponse as UpdateCartResponseOriginal, type UpdateCurrentCartApplicationErrors as UpdateCurrentCartApplicationErrorsOriginal, type UpdateCurrentCartRequest as UpdateCurrentCartRequestOriginal, type UpdateCurrentCartResponse as UpdateCurrentCartResponseOriginal, type UpdateFormSubmissionsInCurrentCartRequest as UpdateFormSubmissionsInCurrentCartRequestOriginal, type UpdateFormSubmissionsInCurrentCartResponse as UpdateFormSubmissionsInCurrentCartResponseOriginal, type UpdateFormSubmissionsRequest as UpdateFormSubmissionsRequestOriginal, type UpdateFormSubmissionsResponse as UpdateFormSubmissionsResponseOriginal, type UpdateLineItemsInCurrentCartApplicationErrors as UpdateLineItemsInCurrentCartApplicationErrorsOriginal, type UpdateLineItemsInCurrentCartRequest as UpdateLineItemsInCurrentCartRequestOriginal, type UpdateLineItemsInCurrentCartResponse as UpdateLineItemsInCurrentCartResponseOriginal, type UpdateLineItemsRequest as UpdateLineItemsRequestOriginal, type UpdateLineItemsResponse as UpdateLineItemsResponseOriginal, type UpsellBenefitMetadata as UpsellBenefitMetadataOriginal, type UpsellOption as UpsellOptionOriginal, type V1AdditionalFee as V1AdditionalFeeOriginal, type V1Membership as V1MembershipOriginal, V1PlatformFeeChargeType as V1PlatformFeeChargeTypeOriginal, type V1PlatformFeeChargeTypeWithLiterals as V1PlatformFeeChargeTypeWithLiteralsOriginal, type V1PriceSummary as V1PriceSummaryOriginal, type V2AdditionalFee as V2AdditionalFeeOriginal, type V2CalculationErrors as V2CalculationErrorsOriginal, type V2CalculationErrorsShippingCalculationErrorOneOf as V2CalculationErrorsShippingCalculationErrorOneOfOriginal, type V2CarrierError as V2CarrierErrorOriginal, type V2CarrierErrors as V2CarrierErrorsOriginal, type V2Coupon as V2CouponOriginal, type V2ExistingMembership as V2ExistingMembershipOriginal, type V2GiftCard as V2GiftCardOriginal, type V2LineItemDiscount as V2LineItemDiscountOriginal, type V2LineItem as V2LineItemOriginal, type V2MembershipIdentifierOneOf as V2MembershipIdentifierOneOfOriginal, type V2Membership as V2MembershipOriginal, type V2PriceSummary as V2PriceSummaryOriginal, type V2SelectedMembership as V2SelectedMembershipOriginal, type V2TaxSummary as V2TaxSummaryOriginal, type V2ViolationDataOneOf as V2ViolationDataOneOfOriginal, type V2Violation as V2ViolationOriginal, type ValidatedExistingMemberships as ValidatedExistingMembershipsOriginal, type ValidatedPurchasablePlans as ValidatedPurchasablePlansOriginal, type ValidationError as ValidationErrorOriginal, ValidationsConfig as ValidationsConfigOriginal, type ValidationsConfigWithLiterals as ValidationsConfigWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, ViolationCode as ViolationCodeOriginal, type ViolationCodeWithLiterals as ViolationCodeWithLiteralsOriginal, type Violation as ViolationOriginal, ViolationScope as ViolationScopeOriginal, type ViolationScopeWithLiterals as ViolationScopeWithLiteralsOriginal, ViolationSeverity as ViolationSeverityOriginal, type ViolationSeverityWithLiterals as ViolationSeverityWithLiteralsOriginal, type ViolationWithErrorSeverityErrorData as ViolationWithErrorSeverityErrorDataOriginal, type ViolationsList as ViolationsListOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, addCouponToCurrentCart, addGiftCardToCurrentCart, addLineItemsToCurrentCart, calculateCurrentCart, createCurrentCart, deleteCurrentCart, estimateCurrentCart, getCurrentCart, getUpsellOptionsForCurrentCart, refreshCurrentCart, removeCouponFromCurrentCart, removeDeliveryMethodFromCurrentCart, removeGiftCardFromCurrentCart, removeLineItemsFromCurrentCart, setDeliveryMethodForCurrentCart, updateCurrentCart, updateFormSubmissionsInCurrentCart, updateLineItemsInCurrentCart };