@wix/ditto-codegen-public 1.0.210 → 1.0.212

package/dist/docs-output/service-plugins/ecom-payment-settings-doc.txt

@@ -1,2368 +0,0 @@
-
-<payment_settings_service_plugin>
-<purpose>*Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
-For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
-the base URI you provide here is `https://my-payment-settings.com/`.</purpose>
-<use_cases>
-- Support undefined: Quantity decreased.
-- Support undefined: Quantity increased.
-- Support undefined: Previously authorized payment was captured.
-- Support undefined: Payment was authorized but not yet captured.
-- Support undefined: Previously authorized payment was voided.
-- Support undefined: Chargeback was created for one of the order's payments.
-- Support undefined: Chargeback was resolved in merchant's favor.
-- Support undefined: Custom activity created by a third-party application.
-- Support undefined: Download link was sent for digital items in the order.
-- Support undefined: Changes were applied to a draft order.
-- Support undefined: Order's contact email address was changed.
-- Support undefined: Notification email was sent to the order fulfiller.
-- Support undefined: Invoice document was added to the order.
-- Support undefined: Invoice was removed from the order.
-- Support undefined: Invoice was sent to the customer via email.
-- Support undefined: Comment added to the order by a merchant.
-- Support undefined: New exchange order was created from this order.
-- Support undefined: Order was canceled by merchant or customer.
-- Support undefined: Order was created as a result of an exchange.
-- Support undefined: Order items were marked as fulfilled (shipped or ready for pickup).
-- Support undefined: Order fulfillment status was changed to not fulfilled.
-- Support undefined: Order payment was completed and confirmed.
-- Support undefined: Partial payment was received for the order.
-- Support undefined: Order is awaiting approval or processing.
-- Support undefined: New order was created and placed.
-- Support undefined: Order was refunded, either partially or fully.
-- Support undefined: Order was rejected by merchant.
-- Support undefined: Payment was canceled before completion.
-- Support undefined: Payment was declined by payment provider.
-- Support undefined: Payment is awaiting processing or confirmation.
-- Support undefined: Payment was successfully refunded.
-- Support undefined: Attempt to refund payment failed.
-- Support undefined: Email notification for pickup readiness was sent.
-- Support undefined: Receipt was generated for a payment.
-- Support undefined: Receipt was sent to the customer.
-- Support undefined: Refund was issued as store credit.
-- Support undefined: Refund process was initiated.
-- Support undefined: Payment method was saved for future use.
-- Support undefined: Order's shipping address was modified.
-- Support undefined: Email confirming shipment was sent to the customer.
-- Support undefined: Tracking link for shipment was added to the order.
-- Support undefined: Shipping tracking number was added to the order.
-- Support undefined: Existing shipping tracking number was modified.
-- Support undefined: CNPJ - for corporations
-- Support undefined: CPF - for individual tax payers.
-- Support undefined: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
-- Support undefined: Wix merchant backoffice.
-- Support undefined: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
-- Support undefined: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
-- Support undefined: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
-- Support undefined: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
-- Support undefined: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
-- Support undefined: Global-E sales channel.
-- Support undefined: Other sales platform.
-- Support undefined: PayPal Agentic Checkout sales channel.
-- Support undefined: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
-- Support undefined: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
-- Support undefined: Unspecified sales channel. This value is not supported.
-- Support undefined: A web client.
-- Support undefined: Wish sales channel.
-- Support undefined: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
-- Support undefined: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
-- Support undefined: All of the order items are fulfilled or the order was manually marked as fulfilled.
-Orders without shipping info are fulfilled automatically.
-- Support undefined: None of the order items are fulfilled or the order was manually marked as unfulfilled.
-- Support undefined: Some, but not all, of the order items are fulfilled.
-- Support undefined: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
-- Support undefined: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
-- Support undefined: The entire payment for this item happens as part of the checkout.
-- Support undefined: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
-- Support undefined: Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`.
-- Support undefined: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
-- Support undefined: One or more payments canceled.
-- Support undefined: One or more payments declined.
-- Support undefined: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
-- Support undefined: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
-This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
-- Support undefined: All required payments associated with this order are paid.
-- Support undefined: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details.
-- Support undefined: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
-- Support undefined: All payments pending.
-
-This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly.
-Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
-- Support undefined: Payment received, but not yet confirmed by the payment provider.
-
-In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
-To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
-- Support undefined: Order approved.
-
-This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
-Offline orders (cash payment) are automatically approved.
-- Support undefined: Order canceled by the user.
-- Support undefined: Order created, but not yet approved or canceled.
-- Support undefined: Order pending.
-- Support undefined: Order rejected.
-
-This happens when pending payments fail.
-- Support undefined: Kilograms.
-- Support undefined: Pounds.
-- Support undefined: Weight unit can't be classified due to an error.
-- Support undefined: The additional fee was added on the item either via the catalog or on custom line item
-- Support undefined: The additional fee was added manually on the request
-- Support undefined: The additional fee was added by an additional fee service plugin
-- Support undefined: The additional fee was added by the shipping provider
-- Support undefined: Item is not in stock.
-- Support undefined: Item does not exist.
-- Support undefined: Available quantity is less than requested.
-- Support undefined: auto-tax was temporarily deactivated on a system-level
-- Support undefined: auto-tax failed to be calculated
-- Support undefined: user set calculator in Business Manager to be Manual
-- Support undefined: specific region is on manual even though Global setting is Auto-tax
-- Support undefined: autotax rate used for calculation
-- Support undefined: fallback rate used for calculation
-- Support undefined: manual rate used for calculation
-- Support undefined: no tax being collected for this request due to location of purchase
-- Support undefined: The user is blocked from moving forward in the flow.
-For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
-- Support undefined: The user is allowed to move forward in the flow.
-</use_cases>
-<required_handlers>
-- getPaymentSettings() - Handler that processes order.
-- getPaymentSettingsForCheckout() - Handler that processes checkout.
-</required_handlers>
-<import>import { paymentSettings } from '@wix/ecom/service-plugins'</import>
-<types>
-
-**Activity**
-Properties:
-- _createdDate: unknown - Activity creation date and time.
-- _id: string - Activity ID.
-
-format GUID
-- authorEmail: string - Activity author's email.
-
-format EMAIL
-- type: ActivityType - Activity type.
-One of (content):
-- authorizedPaymentCaptured: AuthorizedPaymentCaptured - Details of an authorized payment captured.
-- authorizedPaymentCreated: AuthorizedPaymentCreated - Details of an authorized payment created.
-- authorizedPaymentVoided: AuthorizedPaymentVoided - Details of an authorized payment voided.
-- chargebackCreated: ChargebackCreated - Order received a chargeback for one of its' payments.
-- chargebackReversed: ChargebackReversed - Chargeback reversed for one of the order's payments.
-- customActivity: CustomActivity - Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`.
-- draftOrderChangesApplied: DraftOrderChangesApplied - Details of changes made by the Draft Orders API.
-- merchantComment: MerchantComment - Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`.
-- orderRefunded: OrderRefunded - Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`.
-- paymentCanceled: PaymentCanceled - Details of a canceled payment.
-- paymentDeclined: PaymentDeclined - Details of a declined payment.
-- paymentPending: PaymentPending - Details of a pending payment.
-- paymentRefundFailed: PaymentRefundFailed - Details of a failed payment refund.
-
-> **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
-> In these cases, the `refundId` will be identical across the activities.
-- paymentRefunded: PaymentRefunded - Details of a refunded payment.
-
-> **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
-> In these cases, the `refundId` will be identical across the activities.
-- receiptCreated: ReceiptCreated - Receipt was added for associated payment.
-- receiptSent: ReceiptSent - Receipt sent to customer.
-- refundInitiated: RefundInitiated - Details of an initiated refund process.
-
-> **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
-> In these cases, the `refundId` will be identical across the activities.
-- refundedAsStoreCredit: RefundedAsStoreCredit - Details of refund to store credit.
-- savedPaymentMethod: SavedPaymentMethod - Details of the payment method saved for order
-
-**ActivityType**
-Enum values:
-- AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured.
-- AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured.
-- AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided.
-- CHARGEBACK_CREATED: Chargeback was created for one of the order's payments.
-- CHARGEBACK_REVERSED: Chargeback was resolved in merchant's favor.
-- CUSTOM_ACTIVITY: Custom activity created by a third-party application.
-- DOWNLOAD_LINK_SENT: Download link was sent for digital items in the order.
-- DRAFT_ORDER_CHANGES_APPLIED: Changes were applied to a draft order.
-- EMAIL_EDITED: Order's contact email address was changed.
-- FULFILLER_EMAIL_SENT: Notification email was sent to the order fulfiller.
-- INVOICE_ADDED: Invoice document was added to the order.
-- INVOICE_REMOVED: Invoice was removed from the order.
-- INVOICE_SENT: Invoice was sent to the customer via email.
-- MERCHANT_COMMENT: Comment added to the order by a merchant.
-- NEW_EXCHANGE_ORDER_CREATED: New exchange order was created from this order.
-- ORDER_CANCELED: Order was canceled by merchant or customer.
-- ORDER_CREATED_FROM_EXCHANGE: Order was created as a result of an exchange.
-- ORDER_FULFILLED: Order items were marked as fulfilled (shipped or ready for pickup).
-- ORDER_NOT_FULFILLED: Order fulfillment status was changed to not fulfilled.
-- ORDER_PAID: Order payment was completed and confirmed.
-- ORDER_PARTIALLY_PAID: Partial payment was received for the order.
-- ORDER_PENDING: Order is awaiting approval or processing.
-- ORDER_PLACED: New order was created and placed.
-- ORDER_REFUNDED: Order was refunded, either partially or fully.
-- ORDER_REJECTED: Order was rejected by merchant.
-- PAYMENT_CANCELED: Payment was canceled before completion.
-- PAYMENT_DECLINED: Payment was declined by payment provider.
-- PAYMENT_PENDING: Payment is awaiting processing or confirmation.
-- PAYMENT_REFUNDED: Payment was successfully refunded.
-- PAYMENT_REFUND_FAILED: Attempt to refund payment failed.
-- PICKUP_READY_EMAIL_SENT: Email notification for pickup readiness was sent.
-- RECEIPT_CREATED: Receipt was generated for a payment.
-- RECEIPT_SENT: Receipt was sent to the customer.
-- REFUNDED_AS_STORE_CREDIT: Refund was issued as store credit.
-- REFUND_INITIATED: Refund process was initiated.
-- SAVED_PAYMENT_METHOD: Payment method was saved for future use.
-- SHIPPING_ADDRESS_EDITED: Order's shipping address was modified.
-- SHIPPING_CONFIRMATION_EMAIL_SENT: Email confirming shipment was sent to the customer.
-- TRACKING_LINK_ADDED: Tracking link for shipment was added to the order.
-- TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order.
-- TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified.
-
-**AdditionalFee**
-Properties:
-- _id: string - Additional fee's id.
-
-format GUID, immutable
-- code: string - Additional fee's unique code for future processing.
-
-minLength 1, maxLength 100
-- lineItemIds: string[] - Optional - Line items associated with this additional fee.
-If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
-
-format GUID
-- name: string - Name of additional fee.
-
-minLength 1, maxLength 50
-- price: Price - Additional fee's price.
-- priceAfterTax: Price - Additional fee's price after tax.
-- priceBeforeTax: Price - Additional fee's price before tax.
-- providerAppId: string - SPI implementer's `appId`.
-
-format GUID
-- taxDetails: ItemTaxFullDetails - Tax details.
-
-**AdditionalFeeSource**
-Enum values:
-- ITEM: The additional fee was added on the item either via the catalog or on custom line item
-- MANUAL: The additional fee was added manually on the request
-- SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
-- SHIPPING: The additional fee was added by the shipping provider
-- UNKNOWN_ADDITIONAL_FEE_SOURCE
-
-**Address**
-Properties:
-- addressLine1: string - Main address line (usually street name and number).
-
-maxLength 150
-- addressLine2: string - Free text providing more detailed address info. Usually contains apt, suite, floor.
-
-maxLength 100
-- city: string - City name.
-
-maxLength 50
-- country: string - Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
-
-format COUNTRY
-- countryFullname: string - Country's full name.
-- postalCode: string - Postal or zip code.
-
-maxLength 50
-- streetAddress: StreetAddress - Street address.
-- subdivision: string - Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
-
-maxLength 50
-- subdivisionFullname: string - Subdivision full-name.
-
-**AddressWithContact**
-Properties:
-- address: Address - Address.
-- contactDetails: FullAddressContactDetails - Contact details.
-
-**ApiAddressWithContact**
-Properties:
-- address: Address - Address.
-- contactDetails: FullAddressContactDetails - Contact details.
-
-**ApplicableLineItems**
-Properties:
-- lineItemIds: string[] - Line items that the delivery solution is for.
-
-maxSize 300, minLength 1, maxLength 100
-
-**ApplicationError**
-Properties:
-- code: string - Error code.
-- data: Record<string, any> - Data related to the error.
-- description: string - Description of the error.
-
-**AppliedDiscount**
-Properties:
-- _id: string - Discount id.
-
-format GUID, immutable
-- discountType: DiscountType - Discount type.
-* `"GLOBAL"` - discount applies to entire order.
-* `"SPECIFIC-ITEMS"` - discount applies to specific items.
-* `"SHIPPING"` - discount applies to shipping. For example, free shipping.
-- lineItemIds: string[] (deprecated) - IDs of line items discount applies to.
-Deprecated. Use `line_item_discounts` instead.
-
-format GUID, maxSize 1
-One of (discountSource):
-- coupon: Coupon - Applied coupon info.
-- discountRule: DiscountRule - Automatic Discount
-- merchantDiscount: MerchantDiscount - Merchant discount.
-
-**AppliedDiscountDiscountType**
-Enum values:
-- GLOBAL
-- SHIPPING
-- SPECIFIC_ITEMS
-
-**AttributionSource**
-Enum values:
-- FACEBOOK_ADS
-- UNSPECIFIED
-
-**AuthorizedPaymentCaptured**
-Properties:
-- amount: Price - Payment amount
-- brand: string - Card issuer's brand.
-
-maxLength 100
-- lastFourDigits: string - The last 4 digits of the card number.
-
-maxLength 4
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-
-**AuthorizedPaymentCreated**
-Properties:
-- amount: Price - Payment amount
-- brand: string - Card issuer's brand.
-
-maxLength 100
-- lastFourDigits: string - The last 4 digits of the card number.
-
-maxLength 4
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-
-**AuthorizedPaymentVoided**
-Properties:
-- amount: Price - Payment amount
-- brand: string - Card issuer's brand.
-
-maxLength 100
-- lastFourDigits: string - The last 4 digits of the card number.
-
-maxLength 4
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-
-**AutoTaxFallbackCalculationDetails**
-Properties:
-- error: ApplicationError - invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here
-- fallbackReason: FallbackReason - reason for fallback
-
-**Balance**
-Properties:
-- amount: string - Balance amount.
-
-A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.
-
-decimalValue { }
-- formattedAmount: string - Amount formatted with currency symbol.
-
-**BalanceSummary**
-Properties:
-- authorized: Price - Sum of all authorized payments.
-- balance: Balance - Current amount left to pay.
-- chargeback: Price - Sum of all transaction chargebacks.
-- chargebackReversal: Price - Sum of all chargeback reversals.
-- paid: Price - Sum of all approved and successful payments.
-
-The value includes payments that have subsequently been fully or partially refunded.
-- pending: Price - Sum of all pending transactions.
-- pendingRefund: Price - Sum of all pending refund transactions.
-- refunded: Price - Sum of all successfully refunded payments.
-
-**BuyerInfo**
-Properties:
-- contactId: string - Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
-
-format GUID
-- email: string - Buyer email address.
-
-format EMAIL
-One of (id):
-- memberId: string - Member ID (if site visitor is a site member).
-- visitorId: string - Visitor ID (if site visitor is **not** a member).
-
-**CalculationErrors**
-Properties:
-- couponCalculationError: Details - Coupon calculation error.
-- discountsCalculationError: Details - Discount Rule calculation error.
-- giftCardCalculationError: Details - Gift card calculation error.
-- membershipError: Details - Membership payment methods calculation errors
-For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
-- orderValidationErrors: ApplicationError[] - Order validation errors.
-- taxCalculationError: Details - Tax calculation error.
-One of (shippingCalculationError):
-- carrierErrors: CarrierErrors - Carrier errors.
-- generalShippingCalculationError: Details - General shipping calculation error.
-
-**Carrier**
-Properties:
-- appId: string - The carrier app id
-
-format GUID
-- code: string - Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
-
-maxLength 250
-
-**CarrierError**
-Properties:
-- carrierId: string - Carrier ID.
-- error: Details - Error details.
-
-**CarrierErrors**
-Properties:
-- errors: CarrierError[] - Carrier errors.
-
-**CarrierServiceOption**
-Properties:
-- carrierId: string - Carrier ID.
-
-format GUID
-- shippingOptions: ShippingOption[] - Shipping options offered by this carrier for this request.
-
-**CatalogOverrideFields**
-Properties:
-- depositAmount: string - Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
-
-format DECIMAL_VALUE, decimalValue { gt:0, lte:999999999, maxScale:3 }
-- descriptionLines: DescriptionLine[] - Item description lines. Used when displaying the line item to customers.
-
-maxSize 20
-- fullPrice: string - Item price **before** discounts.
-
-decimalValue { gte:0, lte:999999999, maxScale:3 }
-- image: string - Item image.
-- paymentOption: PaymentOption - Payment method selected for the item.
-- physicalProperties: PhysicalProperties - Physical properties of the item.
-- price: string - Item price **after** discounts.
-
-decimalValue { gte:0, lte:999999999, maxScale:3 }
-- productName: ProductName - Item name.
-- savePaymentMethod: boolean - Whether to save the payment method on the order.
-
-Default: `false`
-
-**CatalogReference**
-Properties:
-- appId: string - ID of the app providing the catalog.
-
-You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
-
-For items from Wix catalogs, the following values always apply:
-+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
-
-minLength 1
-- catalogItemId: string - ID of the item within the catalog it belongs to.
-
-minLength 1, maxLength 36
-- options: Record<string, any> - Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
-
-For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
-
-**ChannelInfo**
-Properties:
-- externalOrderId: string - Reference to an order ID from an external system.
-
-maxLength 100
-- externalOrderUrl: string - URL to the order in the external system.
-
-maxLength 300
-- type: ChannelType - Sales channel that submitted the order.
-
-**ChannelType**
-Enum values:
-- AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
-- BACKOFFICE_MERCHANT: Wix merchant backoffice.
-- CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
-- EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
-- ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
-- FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
-- FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
-- GLOBAL_E: Global-E sales channel.
-- OTHER_PLATFORM: Other sales platform.
-- PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
-- POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
-- TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
-- UNSPECIFIED: Unspecified sales channel. This value is not supported.
-- WEB: A web client.
-- WISH: Wish sales channel.
-- WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
-- WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
-
-**ChargebackCreated**
-Properties:
-- amount: Price - Chargeback amount.
-- chargebackId: string - Chargeback ID.
-
-format GUID
-- paymentDetails: RegularPayment - Payment details.
-- paymentId: string - ID of the payment that received a chargeback.
-
-format GUID
-
-**ChargebackReversed**
-Properties:
-- amount: Price - Chargeback amount.
-- chargebackId: string - Chargeback ID.
-
-format GUID
-- paymentDetails: RegularPayment - Payment details.
-- paymentId: string - ID of the payment involved with the chargeback.
-
-format GUID
-- reversalAmount: Price - Chargeback reversal amount.
-
-**ChargeType**
-Enum values:
-- HANDLING_FEE
-- INSURANCE
-
-**Checkout**
-Properties:
-- _createdDate: unknown - Date and time the checkout was created.
-- _id: string - Checkout ID.
-
-format GUID
-- _updatedDate: unknown - Date and time the checkout was updated.
-- additionalFees: V1AdditionalFee[] - Additional Fees.
-
-maxSize 100
-- appliedDiscounts: V1AppliedDiscount[] - Applied discounts.
-- billingInfo: AddressWithContact - Billing information.
-- businessLocationId: string - The business location ID associated with the checkout.
-
-To learn more, see the Locations API.
-
-format GUID
-- buyerInfo: BuyerInfo - Buyer information.
-- buyerLanguage: string - Language for communication with the buyer. Defaults to the site language.
-
-For a site that supports multiple languages, this is the language the buyer selected.
-- buyerNote: string - [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
-
-maxLength 1000
-- calculationErrors: CalculationErrors - Errors when calculating totals.
-- cartId: string - Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
-
-format GUID
-- channelType: ChannelType - Sales channel that submitted the order.
-- completed: boolean - Whether an order was successfully created from this checkout.
-
-For an order to be successful, it must be successfully paid for (unless the total is 0).
-- conversionCurrency: string - The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-
-format CURRENCY
-- createdBy: CreatedBy - ID of the checkout's initiator.
-- currency: string - The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-
-format CURRENCY
-- customContentReference: CustomContentReference - Reference IDs for the app and component providing custom checkout page content.
-
-To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
-Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
-- customFields: CustomField[] - Custom fields.
-- customSettings: CustomSettings - Additional settings for customization of the checkout process.
-
-> **Notes:**
-> * Custom settings can only be set when creating a checkout.
-> * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
-
-immutable
-- extendedFields: ExtendedFields - Custom field data for the checkout object.
-
-[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-- externalReference: ExternalReference - References to an external app and resource associated with this checkout.
-Used for integration and tracking across different platforms.
-
-immutable
-- giftCard: GiftCard - Applied gift card details.
-
->**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
-- lineItems: LineItem[] - Line items.
-
-Max: 300 items
-
-minSize 1, maxSize 300
-- membershipOptions: MembershipOptions - Memberships to apply when creating the order.
-- payAfterFreeTrial: V1PriceSummary - Payment for subscriptions after free trial period.
-- payLater: V1PriceSummary - Remaining amount for the order to be fully paid.
-- paymentCurrency: string - Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-
-format CURRENCY
-- payNow: V1PriceSummary - Minimal amount to pay in order to place the order.
-- priceSummary: V1PriceSummary - Calculated price summary for the checkout.
-- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-
-format GUID
-- shippingInfo: ShippingInfo - Shipping information.
-- siteLanguage: string - Site language in which original values are shown.
-- taxIncludedInPrice: boolean - Whether tax is included in line item prices.
-- taxSummary: V1TaxSummary - Tax summary.
-- violations: Violation[] - List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
-- weightUnit: WeightUnit - Weight measurement unit. Defaults to a site's weight unit.
-
-**Color**
-Properties:
-- code: string - HEX or RGB color code for display.
-- original: string - Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-maxLength 500
-- translated: string - Description line color name translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 500
-
-**Context**
-Properties:
-- currency: string - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
-
-format CURRENCY
-- identity: IdentificationData - An object that describes the identity that triggered this request.
-- instanceId: string - The service provider app's instance ID.
-
-format GUID
-- languages: string[] - A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`.
-- requestId: string - A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.
-
-**Coupon**
-Properties:
-- _id: string - Coupon ID.
-- amount: Price - Coupon value.
-- code: string - Coupon code.
-- name: string - Coupon name.
-
-**CreatedBy**
-One of (id):
-- appId: string - App ID. When the order was created by an external application or Wix service.
-- memberId: string - Member ID. When the order was created by a **logged in** site visitor.
-- userId: string - User ID. When the order was created by a Wix user on behalf of a buyer.
-For example, via POS (point of service).
-- visitorId: string - Visitor ID. When the order was created by a site visitor that was **not** logged in.
-
-**CreditCardDetails**
-Properties:
-- brand: string - Card issuer's brand.
-
-maxLength 100
-- lastFourDigits: string - The last 4 digits of the card number.
-
-maxLength 4
-
-**CurrencyConversionDetails**
-Properties:
-- conversionRate: string - The rate used for converting the original currency to the currency used for payment.
-
-immutable, decimalValue { gt:0, lte:1000000000000000 }
-- originalCurrency: string - Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
-
-This currency is used to calculate the pricing before conversion to the buyer's payment currency.
-
-immutable, format CURRENCY
-
-**CustomActivity**
-Properties:
-- additionalData: Record<string, string> - Additional data in key-value form. For example, `{ "Ticket number": "123456" }`.
-- appId: string - ID of the app that created the custom activity.
-
-format GUID
-- type: string - Custom activity type. For example, `"Ticket number set"`.
-
-maxLength 100
-
-**CustomContentReference**
-Properties:
-- appId: string - ID of the app providing the content.
-
-You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
-
-format GUID
-- componentId: string - ID of the component within the app it belongs to.
-
-You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
-
-format GUID
-
-**CustomField**
-Properties:
-- title: string - Custom field title.
-
-minLength 1, maxLength 500
-- translatedTitle: string - Translated custom field title.
-
-minLength 1, maxLength 500
-- value: any - Custom field value.
-
-**CustomSettings**
-Properties:
-- disabledManualPayment: boolean - Whether to disable manual payment option for this checkout.
-
-Default: `false`
-- disabledPolicyAgreementCheckbox: boolean - Whether to disable policy agreement checkout in the checkout page
-
-Default: `false`
-- lockCouponCode: boolean - Whether to restrict the option to add or remove a coupon code on the checkout page.
-
-Default: `false`
-- lockGiftCard: boolean - Whether to restrict the option to add or remove a gift card on the checkout page.
-
-Default: `false`
-
-**DeliveryAllocation**
-Properties:
-- applicableLineItems: ApplicableLineItems - Populated if the delivery solution is a partially supplied by this carrier.
-- deliveryCarrier: Carrier - The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers
-- deliveryRegion: Region - The delivery region that are relevant for this delivery solution.
-
-**DeliveryLogistics**
-Properties:
-- deliverByDate: unknown (deprecated) - Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-- deliveryTime: string - Expected delivery time in free text. For example, `"3-5 business days"`.
-
-maxLength 500
-- deliveryTimeSlot: DeliveryTimeSlot - Expected delivery time.
-- instructions: string - Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
-
-maxLength 1000
-One of (address):
-- pickupDetails: PickupDetails - Pickup details.
-- shippingDestination: ApiAddressWithContact - Shipping address and contact details.
-
-**DeliveryTimeSlot**
-Properties:
-- from: unknown - Delivery slot starting time.
-- to: unknown - Delivery slot ending time.
-
-**Description**
-Properties:
-- original: string - Subscription option description.
-
-maxLength 500
-- translated: string - Translated subscription option description.
-
-maxLength 500
-
-**DescriptionLine**
-Properties:
-- name: DescriptionLineName - Description line name.
-One of (value):
-- colorInfo: Color - Description line color value.
-- plainText: PlainTextValue - Description line plain text value.
-
-**DescriptionLineName**
-Properties:
-- original: string - Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-maxLength 100
-- translated: string - Description line name translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 200
-
-**Details**
-Properties:
-- tracing: Record<string, string> (deprecated) - deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
-One of (kind):
-- applicationError: ApplicationError
-- systemError: SystemError
-- validationError: ValidationError
-
-**DigitalFile**
-Properties:
-- expirationDate: unknown - Link expiration time and date.
-- fileId: string - ID of the secure file in media.
-
-minLength 1, maxLength 100
-- link: string - Link will exist after the digital links have been generated on the order.
-
-format WEB_URL, minLength 1, maxLength 2000
-
-**DiscountReason**
-Enum values:
-- BILLING_ADJUSTMENT
-- EXCHANGED_ITEMS
-- UNSPECIFIED
-
-**DiscountRule**
-Properties:
-- _id: string - Discount rule ID
-
-format GUID
-- amount: Price - Discount value.
-- name: DiscountRuleName - Discount rule name
-
-**DiscountRuleName**
-Properties:
-- original: string - Original discount rule name (in site's default language).
-
-minLength 1, maxLength 256
-- translated: string - Translated discount rule name according to buyer language. Defaults to `original` when not provided.
-
-minLength 1, maxLength 500
-
-**DiscountType**
-Enum values:
-- GLOBAL
-- SHIPPING
-- SPECIFIC_ITEMS
-
-**DraftOrderChangesApplied**
-Properties:
-- changes: OrderChange[] - Changes applied to order.
-- draftOrderId: string - Draft order id.
-- reason: string - Reason for edit, given by user (optional).
-
-maxLength 200
-
-**ExtendedFields**
-Properties:
-- namespaces: Record<string, Record<string, any>> - Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-The value of each key is structured according to the schema defined when the extended fields were configured.
-
-You can only access fields for which you have the appropriate permissions.
-
-Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-
-**ExternalReceipt**
-Properties:
-- displayNumber: string - Display number of receipt
-
-minLength 1, maxLength 40
-- receiptId: string - Receipt ID
-
-maxLength 100
-
-**ExternalReference**
-Properties:
-- appId: string - ID of the app associated with the purchase flow.
-For example, the Wix Pay Links app ID.
-
-format GUID, immutable
-- resourceId: string - Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
-For example, a Wix Pay Link ID.
-
-minLength 1, maxLength 100, immutable
-
-**FallbackReason**
-Enum values:
-- AUTO_TAX_DEACTIVATED: auto-tax was temporarily deactivated on a system-level
-- AUTO_TAX_FAILED: auto-tax failed to be calculated
-
-**FieldViolation**
-Properties:
-- data: Record<string, any>
-- description: string
-- field: string
-- ruleName: string - applicable when violated_rule=OTHER
-- violatedRule: RuleType
-
-**FreeTrialPeriod**
-Properties:
-- frequency: SubscriptionFrequency - Frequency of period. Values: DAY, WEEK, MONTH, YEAR
-- interval: number - interval of period
-
-min 1, max 3650
-
-**FulfillmentStatus**
-Enum values:
-- FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled.
-Orders without shipping info are fulfilled automatically.
-- NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled.
-- PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled.
-
-**FullAddressContactDetails**
-Properties:
-- company: string - Company name.
-
-maxLength 1000
-- firstName: string - First name.
-
-maxLength 100
-- lastName: string - Last name.
-
-maxLength 100
-- phone: string - Phone number.
-
-format PHONE
-- vatId: VatId - Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
-
-**GetPaymentSettingsEnvelope**
-Properties:
-- metadata: Context
-- request: GetPaymentSettingsRequest
-
-**GetPaymentSettingsForCheckoutEnvelope**
-Properties:
-- metadata: Context
-- request: GetPaymentSettingsForCheckoutRequest
-
-**GetPaymentSettingsForCheckoutRequest**
-Properties:
-- checkout: Checkout - Checkout.
-
-**GetPaymentSettingsForCheckoutResponse**
-Properties:
-- blockedPaymentOptions: V1PaymentOption[] - Blocked payment options.
-
-**GetPaymentSettingsRequest**
-Properties:
-- order: Order - Order.
-
-**GetPaymentSettingsResponse**
-Properties:
-- paymentSettings: PaymentSettings - Retrieved payment settings.
-
-**GiftCard**
-Properties:
-- _id: string (deprecated) - Gift Card ID.
-- amount: MultiCurrencyPrice - Actual amount to be redeemed from the gift card.
-- appId: string - App ID of the gift card provider.
-
-format GUID
-- externalId: string - External ID in the gift card provider's system.
-Used for integration and tracking across different platforms.
-
-minLength 1, maxLength 50
-- obfuscatedCode: string - Gift card obfuscated code.
-- requestedAmount: MultiCurrencyPrice - Requested amount to redeem from the gift card.
-
-**GiftCardPaymentRefund**
-Properties:
-- amount: Price - Refund amount
-- giftCardPaymentId: string - Gift card payment ID
-
-minLength 1, maxLength 100
-
-**IdentificationData**
-Properties:
-- identityType: IdentityType
-One of (id):
-- anonymousVisitorId: string - ID of a site visitor that has not logged in to the site.
-- appId: string - ID of an app.
-- memberId: string - ID of a site visitor that has logged in to the site.
-- wixUserId: string - ID of a Wix user (site owner, contributor, etc.).
-
-**IdentityType**
-Enum values:
-- ANONYMOUS_VISITOR
-- APP
-- MEMBER
-- UNKNOWN
-- WIX_USER
-
-**InvalidMembership**
-Properties:
-- membership: Membership - Membership details.
-- reason: string - Reason why this membership is invalid and cannot be used.
-
-minLength 1, maxLength 100
-
-**ItemAvailabilityInfo**
-Properties:
-- quantityAvailable: number - Quantity available.
-- status: ItemAvailabilityStatus - Item availability status.
-
-**ItemAvailabilityStatus**
-Enum values:
-- AVAILABLE
-- NOT_AVAILABLE: Item is not in stock.
-- NOT_FOUND: Item does not exist.
-- PARTIALLY_AVAILABLE: Available quantity is less than requested.
-
-**ItemModifier**
-Properties:
-- _id: string - Modifier ID.
-
-minLength 1, maxLength 36
-- details: TranslatableString - Additional details.
-- label: TranslatableString - Primary display label for the modifier.
-- price: MultiCurrencyPrice - The price of the modifier.
-- quantity: number - The quantity of this modifier.
-
-min 1, max 100000
-
-**ItemTaxFullDetails**
-Properties:
-- taxableAmount: Price - Taxable amount of this line item.
-- taxRate: string - Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
-
-decimalValue { gte:0, maxScale:6 }
-- totalTax: Price - The calculated tax, based on the `taxableAmount` and `taxRate`.
-
-**ItemType**
-One of (itemTypeData):
-- custom: string - Custom item type. When none of the preset types are suitable, specifies the custom type.
-- preset: ItemTypeItemType - Preset item type.
-
-**ItemTypeItemType**
-Enum values:
-- DIGITAL
-- GIFT_CARD
-- PHYSICAL
-- SERVICE
-- UNRECOGNISED
-
-**JurisdictionType**
-Enum values:
-- CITY
-- COUNTRY
-- COUNTY
-- SPECIAL
-- STATE
-- UNDEFINED
-
-**LineItem**
-Properties:
-- _id: string - Line item ID.
-
-format GUID
-- availability: ItemAvailabilityInfo - Item availability details.
-- catalogOverrideFields: CatalogOverrideFields - Overriding values for catalog item properties.
-
-To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
-Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
-- catalogReference: CatalogReference - Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin.
-- consentRequiredPaymentPolicy: string - Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
-
-minLength 1, maxLength 2500
-- customLineItem: boolean - Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
-- deliveryProfileId: string - Delivery profile ID.
-
-format GUID
-- depositAmount: MultiCurrencyPrice - Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
-- descriptionLines: DescriptionLine[] - Line item description lines. Used for display purposes for the cart, checkout and order.
-- discount: MultiCurrencyPrice - Discount for this line item's entire quantity.
-- fixedQuantity: boolean - Whether the line item quantity is fixed and cannot be changed.
-- fullPrice: MultiCurrencyPrice - Item price **before** catalog-defined discount. Defaults to `price` when not provided.
-- itemType: ItemType - Item type. Either a preset type or custom.
-- lineItemPrice: MultiCurrencyPrice - Total line item price **after** catalog-defined discount and line item discounts.
-- media: string - Line item image details.
-- membersOnly: boolean - Whether the item can only be purchased by site members.
-
-Default: `false`
-- modifierGroups: ModifierGroup[] - Modifier groups that were added to the item.
-
-maxSize 25
-- modifiersTotalPrice: MultiCurrencyPrice - Total price of all item modifiers. Included in the item price.
-- paymentOption: PaymentOptionType - Type of selected payment option for current item.
-
-Default: `FULL_PAYMENT_ONLINE`
-- physicalProperties: PhysicalProperties - Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
-- policies: Policy[] - Policies to be displayed to the customer on the checkout page.
-
-maxSize 5
-- price: MultiCurrencyPrice - Item price **after** catalog-defined discount and line item discounts.
-- priceBeforeDiscounts: MultiCurrencyPrice - Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
-- priceDescription: PriceDescription - Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
-- priceUndetermined: boolean - Whether the price is not yet defined, and will be updated after the order is created.
-- productName: ProductName - Item name.
-+ Stores - `product.name`
-+ Bookings - `service.info.name`
-+ Events - `ticket.name`
-- quantity: number - Item quantity.
-
-Min: `"1"`
-Max: `"100000"`
-
-min 1, max 100000
-- rootCatalogItemId: string - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
-+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
-+ In most cases, this field has the same value as `catalogReference.catalogItemId`.
-+ Used in membership validation.
-
-minLength 1, maxLength 36
-- savePaymentMethod: boolean - Whether to save the payment method on the order.
-
-Default: `false`
-- serviceProperties: ServiceProperties - Service properties. When relevant, this contains information such as date and number of participants.
-- subscriptionOptionInfo: SubscriptionOptionInfo - Subscription option information.
-- taxableAddress: TaxableAddress - Address to use for tax calculation purposes.
-- taxDetails: V1ItemTaxFullDetails - Tax details for this line item.
-- totalPriceAfterTax: MultiCurrencyPrice - Total price after all discounts and tax.
-- totalPriceBeforeTax: MultiCurrencyPrice - Total price after discounts, and before tax.
-- url: string - URL to the item's page on the site.
-
-**LineItemAmount**
-Properties:
-- _id: string - Order line item id
-
-format GUID
-- amount: Price - Amount associated with this item. (Discount amount for item / additional fee amount for item)
-- name: ProductName - Item name.
-
-**LineItemChanges**
-Properties:
-- _id: string - Line item ID.
-
-format GUID
-- name: ProductName - Item name after change.
-- price: LineItemPriceChange - Item price change.
-- quantity: LineItemQuantityChange - Item quantity change.
-
-**LineItemPriceChange**
-Properties:
-- newPrice: Price - Item price after update.
-- originalPrice: Price - Item price before update.
-
-**LineItemQuantityChange**
-Properties:
-- deltaType: LineItemQuantityChangeType - Type of quantity change: increase or decrease.
-- diff: number - Difference between original and new quantity. Absolute value.
-
-min 1, max 1000000
-- newQuantity: number - Item quantity after update.
-
-max 1000000
-- originalQuantity: number - Item quantity before update.
-
-max 1000000
-
-**LineItemQuantityChangeType**
-Enum values:
-- QUANTITY_DECREASED: Quantity decreased.
-- QUANTITY_INCREASED: Quantity increased.
-
-**LineItemTaxBreakdown**
-Properties:
-- jurisdiction: string - Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
-
-maxLength 200
-- jurisdictionType: JurisdictionType - Type of jurisdiction that taxes were calculated for.
-- nonTaxableAmount: Price - Non-taxable amount of the line item price.
-- rate: string - Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
-
-format DECIMAL_VALUE, decimalValue { gte:0, maxScale:6 }
-- taxableAmount: Price - Taxable amount of the line item price.
-- taxAmount: Price - Amount of tax calculated for this line item.
-- taxName: string - The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
-This name should be explicit enough to allow the merchant to understand what tax was calculated.
-
-maxLength 200
-- taxType: string - The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
-
-maxLength 200
-
-**LineItemTaxInfo**
-Properties:
-- taxableAmount: Price - Amount for which tax is calculated.
-- taxAmount: Price - Calculated tax, based on `taxable_amount` and `tax_rate`.
-- taxBreakdown: LineItemTaxBreakdown[] - Tax information for a line item.
-
-maxSize 7
-- taxGroupId: string - Tax group ID.
-
-format GUID
-- taxIncludedInPrice: boolean - Indicates whether the price already includes tax.
-- taxRate: string - Tax rate %, as a decimal point.
-
-format DECIMAL_VALUE, decimalValue { gte:0, maxScale:6 }
-
-**Location**
-Properties:
-- _id: string - Location ID.
-Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
-
-format GUID
-- name: string - Location name.
-
-minLength 1, maxLength 500
-
-**LocationAndQuantity**
-Properties:
-- _id: string - Location id in the associated owner app.
-
-format GUID
-- appId: string (deprecated) - Location owner app, if not provided then the site business info locations will be used.
-
-format GUID
-- name: string - Location name.
-
-maxLength 500
-- quantity: number - Quantity for specific location.
-
-min 1, max 100000
-
-**ManagedAdditionalFee**
-Properties:
-- _id: string - Additional fee id.
-
-format GUID
-- affectedLineItems: LineItemAmount[] - Line items additional fee applies to.
-- name: TranslatedValue - Additional fee name.
-- totalAmount: Price - Additional fee amount.
-
-**ManagedDiscount**
-Properties:
-- _id: string - Discount id.
-
-format GUID
-- affectedLineItems: LineItemAmount[] - Line items discount applies to.
-- name: TranslatedValue - Discount name: coupon name / discount rule name / merchant discount description.
-- totalAmount: Price - Discount amount.
-
-**ManagedLineItem**
-Properties:
-- _id: string - Line item ID.
-
-format GUID
-- name: ProductName - Item name.
-- quantity: number - Added or removed item quantity.
-
-min 1, max 1000000
-
-**ManualCalculationReason**
-Enum values:
-- GLOBAL_SETTING_TO_MANUAL: user set calculator in Business Manager to be Manual
-- REGION_SETTING_TO_MANUAL: specific region is on manual even though Global setting is Auto-tax
-
-**Membership**
-Properties:
-- _id: string - Membership ID.
-
-minLength 1, maxLength 100
-- additionalData: Record<string, any> - Additional data about this membership.
-- appId: string - ID of the application providing this payment option.
-
-format GUID
-- credits: MembershipPaymentCredits - Optional - For a membership that has limited credits, information about credit usage.
-- expirationDate: unknown - Optional - TMembership expiry date.
-- lineItemIds: string[] - Line item IDs which are "paid" for by this membership.
-
-minSize 1, maxSize 300, minLength 1, maxLength 100
-- name: MembershipName - The name of this membership.
-
-**MembershipName**
-Properties:
-- original: string - Membership name.
-
-maxLength 100
-- translated: string - Translated membership name. Defaults to `original` when not provided.
-
-maxLength 100
-
-**MembershipOptions**
-Properties:
-- eligibleMemberships: Membership[] - Reserved for internal use.
-
-maxSize 300
-- invalidMemberships: InvalidMembership[] - Reserved for internal use.
-
-maxSize 300
-- selectedMemberships: SelectedMemberships - Selected membership to apply to this checkout.
-
-**MembershipPaymentCredits**
-Properties:
-- remaining: number - Membership's remaining amount of credits.
-- total: number - Membership's total amount of credits.
-
-min 1
-
-**MembershipPaymentRefund**
-Properties:
-- membershipId: string - Membership ID
-
-minLength 1, maxLength 100
-
-**MerchantComment**
-Properties:
-- message: string - Merchant comment message.
-
-minLength 1, maxLength 5000
-
-**MerchantDiscount**
-Properties:
-- amount: Price - Discount amount.
-One of (merchantDiscountReason):
-- description: string - Discount description as free text (optional).
-- discountReason: DiscountReason - Pre-defined discount reason (optional).
-* `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
-
-**ModifierGroup**
-Properties:
-- _id: string - Modifier group ID.
-
-minLength 1, maxLength 36
-- modifiers: ItemModifier[] - List of modifiers in this group.
-
-minSize 1, maxSize 25
-- name: TranslatableString - Modifier group name.
-
-**MultiCurrencyPrice**
-Properties:
-- amount: string - Amount.
-
-decimalValue { gte:0, lte:1000000000000000 }
-- convertedAmount: string - Converted amount.
-
-decimalValue { gte:0, lte:1000000000000000 }
-- formattedAmount: string - Amount formatted with currency symbol.
-- formattedConvertedAmount: string - Converted amount formatted with currency symbol.
-
-**Order**
-Properties:
-- _createdDate: unknown - Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-
-immutable
-- _id: string - Order ID.
-
-format GUID
-- _updatedDate: unknown - Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-- activities: Activity[] - Order activities.
-
-maxSize 1000
-- additionalFees: AdditionalFee[] - Additional fees applied to the order.
-
-maxSize 100
-- appliedDiscounts: AppliedDiscount[] - Applied discounts.
-
-maxSize 320
-- archived: boolean - Whether order is archived.
-- attributionSource: AttributionSource - Order attribution source.
-- balanceSummary: BalanceSummary - Balance summary.
-- billingInfo: ApiAddressWithContact - Billing address and contact details.
-- businessLocation: Location - Order Location
-- buyerInfo: V1BuyerInfo - Buyer information.
-- buyerLanguage: string - Language for communication with the buyer. Defaults to the site language.
-For a site that supports multiple languages, this is the language the buyer selected.
-- buyerNote: string - [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
-
-maxLength 1000
-- channelInfo: ChannelInfo - Information about the sales channel that submitted this order.
-- checkoutId: string - Checkout ID.
-
-format GUID
-- createdBy: V1CreatedBy - ID of the order's initiator.
-- currency: string - Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
-
-format CURRENCY
-- currencyConversionDetails: CurrencyConversionDetails - Currency conversion details. For use with multi-currency sites.
-- customFields: CustomField[] - Custom fields.
-- extendedFields: ExtendedFields - Custom field data for the order object.
-
-[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-- fulfillmentStatus: FulfillmentStatus - Order fulfillment status.
-- lineItems: OrderLineItem[] - Order line items.
-
-minSize 1, maxSize 300
-- number: string - Order number displayed in the site owner's dashboard (auto-generated).
-- payAfterFreeTrial: PriceSummary - Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
-- paymentStatus: PaymentStatus - Order payment status.
-- priceSummary: PriceSummary - Order price summary.
-- purchasedDate: unknown - Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-Used for migration from external systems.
-
-immutable
-- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-
-format GUID
-- recipientInfo: ApiAddressWithContact - Order recipient address and contact details.
-
-This field may differ from the address in `shippingInfo.logistics` when:
-+ The chosen shipping option is pickup point or store pickup.
-+ No shipping option is selected.
-- seenByAHuman: boolean - Whether a human has seen the order. Set when an order is clicked on in the dashboard.
-- shippingInfo: V1ShippingInformation - Shipping info and selected shipping option details.
-- siteLanguage: string - Site language in which original values are shown.
-
-immutable
-- status: OrderStatus - Order status.
-- tags: Tags - Order tags.
-
-[Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
-- taxIncludedInPrices: boolean - Whether tax is included in line item prices.
-
-immutable
-- taxInfo: OrderTaxInfo - Tax information.
-- taxSummary: TaxSummary (deprecated) - Tax summary.
-Deprecated. Use `taxInfo` instead.
-This field will be removed on September 30, 2024.
-- weightUnit: WeightUnit - Weight measurement unit - defaults to site's weight unit.
-
-**OrderChange**
-One of (value):
-- additionalFeeAdded: ManagedAdditionalFee
-- additionalFeeRemoved: ManagedAdditionalFee
-- discountAdded: ManagedDiscount
-- discountRemoved: ManagedDiscount
-- lineItemAdded: ManagedLineItem
-- lineItemChanged: LineItemChanges
-- lineItemRemoved: ManagedLineItem
-- shippingInformationChanged: ShippingInformationChange
-- totalPriceChanged: TotalPriceChange
-
-**OrderLineItem**
-Properties:
-- _id: string - Line item ID.
-
-immutable
-- catalogReference: CatalogReference - References to the line item's origin catalog.
-This field may be empty in the case of a custom line item.
-- depositAmount: Price - Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
-- descriptionLines: DescriptionLine[] - Line item description lines. Used for display purposes for the cart, checkout and order.
-
-maxSize 20
-- digitalFile: DigitalFile - Digital file identifier, relevant only for items with type DIGITAL.
-- extendedFields: ExtendedFields - Custom extended fields for the line item object.
-
-[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-- fulfillerId: string - Fulfiller ID. Field is empty when the line item is self-fulfilled.
-To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
-
-format GUID
-- image: string - Line item image.
-- itemType: ItemType - Item type. Either a preset type or custom.
-- locations: LocationAndQuantity[] - Line item locations.
-
-The location's total quantity must not exceed the line item quantity.
-
-maxSize 5
-- modifierGroups: V1ModifierGroup[] - Modifier groups that were added to the item.
-
-maxSize 10
-- paymentOption: PaymentOptionType - Type of selected payment option for current item.
-
-Default: `FULL_PAYMENT_ONLINE`
-- physicalProperties: PhysicalProperties - Physical properties of the item. When relevant, contains information such as SKU and item weight.
-- price: Price - Line item price after line item discounts for display purposes.
-- priceBeforeDiscounts: Price - Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
-- priceDescription: PriceDescription - Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
-- productName: ProductName - Item name.
-+ Stores - `product.name`
-+ Bookings - `service.info.name`
-+ Events - `ticket.name`
-- quantity: number - Line item quantity.
-
-min 1, max 100000
-- refundQuantity: number - Number of items that were refunded.
-
-max 100000
-- restockQuantity: number - Number of items restocked.
-
-max 100000
-- subscriptionInfo: SubscriptionInfo - Subscription info.
-- taxableAddress: TaxableAddress - Address used for tax calculation.
-- taxDetails: ItemTaxFullDetails (deprecated) - Deprecated. Use `taxInfo` instead.
-This field will be removed on September 30, 2024.
-Tax details for this line item.
-- taxInfo: LineItemTaxInfo - Represents all the relevant tax details for a specific line item.
-- totalDiscount: Price - Total discount for this line item's entire quantity.
-- totalPriceAfterTax: Price - Total price after all discounts and tax.
-- totalPriceBeforeTax: Price - Total price after discounts, and before tax.
-
-**OrderRefunded**
-Properties:
-- amount: Price - Refund amount.
-- manual: boolean - Whether order was refunded manually. For example, via payment provider or using cash.
-- reason: string - Reason for refund.
-
-maxLength 200
-
-**OrderStatus**
-Enum values:
-- APPROVED: Order approved.
-
-This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
-Offline orders (cash payment) are automatically approved.
-- CANCELED: Order canceled by the user.
-- INITIALIZED: Order created, but not yet approved or canceled.
-- PENDING: Order pending.
-- REJECTED: Order rejected.
-
-This happens when pending payments fail.
-
-**OrderTaxBreakdown**
-Properties:
-- aggregatedTaxAmount: Price - The sum of all the tax from line items that calculated by the tax identifiers.
-- jurisdiction: string - The name of the jurisdiction in which this tax detail applies.
-
-maxLength 200
-- jurisdictionType: JurisdictionType - The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
-- rate: string - The rate at which this tax detail was calculated.
-
-format DECIMAL_VALUE, decimalValue { gte:0, maxScale:6 }
-- taxName: string - The name of the tax against which this tax amount was calculated.
-
-maxLength 200
-- taxType: string - The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
-
-maxLength 200
-
-**OrderTaxInfo**
-Properties:
-- taxBreakdown: OrderTaxBreakdown[] - 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.
-
-maxSize 50
-- taxExempt: boolean - Whether the order is exempt from tax calculations.
-
-Default: `false`
-- totalTax: Price - Calculated tax, added from line items.
-
-**Other**
-Properties:
-- name: string - Location on a checkout or a cart page where a general (other) violation will be displayed.
-
-**OtherCharge**
-Properties:
-- details: string - Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
-
-maxLength 250
-- price: MultiCurrencyPrice - Price of added cost.
-- type: ChargeType - Type of additional cost.
-
-**PaymentCanceled**
-Properties:
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-One of (paymentDetails):
-- regular: RegularPayment - Regular payment.
-
-**PaymentDeclined**
-Properties:
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-One of (paymentDetails):
-- regular: RegularPayment - Regular payment.
-
-**PaymentOption**
-Properties:
-- value: PaymentOptionType - Type of selected payment option for current item.
-
-Default: `FULL_PAYMENT_ONLINE`
-
-**PaymentOptionType**
-Enum values:
-- DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
-- FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
-- FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
-- MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
-- MEMBERSHIP_OFFLINE: Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`.
-- MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
-
-**PaymentPending**
-Properties:
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-One of (paymentDetails):
-- regular: RegularPayment - Regular payment.
-
-**PaymentRefunded**
-Properties:
-- payment: RefundedPayment - Details about the refunded payment.
-- refundId: string - Refund ID.
-
-format GUID
-
-**PaymentRefundFailed**
-Properties:
-- payment: RefundedPayment - Details about the failed payment refund.
-- refundId: string - Refund ID.
-
-format GUID
-
-**PaymentSettings**
-Properties:
-- requires3dSecure: boolean - Whether to apply [3D Secure](https://support.wix.com/en/article/about-3d-secure-3ds-payments-with-third-party-payment-providers) during the payment process.
-
-> __Note:__
-> + Not all payment providers offer this feature in their Wix integration.
-> + If the service plugin call fails, the value set in the [extension configuration](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/payment-settings-integration-spi/introduction#configuration) for `fallbackValueForRequires3dSecure` will be used.
-
-**PaymentSettingsSPIConfig**
-Properties:
-- deploymentUri: string - *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
-For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
-the base URI you provide here is `https://my-payment-settings.com/`.
-- fallbackValueForRequires3dSecure: boolean - The value to set for `paymentSettings.requires3dSecure` if the service plugin call fails.
-
-Default: `false`
-- providePaymentsSettingsForCheckout: boolean - `true` if SPI implementer provides payments settings for checkout
-
-Default: `false`
-
-**PaymentStatus**
-Enum values:
-- CANCELED: One or more payments canceled.
-- DECLINED: One or more payments declined.
-- FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
-- NOT_PAID: `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
-This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
-- PAID: All required payments associated with this order are paid.
-- PARTIALLY_PAID: At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details.
-- PARTIALLY_REFUNDED: Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details.
-- PENDING: All payments pending.
-
-This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly.
-Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
-- PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider.
-
-In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
-To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
-- UNSPECIFIED
-
-**PhysicalProperties**
-Properties:
-- shippable: boolean - Whether this line item is shippable.
-- sku: string - Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
-
-maxLength 40
-- weight: number - Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
-
-**PickupAddress**
-Properties:
-- addressLine1: string - Main address line (usually street name and number).
-
-maxLength 1000
-- addressLine2: string - Free text providing more detailed address info. Usually contains apt, suite, floor.
-
-maxLength 1000
-- city: string - City name.
-
-maxLength 1000
-- country: string - Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
-
-format COUNTRY
-- countryFullname: string - Country's full name.
-- postalCode: string - Postal or zip code.
-
-maxLength 1000
-- streetAddress: StreetAddress - Street address object, with number, name, and apartment number in separate fields.
-- subdivision: string - Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
-
-maxLength 50
-- subdivisionFullname: string - Subdivision full-name.
-
-**PickupDetails**
-Properties:
-- address: PickupAddress - Pickup address.
-- pickupMethod: PickupMethod - Pickup method
-
-**PickupDetailsPickupMethod**
-Enum values:
-- PICKUP_POINT
-- STORE_PICKUP
-- UNKNOWN_METHOD
-
-**PickupMethod**
-Enum values:
-- PICKUP_POINT
-- STORE_PICKUP
-- UNKNOWN_METHOD
-
-**PlainTextValue**
-Properties:
-- original: string - Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-maxLength 600
-- translated: string - Description line plain text value translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 600
-
-**Policy**
-Properties:
-- content: string - Policy content - should be translated
-
-minLength 1, maxLength 3000
-- title: string - Policy title - should be translated
-
-minLength 1, maxLength 29
-
-**Price**
-Properties:
-- amount: string - Amount.
-
-decimalValue { gte:0, lte:1000000000000000 }
-- formattedAmount: string - Amount formatted with currency symbol.
-
-**PriceDescription**
-Properties:
-- original: string - __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-minLength 1, maxLength 100
-- translated: string - Price description translated into the buyer's language.
-
-Default: Same as `original`.
-
-minLength 1, maxLength 100
-
-**PriceSummary**
-Properties:
-- discount: Price - Total calculated discount value.
-- shipping: Price - Total shipping price, before discounts and before tax.
-- subtotal: Price - Subtotal of all the line items, before discounts and before tax.
-- tax: Price - Total tax on this order.
-- total: Price - Order’s total price after discounts and tax.
-- totalAdditionalFees: Price - Total price of additional fees before tax.
-
-**ProductName**
-Properties:
-- original: string - __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-Min: 1 character.
-Max: 200 characters.
-
-minLength 1, maxLength 200
-- translated: string - Item name translated into the buyer's language.
-
-Min: 1 character.
-Max: 400 characters.
-Default: Same as `original`.
-
-minLength 1, maxLength 400
-
-**RateType**
-Enum values:
-- AUTO_RATE: autotax rate used for calculation
-- FALLBACK_RATE: fallback rate used for calculation
-- MANUAL_RATE: manual rate used for calculation
-- NO_TAX_COLLECTED: no tax being collected for this request due to location of purchase
-
-**ReceiptCreated**
-Properties:
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-One of (receiptInfo):
-- externalReceipt: ExternalReceipt - Receipt created by an external system.
-- wixReceipt: WixReceipt - Receipt created by Wix
-
-**ReceiptSent**
-Properties:
-- paymentId: string - Payment ID of payment associated with this activity
-
-format GUID
-One of (receiptInfo):
-- externalReceipt: ExternalReceipt - Receipt created by an external system.
-- wixReceipt: WixReceipt - Receipt created by Wix
-
-**RefundedAsStoreCredit**
-Properties:
-- amount: Price - Refund amount
-- reason: string - Reason for refund
-
-maxLength 100
-
-**RefundedPayment**
-Properties:
-- externalRefund: boolean - Whether refund was made externally and manually on the payment provider's side.
-- paymentId: string - Payment ID.
-
-format GUID
-One of (kind):
-- giftCard: GiftCardPaymentRefund - Gift card payment refund.
-- membership: MembershipPaymentRefund - Membership payment refund.
-- regular: RegularPaymentRefund - Regular payment refund.
-
-**RefundInitiated**
-Properties:
-- amount: Price - Refund amount.
-- payments: RefundedPayment[] - Details about the payments being refunded.
-
-minSize 1, maxSize 50
-- reason: string - Reason for refund.
-
-maxLength 200
-- refundId: string - Refund ID.
-
-format GUID
-
-**Region**
-Properties:
-- _id: string - The delivery region id.
-
-format GUID
-- name: string - The delivery region name.
-
-maxLength 100
-
-**RegularPayment**
-Properties:
-- amount: Price - Payment amount
-One of (paymentMethodDetails):
-- creditCardDetails: CreditCardDetails - Whether regular card used
-
-**RegularPaymentRefund**
-Properties:
-- amount: Price - Refund amount
-- brand: string - Card issuer's brand.
-
-maxLength 100
-- lastFourDigits: string - The last 4 digits of the card number.
-
-maxLength 4
-
-**RuleType**
-Enum values:
-- DECIMAL_GT
-- DECIMAL_GTE
-- DECIMAL_LT
-- DECIMAL_LTE
-- DECIMAL_MAX_SCALE
-- EXACT_LENGTH
-- EXACT_SIZE
-- FIELD_NOT_ALLOWED
-- FORMAT
-- INVALID_ENUM_VALUE
-- MAX
-- MAX_LENGTH
-- MAX_SIZE
-- MIN
-- MIN_LENGTH
-- MIN_SIZE
-- ONE_OF_ALIGNMENT
-- OTHER
-- REQUIRED_FIELD
-- REQUIRED_ONE_OF_FIELD
-- VALIDATION
-
-**SavedPaymentMethod**
-Properties:
-- description: string - Payment method description
-
-minLength 1, maxLength 100
-- name: string - Payment method name
-
-minLength 1, maxLength 100
-
-**SelectedCarrierServiceOption**
-Properties:
-- carrierId: string - This carrier's unique ID
-
-format GUID
-- code: string - Unique identifier of selected option. For example, "usps_std_overnight".
-
-maxLength 100
-- cost: SelectedCarrierServiceOptionPrices - Shipping costs.
-- deliveryAllocations: DeliveryAllocation[] - Delivery solution allocations to different delivery carriers and delivery regions
-
-maxSize 300
-- logistics: V1DeliveryLogistics - Delivery logistics.
-- otherCharges: SelectedCarrierServiceOptionOtherCharge[] (deprecated) - Other charges
-- partial: boolean - If the delivery solution is a partial and doesn't apply to all items.
-- requestedShippingOption: boolean - Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
-- title: string - Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
-For example, "Standard" or "First-Class Package International".
-
-maxLength 250
-
-**SelectedCarrierServiceOptionOtherCharge**
-Properties:
-- cost: SelectedCarrierServiceOptionPrices - Price of added charge.
-- details: string - Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
-
-maxLength 200
-- type: ChargeType - Type of additional cost.
-
-**SelectedCarrierServiceOptionPrices**
-Properties:
-- price: MultiCurrencyPrice - Shipping price before discount and before tax.
-- taxDetails: V1ItemTaxFullDetails - Tax details.
-- totalDiscount: MultiCurrencyPrice - Shipping discount before tax.
-- totalPriceAfterTax: MultiCurrencyPrice - Total shipping price, after discount and after tax.
-- totalPriceBeforeTax: MultiCurrencyPrice - Total price of shipping after discounts (when relevant), and before tax.
-
-**SelectedMembership**
-Properties:
-- _id: string - Membership ID.
-
-minLength 1, maxLength 100
-- appId: string - ID of the app providing this payment option.
-
-format GUID
-- lineItemIds: string[] - IDs of the line items this membership applies to.
-
-minSize 1, maxSize 300, minLength 1, maxLength 100
-
-**SelectedMemberships**
-Properties:
-- memberships: SelectedMembership[] - Selected memberships.
-
-maxSize 300
-
-**ServiceProperties**
-Properties:
-- numberOfParticipants: number - The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
-
-min 1, max 10000
-- scheduledDate: unknown - Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-For example, the start time of a class.
-
-**Severity**
-Enum values:
-- ERROR: The user is blocked from moving forward in the flow.
-For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
-- WARNING: The user is allowed to move forward in the flow.
-
-**ShippingInfo**
-Properties:
-- carrierServiceOptions: CarrierServiceOption[] - All carrier options for this shipping rule.
-- region: V1ShippingRegion - Shipping region. Based on the address provided.
-- selectedCarrierServiceOption: SelectedCarrierServiceOption - Selected option out of the options allowed for the `region`.
-- shippingDestination: AddressWithContact - Shipping address and contact details.
-
-**ShippingInformation**
-Properties:
-- shippingTitle: string - Order’s shipping title.
-
-maxLength 250
-- total: Price - Order’s shipping price.
-
-**ShippingInformationChange**
-Properties:
-- newShippingInfo: ShippingInformation - Order’s Shipping Information. After update
-- originalShippingInfo: ShippingInformation - Order’s Shipping Information. Before update
-
-**ShippingOption**
-Properties:
-- code: string - Unique code of provided shipping option like "usps_std_overnight".
-For legacy calculators this would be the UUID of the option.
-
-maxLength 100
-- cost: V1ShippingPrice - Sipping price information.
-- deliveryAllocations: DeliveryAllocation[] - Delivery solution allocations to different delivery carriers and delivery regions
-
-maxSize 300
-- logistics: V1DeliveryLogistics - Delivery logistics.
-- partial: boolean - If the delivery solution is a partial and doesn't apply to all items.
-- title: string - Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
-For example, "Standard" or "First-Class Package International".
-
-maxLength 250
-
-**ShippingPrice**
-Properties:
-- discount: Price - Shipping discount before tax.
-- price: Price - Shipping price for display purposes.
-- taxDetails: ItemTaxFullDetails - Tax details.
-- totalPriceAfterTax: Price - Shipping price after all discounts (if any exist), and after tax.
-- totalPriceBeforeTax: Price - Total price of shipping after discounts (when relevant), and before tax.
-
-**ShippingRegion**
-Properties:
-- name: string - Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
-
-maxLength 100
-
-**StreetAddress**
-Properties:
-- name: string - Street name.
-- number: string - Street number.
-
-**SubscriptionFrequency**
-Enum values:
-- DAY
-- MONTH
-- UNDEFINED
-- WEEK
-- YEAR
-
-**SubscriptionInfo**
-Properties:
-- _id: string - Subscription ID.
-
-format GUID
-- chargesDescription: string - Description of the charges that will be applied for subscription.
-
-maxLength 1000
-- cycleNumber: number - Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
-- subscriptionOptionDescription: string (deprecated) - Subscription option description. For example, `"1kg of selected coffee, once a month"`.
-
-maxLength 500
-- subscriptionOptionTitle: string (deprecated) - Subscription option title. For example, `"Monthly coffee Subscription"`.
-
-maxLength 150
-- subscriptionSettings: SubscriptionSettings - Subscription detailed information.
-
-immutable
-
-**SubscriptionOptionInfo**
-Properties:
-- description: Description - Subscription option description.
-- subscriptionSettings: V1SubscriptionSettings - Subscription option settings.
-- title: Title - Subscription option title.
-
-**SubscriptionSettings**
-Properties:
-- autoRenewal: boolean - Whether subscription is renewed automatically at the end of each period.
-- billingCycles: number - Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
-
-min 1
-- enableCustomerCancellation: boolean - Whether to allow the customer to cancel the subscription.
-- freeTrialPeriod: FreeTrialPeriod - Period until first cycle starts. If None => no free trial
-- frequency: SubscriptionFrequency - Frequency of recurring payment.
-- interval: number - Interval of recurring payment.
-
-min 1, max 3650
-
-**SystemError**
-Properties:
-- errorCode: string - Error code.
-
-**TagList**
-Properties:
-- tagIds: string[] - List of tag IDs
-
-maxSize 100, maxLength 5
-
-**Tags**
-Properties:
-- privateTags: TagList - Tags that require an additional permission in order to access them, normally not given to site members or visitors.
-- tags: TagList - Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
-
-**Target**
-One of (targetType):
-- lineItem: TargetLineItem - Specific line item violation.
-- other: Other - General (other) violation.
-
-**TargetLineItem**
-Properties:
-- _id: string - ID of the line item containing the violation.
-- name: string - Location on a checkout or a cart page where the specific line item violation will be displayed.
-
-**TaxableAddress**
-One of (taxableAddressData):
-- addressType: TaxableAddressType - taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
-
-**TaxableAddressType**
-Enum values:
-- BILLING
-- BUSINESS
-- SHIPPING
-- UNKNOWN_TAXABLE_ADDRESS
-
-**TaxCalculationDetails**
-Properties:
-- rateType: RateType - Rate calculation type.
-One of (calculationDetails):
-- autoTaxFallbackDetails: AutoTaxFallbackCalculationDetails - Details of the fallback rate calculation.
-- manualRateReason: ManualCalculationReason - Reason the manual calculation was used.
-
-**TaxRateBreakdown**
-Properties:
-- name: string - Name of tax against which the calculation was performed.
-
-maxLength 100
-- rate: string - Rate at which this tax detail was calculated.
-
-decimalValue { gte:0, lte:1, maxScale:6 }
-- tax: MultiCurrencyPrice - Amount of tax for this tax detail.
-
-**TaxSummary**
-Properties:
-- totalTax: Price - Total tax.
-
-**Title**
-Properties:
-- original: string - Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-minLength 1, maxLength 150
-- translated: string - Subscription option name translated into the buyer's language.
-
-Default: Same as `original`.
-
-minLength 1, maxLength 150
-
-**TotalPriceChange**
-Properties:
-- newTotal: Price - Order’s total price after discounts and tax. After update
-- originalTotal: Price - Order’s total price after discounts and tax. Before update
-
-**TranslatableString**
-Properties:
-- original: string - __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
-
-Min: 1 character.
-Max: 200 characters.
-
-minLength 1, maxLength 200
-- translated: string - String translated into the buyer's language.
-
-Min: 1 character.
-Max: 400 characters.
-Default: Same as `original`.
-
-minLength 1, maxLength 400
-
-**TranslatedValue**
-Properties:
-- original: string - Value in site default language.
-
-minLength 1
-- translated: string - Translated value.
-
-minLength 1
-
-**V1AdditionalFee**
-Properties:
-- code: string - Additional fee's unique code (or ID) for future processing.
-
-minLength 1, maxLength 100
-- lineItemIds: string[] - Optional - Line items associated with this additional fee.
-If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
-
-format GUID
-- name: string - Translated additional fee's name.
-
-minLength 1, maxLength 50
-- price: MultiCurrencyPrice - Additional fee's price.
-- priceAfterTax: MultiCurrencyPrice - Additional fee's price after tax.
-- priceBeforeTax: MultiCurrencyPrice - Additional fee's price before tax.
-- providerAppId: string - Provider's app id.
-
-minLength 1, maxLength 100
-- source: AdditionalFeeSource - the source the additional fee was added from
-- taxDetails: V1ItemTaxFullDetails - Tax details.
-- translatedName: string - 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).
-
-minLength 1, maxLength 50
-
-**V1AppliedDiscount**
-Properties:
-- discountType: AppliedDiscountDiscountType - Discount type.
-- lineItemIds: string[] (deprecated) - IDs of line items the discount applies to.
-
-format GUID
-One of (discountSource):
-- coupon: V1Coupon - Coupon details.
-- discountRule: V1DiscountRule - Discount rule
-- merchantDiscount: V1MerchantDiscount - Merchant discount.
-
-**V1BuyerInfo**
-Properties:
-- contactId: string - Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
-
-format GUID
-- email: string - Buyer email address.
-
-format EMAIL
-One of (id):
-- memberId: string - Member ID (if site visitor is a site member).
-- visitorId: string - Visitor ID (if site visitor is not a member).
-
-**V1Coupon**
-Properties:
-- _id: string - Coupon ID.
-- amount: MultiCurrencyPrice - Coupon value.
-- code: string - Coupon code.
-- name: string - Coupon name.
-
-**V1CreatedBy**
-One of (string):
-- appId: string - App ID - when the order was created by an external application.
-- memberId: string - Member ID - when the order was created by a **logged in** site visitor.
-- userId: string - User ID - when the order was created by a Wix user on behalf of a buyer.
-For example, via POS (point of service).
-- visitorId: string - Visitor ID - when the order was created by a site visitor that was **not** logged in.
-
-**V1DeliveryLogistics**
-Properties:
-- deliveryTime: string - Expected delivery time, in free text. For example, "3-5 business days".
-
-maxLength 500
-- instructions: string - Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
-
-maxLength 1000
-- pickupDetails: V1PickupDetails - Pickup details.
-
-**V1DiscountRule**
-Properties:
-- _id: string - Discount rule ID
-
-format GUID
-- amount: MultiCurrencyPrice - Discount value.
-- name: V1DiscountRuleName - Discount rule name
-
-**V1DiscountRuleName**
-Properties:
-- original: string - Original discount rule name (in site's default language).
-
-minLength 1, maxLength 256
-- translated: string - Translated discount rule name according to buyer language. Defaults to `original` when not provided.
-
-minLength 1, maxLength 500
-
-**V1FreeTrialPeriod**
-Properties:
-- frequency: SubscriptionFrequency - Frequency of period. Values: DAY, WEEK, MONTH, YEAR
-- interval: number - interval of period
-
-min 1, max 999
-
-**V1ItemModifier**
-Properties:
-- _id: string - Modifier ID.
-
-minLength 1, maxLength 36
-- details: TranslatableString - Additional details.
-- label: TranslatableString - Primary display label for the modifier.
-- price: Price - The price of the modifier.
-- quantity: number - The quantity of this modifier.
-
-min 1, max 100000
-
-**V1ItemTaxFullDetails**
-Properties:
-- rateBreakdown: TaxRateBreakdown[] (deprecated) - If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
-- taxableAmount: MultiCurrencyPrice - Amount for which tax is calculated.
-- taxRate: string - Tax rate %, as a decimal point between 0 and 1.
-
-decimalValue { gte:0, lte:1, maxScale:6 }
-- totalTax: MultiCurrencyPrice - Calculated tax, based on `taxable_amount` and `tax_rate`.
-
-**V1MerchantDiscount**
-Properties:
-- amount: MultiCurrencyPrice - Discount value.
-- percentage: number - Discount Percentage. Will be calculated from items price before other discounts.
-
-min 1, max 100
-
-**V1ModifierGroup**
-Properties:
-- _id: string - Modifier group ID.
-
-minLength 1, maxLength 36
-- modifiers: V1ItemModifier[] - List of modifiers in this group.
-
-minSize 1, maxSize 10
-- name: TranslatableString - Modifier group name.
-
-**V1PaymentOption**
-Enum values:
-- MANUAL
-- UNKNOWN_PAYMENT_OPTION
-
-**V1PickupDetails**
-Properties:
-- address: Address - Pickup address.
-- businessLocation: boolean (deprecated) - Whether the pickup address is that of a business - this may effect tax calculation.
-- pickupMethod: PickupDetailsPickupMethod - Pickup method
-
-**V1PriceSummary**
-Properties:
-- additionalFees: MultiCurrencyPrice - Total additional fees price before tax.
-- discount: MultiCurrencyPrice - Total calculated discount value.
-- shipping: MultiCurrencyPrice - Total shipping price, before discounts and before tax.
-- subtotal: MultiCurrencyPrice - Subtotal of all line items, before discounts and before tax.
-- tax: MultiCurrencyPrice - Total tax.
-- total: MultiCurrencyPrice - Total price after discounts, gift cards, and tax.
-
-**V1ShippingInformation**
-Properties:
-- carrierId: string - App Def Id of external provider which was a source of shipping info
-
-minLength 1, maxLength 100
-- code: string - Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
-
-minLength 1, maxLength 100
-- cost: ShippingPrice - Shipping costs.
-- logistics: DeliveryLogistics - Shipping logistics.
-- region: ShippingRegion - Shipping region.
-- title: string - Shipping option title.
-For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
-
-maxLength 250
-
-**V1ShippingPrice**
-Properties:
-- otherCharges: OtherCharge[] - Other costs such as insurance, handling & packaging for fragile items, etc.
-- price: MultiCurrencyPrice - Shipping price.
-
-**V1ShippingRegion**
-Properties:
-- _id: string - Shipping region ID.
-
-format GUID
-- name: string - Shipping region name.
-
-maxLength 100
-
-**V1SubscriptionSettings**
-Properties:
-- autoRenewal: boolean - Whether subscription is renewed automatically at the end of each period.
-- billingCycles: number - Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
-
-min 1
-- enableCustomerCancellation: boolean - Whether to allow the customer to cancel the subscription..
-- freeTrialPeriod: V1FreeTrialPeriod - Period until first cycle starts. If applied payNow will be 0
-If None => no free trial
-- frequency: SubscriptionFrequency - Frequency of recurring payment.
-- interval: number - Interval of recurring payment.
-
-Default: `1`.
-If SubscriptionFrequency is Day the minimum interval is 7
-
-min 1, max 3650
-
-**V1TaxSummary**
-Properties:
-- calculationDetails: TaxCalculationDetails (deprecated) - Tax calculator that was active when the order was created.
-- taxableAmount: MultiCurrencyPrice - Amount for which tax is calculated, added from line items.
-- totalTax: MultiCurrencyPrice - Calculated tax, added from line items.
-
-**ValidationError**
-Properties:
-- fieldViolations: FieldViolation[]
-
-**VatId**
-Properties:
-- _id: string - Customer's tax ID.
-- type: VatType - Tax type.
-
-Supported values:
-+ `CPF`: for individual tax payers
-+ `CNPJ`: for corporations
-
-**VatType**
-Enum values:
-- CNPJ: CNPJ - for corporations
-- CPF: CPF - for individual tax payers.
-- UNSPECIFIED
-
-**Violation**
-Properties:
-- description: string - Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
-
-minLength 1, maxLength 1000
-- severity: Severity - Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow.
-- target: Target - Target location on a checkout or cart page where the violation will be displayed.
-
-**WeightUnit**
-Enum values:
-- KG: Kilograms.
-- LB: Pounds.
-- UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
-
-**WixReceipt**
-Properties:
-- displayNumber: string - Display number of receipt
-
-minLength 1, maxLength 40
-- receiptId: string - Receipt ID
-
-format GUID
-</types>
-</payment_settings_service_plugin>