Checkout Template Object


A checkout template can be shared with customers to create checkouts with predefined information already included.

Properties
idstringRead-onlyformat GUID

Checkout template ID.


statusstring

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


customizationCustomization

Custom settings to apply to the checkout page created from this template.


lineItemsArray <LineItem>maxItems 300

Catalog line items.

Max: 300 items


customLineItemsArray <CustomLineItem>betamaxItems 300

Custom line items. Custom line items don't trigger the Catalog service plugin.

Max: 300 items


couponCodestring

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.


customContentReferenceCustomContentReferencebeta

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.

Did this help?