> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Resource: Checkout Templates # Type: Checkout Template Object # Link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/checkout-templates/checkout-template-object.md ## Description: A reusable template for creating checkouts with predefined line items, coupons, and customization settings. ## Schema: ```json Type: Checkout Template Object | type: CheckoutTemplate Description: A reusable template for creating checkouts with predefined line items, coupons, and customization settings. - name: id | type: string | description: Checkout template ID. - name: value | type: string | description: - name: status | type: string | description: Status of the checkout template. When `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site. Default: `ACTIVE` enum: ACTIVE, INACTIVE - name: customization | type: CheckoutCustomization | description: Custom settings to apply to the checkout page created from this template. - name: webClient | type: WebClientCustomization | description: Web client customizations. These customizations only apply to the standard Wix checkout page. - name: disabledContinueShoppingButton | type: boolean | description: Whether to disable the "Continue shopping" button. Default: `false` - name: disabledPolicyAgreementCheckbox | type: boolean | description: Whether to disable policy agreement checkout in the checkout page Default: `false` - name: lockedGiftCard | type: boolean | description: Whether to lock the ability to add or remove a gift card. Default: `false` - name: lockedCoupon | type: boolean | description: Whether to lock the ability to apply or remove a coupon code. Default: `false` - name: disabledManualPayment | type: boolean | description: Whether to disable manual payment option for this checkout. Default: `false` - name: lineItems | type: Array | description: Catalog line items. Max: 300 items - name: quantity | type: number | description: Item quantity. Min: `1`
Max: `100000` - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Holds 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. - name: catalogItemId | type: string | description: ID of the item within the catalog it belongs to. - name: appId | type: string | description: 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"` - name: options | type: Struct | description: Additional item details in `key:value` pairs. Use this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items. For Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration.md) or [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration.md), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction.md). - name: catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. - name: productName | type: ProductName | description: Item name. - name: price | type: string | description: Item price **after** discounts. - name: fullPrice | type: string | description: Item price **before** discounts. - name: descriptionLines | type: Array | description: Item description lines. Used when displaying the line item to customers. - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item. - name: image | type: Image | description: Item image. - name: paymentOption | type: PaymentOption | description: Payment method selected for the item. - name: depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false` - name: inventoryAppId | type: string | description: ID of the app managing the inventory. - name: customLineItems | type: Array | description: Custom line items. Custom line items don't trigger the Catalog service plugin. Max: 300 items - name: quantity | type: number | description: Custom line item quantity. Min: `1` Max: `100000` - name: price | type: string | description: Custom line item price. Must be a number or a decimal without symbols. - name: priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". - name: original | type: string | description: __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.md#request-envelope). - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`. - name: descriptionLines | type: Array | description: Custom line item description lines. Used for display purposes for the cart, checkout and order. - name: name | type: DescriptionLineName | description: Description line name. - name: media | type: Image | description: Custom line item's media. - name: id | type: string | description: WixMedia image ID. - name: height | type: number | description: Original image height. - name: width | type: number | description: Original image width. - name: altText | type: string | description: Image alt text. Optional. - name: filename | type: string | description: Image filename. Optional. - name: id | type: string | description: Deprecated. Custom line item ID. To maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead. Learn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items.md#custom-item-with-catalog-reference). - name: taxGroupId | type: string | description: Tax group ID for this custom line item. - name: productName | type: ProductName | description: Name of the item or product. - name: original | type: string | description: __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.md#request-envelope). Min: 1 character. Max: 200 characters. - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`. - name: url | type: PageUrlV2 | description: URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. - name: relativePath | type: string | description: The relative path for the page within the site. For example, `/product-page/a-product`. - name: url | type: string | description: The page's full URL. For example, `https://mysite.com/product-page/a-product`. - name: itemType | type: ItemType | description: Item type. Either a preset type or custom. - name: fullPrice | type: string | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided. - name: quantityAvailable | type: number | description: Item quantity available for purchase. Only return this if inventory is managed. Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart. - name: value | type: number | description: - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item. - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). - name: shippable | type: boolean | description: Whether this line item is shippable. - name: paymentOption | type: string | description: Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`. + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout. + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0. + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field. enum: FULL_PAYMENT_ONLINE, FULL_PAYMENT_OFFLINE, MEMBERSHIP, DEPOSIT_ONLINE, MEMBERSHIP_OFFLINE, MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER - name: serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants. Used, among other things, when checking for valid memberships. - name: scheduledDate | type: string | description: 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. - name: numberOfParticipants | type: number | description: 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. - name: rootCatalogItemId | type: string | description: 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 is the same as `catalogReference.catalogItemId`. + Used in membership validation. - name: depositAmount | type: string | description: Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE`. When omitted, the item's price will not be split and is expected to be paid in a single installment. - name: deliveryProfileId | type: string | description: Delivery profile ID. - name: catalogReference | type: CatalogReference | description: 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. - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false` - name: fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed. Default: `false` - name: consentRequiredPaymentPolicy | type: string | description: Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page. - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false` - name: policies | type: Array | description: Policies to be displayed to the customer on the checkout page. - name: title | type: string | description: Policy title - should be translated - name: content | type: string | description: Policy content - should be translated - name: membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false` - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes. - name: modifierGroups | type: Array | description: Modifier groups that were added to the item. - name: id | type: string | description: Modifier group ID. - name: name | type: TranslatableString | description: Modifier group name. - name: modifiers | type: Array | description: List of modifiers in this group. - name: couponCode | type: string | description: Coupon code. Note that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`. For additional information, see the Coupons API. - name: customContentReference | type: CustomContentReference | description: 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.md). - name: appId | type: string | description: 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/). - name: componentId | type: string | description: 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/). - name: externalReference | type: ExternalReference | description: References to an external app and resource associated with the checkout. Used for integration and tracking across different platforms. - name: appId | type: string | description: ID of the app associated with the purchase flow. For example, the Wix Pay Links app ID. - name: resourceId | type: string | description: 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. ```