@wix/ditto-codegen-public 1.0.6 → 1.0.8

package/dist/docs-output/service-plugins/ecom-additional-fees-doc.txt

@@ -0,0 +1,411 @@
+
+<additional_fees_service_plugin>
+<purpose>Base URI where the endpoints are called.
+Wix eCommerce appends the endpoint path to the base URI.
+For example, to call the Calculate Additional Fees endpoint at `https://my-additional-fees.com/v1/calculateAdditionalFees`,
+the base URI you provide here is `https://my-additional-fees.com/`.</purpose>
+<use_cases>
+- Handle appliedDiscounts: Applied discounts.
+- Handle businessLocationId: The business location ID associated with the items.
+Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+- Handle buyerDetails: Information about the buyer, such as contact details.
+- Handle lineItems: Line items to calculate additional fees for.
+
+Max: 300 items
+- Handle purchaseFlowId: Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+- Handle shippingAddress: Shipping address.
+- Handle shippingInfo: Shipping information.
+- Handle subtotal: Subtotal. Calculated as `lineItems[i].price` multiplied by `lineItems[i].quantity`, summed across all line items.
+</use_cases>
+<required_handlers>
+- calculateAdditionalFees() - Handler to process: The business location ID associated with the items.
+Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+</required_handlers>
+<import>import { additionalFees } from '@wix/ecom/service-plugins'</import>
+<types>
+
+**AdditionalFee**
+Properties:
+- code: string - Additional fee's unique code or ID.
+
+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 - Additional fee's name.
+
+Max: 50 characters
+
+minLength 1, maxLength 50
+- price: string - Total additional fees. This `price` does not include any taxes that may apply to these additional fees. Must be stringified integer.
+
+decimalValue { gte:0, lte:1000000000000000 }
+- taxDetails: TaxDetails - Tax details.
+
+> **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
+- 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
+
+**AdditionalFeesSPIConfig**
+Properties:
+- deploymentUri: string - Base URI where the endpoints are called.
+Wix eCommerce appends the endpoint path to the base URI.
+For example, to call the Calculate Additional Fees endpoint at `https://my-additional-fees.com/v1/calculateAdditionalFees`,
+the base URI you provide here is `https://my-additional-fees.com/`.
+
+**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.
+
+**AppliedDiscount**
+Properties:
+- discountType: DiscountType - Discount type.
+- lineItemIds: string[] - IDs of line items the discount applies to.
+
+format GUID
+One of (discountSource):
+- coupon: Coupon - Coupon details.
+- discountRule: DiscountRule - Discount rule
+- merchantDiscount: MerchantDiscount - Merchant discount.
+
+**BuyerDetails**
+Properties:
+- contactDetails: FullAddressContactDetails - Contact details.
+
+**CalculateAdditionalFeesEnvelope**
+Properties:
+- metadata: Context
+- request: CalculateAdditionalFeesRequest
+
+**CalculateAdditionalFeesRequest**
+Properties:
+- appliedDiscounts: AppliedDiscount[] - Applied discounts.
+
+maxSize 320
+- businessLocationId: string - The business location ID associated with the items.
+Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+
+format GUID
+- buyerDetails: BuyerDetails - Information about the buyer, such as contact details.
+- lineItems: LineItem[] - Line items to calculate additional fees for.
+
+Max: 300 items
+
+maxSize 300
+- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+
+format GUID
+- shippingAddress: Address - Shipping address.
+- shippingInfo: ShippingInformation - Shipping information.
+- subtotal: string - Subtotal. Calculated as `lineItems[i].price` multiplied by `lineItems[i].quantity`, summed across all line items.
+
+decimalValue { gte:0, lte:1000000000000000, maxScale:3 }
+
+**CalculateAdditionalFeesResponse**
+Properties:
+- additionalFees: AdditionalFee[] - Additional fees calculated.
+
+maxSize 100
+- currency: string - Currency of additional fees calculated. In three-letter currency code
+[ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+
+The currency returned in the response object must match the wix site's currency or those fees will
+be filtered out and not returned. Extract the `currency` from 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-with-rest#request-envelope)
+to ensure the correct currency is used in your calculation.
+
+maxLength 3
+
+**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)).
+
+**ChargeType**
+Enum values:
+- HANDLING_FEE
+- INSURANCE
+
+**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: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+- code: string - Coupon code.
+- name: string - Coupon name.
+
+**DeliveryLogistics**
+Properties:
+- deliveryTime: string - Expected delivery time. For example, "3-5 business days".
+
+maxLength 500
+- instructions: string - Instructions for deliver. For example, "Please deliver during open hours and please don't park in disabled parking spot".
+
+maxLength 1000
+- pickupDetails: PickupDetails - Pickup details.
+
+**DiscountRule**
+Properties:
+- _id: string - Discount rule ID
+
+format GUID
+- amount: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+- 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: Global discount.
+- SHIPPING: Discount on shipping.
+- SPECIFIC_ITEMS: Discount on specific items.
+
+**FullAddressContactDetails**
+Properties:
+- company: string - Contact's company name.
+- email: string - Email associated with the address.
+
+format EMAIL
+- firstName: string - Contact's first name.
+- lastName: string - Contact's last name.
+- phone: string - Contact's phone number.
+
+format PHONE
+- vatId: VatId - Tax info. Currently usable only in Brazil.
+
+**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
+
+**ItemModifier**
+Properties:
+- _id: string - Modifier ID.
+
+minLength 1, maxLength 36
+- details: TranslatableString - Additional details.
+- label: TranslatableString - Primary display label for the modifier.
+- price: string - The price of the modifier.
+
+decimalValue { gte:0, lte:1000000000000000, maxScale:3 }
+- quantity: number - The quantity of this modifier.
+
+min 1, max 100000
+
+**LineItem**
+Properties:
+- _id: string - Line item ID.
+
+minLength 1, maxLength 100
+- 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.
+- depositAmount: string - Partial payment to be paid upfront during the checkout.
+Only eligible for catalog items with `lineItem.paymentOption` type of `DEPOSIT_ONLINE`.
+
+format DECIMAL_VALUE
+- modifierGroups: ModifierGroup[] - Modifier groups that were added to the item.
+
+maxSize 25
+- physicalProperties: PhysicalProperties - Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
+- price: string - Price for a single item, after discounts and modifiers.
+
+decimalValue { gte:0 }
+- productName: string - Item name.
+
+maxLength 100
+- quantity: number - Quantity of item.
+
+Min: `1`
+Max: `100000`
+
+max 100000
+
+**MerchantDiscount**
+Properties:
+- amount: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+
+**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.
+
+**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.
+
+**PickupDetails**
+Properties:
+- address: Address - Pickup address.
+- businessLocation: boolean (deprecated) - Whether the pickup address is a business. This may affect tax calculation.
+- pickupMethod: PickupMethod - Pickup method.
+
+**PickupMethod**
+Enum values:
+- PICKUP_POINT
+- STORE_PICKUP
+- UNKNOWN_METHOD
+
+**SelectedCarrierServiceOption**
+Properties:
+- code: string - Unique identifier of selected option. For example, `"usps_std_overnight"`.
+
+maxLength 100
+- cost: SelectedCarrierServiceOptionPrices - Shipping costs.
+- logistics: DeliveryLogistics - Delivery logistics.
+- otherCharges: SelectedCarrierServiceOptionOtherCharge[] - Other charges.
+
+maxSize 100
+- 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 - Cost.
+
+`cost` is `price` minus `totalDiscount`.
+- details: string - Details of the charge.
+
+Max: 200 characters
+
+maxLength 200
+- type: ChargeType - Type of charge.
+
+**SelectedCarrierServiceOptionPrices**
+Properties:
+- price: string - Price.
+
+decimalValue { gte:0, lte:1000000000000000 }
+- totalDiscount: string - Total shipping discount.
+
+decimalValue { gte:0, lte:1000000000000000 }
+
+**ShippingInformation**
+Properties:
+- selectedCarrierServiceOption: SelectedCarrierServiceOption - Selected carrier shipping option.
+
+**StreetAddress**
+Properties:
+- name: string - Street name.
+- number: string - Street number.
+
+**TaxDetails**
+Properties:
+- taxable: boolean - Whether additional fee is taxable.
+- taxGroupId: string - Reserved for internal use.
+
+format GUID
+
+**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
+
+**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
+</types>
+</additional_fees_service_plugin>