About the eCommerce Checkout Templates API

The Checkout Templates API allows you to create and manage pre-populated checkouts to share with customers. When customers then create checkouts from these templates, the new checkouts already include information such as predefined line items, coupons, or other customizations.

With the Checkout Templates API, you can:

  • Run a sale on a specific product for a limited time
  • Customize the checkout experience

Before you Begin

It’s important to note that the checkout template functionality is not currently available in the Wix Dashboard. If a site creates checkout templates with an app, they must also be able to manage and update their checkout templates through an app. For example, a website offering a sale through a checkout template must be able to change the template’s status to INACTIVE or they will not be able to turn off the sale when they want it to end.

Use Cases

Did this help?

Checkout Templates: Sample Use Case & Flow

This article shares some possible use cases your app could support, as well as an sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.

Run a flash sale through social media

Offer a sale to customers through social media channels that runs for a limited time only. Create the checkout template and pull the URL to automatically redirect anyone that clicks on the link to a checkout page with the offer. When the period for the sale is complete, update the checkout template's status to INACTIVE to turn it off.

To create and share the offer:

  1. Use Create Checkout Template with the product and coupon information for offer.
  2. Use the checkoutTemplateId to build the URL to share with customers. Build the URL in this format: https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}.
  3. Post and share the URL to customers.

To turn off the offer at the end of the sale:

  1. Use Update Checkout Template to update checkoutTemplate.status to INACTIVE.

Limit the number of checkouts for a specific coupon

Offer a sale to the first 100 customers that click on an offer. Create a checkout template, then share your own custom link that will run custom logic before creating a new checkout for the customer.

Create a checkout template and add your own custom logic:

  1. Use Create Checkout Template with the product and coupon information for offer.
  2. Create a bank of all new checkouts for this sale by collecting the checkoutIds of checkouts created from this checkoutTemplateId.
  3. Before a new checkout is created with the checkoutTemplateId, check the bank and count the number of checkoutIds being stored.
  4. Once the count hits 100 checkouts, use Update Checkout Template to update checkoutTemplate.status to INACTIVE.
Did this help?

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.

CheckoutTemplate
JSON
{ "checkoutTemplate": { "id": "825315ef-1b62-40f7-ab62-97b751ebf285", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true }, "lockedGiftCard": false, "lockedCoupon": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }
Did this help?

POST

Create Checkout Template


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a checkout template.

A checkout template is used to create a new checkout that will include predefined information. For example, a single link with a checkoutTemplateId can be shared with customers and each time the link is clicked, a new checkout page will be created for that customer with certain checkout information already populated.

The customizable features include the option to allow or to lock coupon codes or gift cards. For example, if a store owner is using the checkout template to offer a flash sale to their social media followers, they may want to lock the option to apply an additional coupon on top of the sale being offered. If so, they can set customization.lockedCoupon to true.

A checkout can be created with a checkout template by calling Create Checkout From Template. The site may add further customizations to the new checkout and then redirect the customer using the new checkout's checkoutUrl.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkout-templates

Body Params
checkoutTemplateCheckoutTemplateRequired

Checkout template to create.

Response Object
checkoutTemplateCheckoutTemplate

Created checkout template.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/checkout-templates' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "checkoutTemplate": { "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "status": "ACTIVE", "customization": { "lockedGiftCard": false, "webClient": { "disabledContinueShoppingButton": true }, "lockedCoupon": true }, "couponCode": "SUMMER_FLASH_SALE" } }'
Response
JSON
{ "checkoutTemplate": { "id": "825315ef-1b62-40f7-ab62-97b751ebf285", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true }, "lockedGiftCard": false, "lockedCoupon": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }
Errors
400Invalid Argument

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

GET

Get Checkout Template


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a checkout template.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}

Path Params
checkoutTemplateIdstringRequired

ID of the checkout template to retrieve.

Response Object
checkoutTemplateCheckoutTemplate

Retrieved checkout template.

Get Checkout Template
Request
cURL
curl -X GET \ 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \
Response
JSON
{ "checkoutTemplate": { "id": "d447475f-34ed-4be5-b199-b120c6938c39", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true, "disabledPolicyAgreementCheckbox": false }, "lockedGiftCard": false, "lockedCoupon": true, "disabledManualPayment": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "customLineItems": [ { "quantity": 1, "price": "5", "descriptionLines": [], "productName": { "original": "My Custom Item" }, "itemType": { "preset": "PHYSICAL" }, "couponScopes": [], "paymentOption": "FULL_PAYMENT_ONLINE" } ], "couponCode": "SUMMER_FLASH_SALE" } }
Did this help?

DELETE

Delete Checkout Template


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a checkout template.

If a checkout template is deleted and a customer attempts to create a checkout with that checkoutTemplateId then the customer will be redirected to the domain site.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}

Path Params
checkoutTemplateIdstringRequired

ID of the checkout template to delete.

Response Object
Returns an empty object.
Delete Checkout Template
Request
cURL
curl -X DELETE \ 'https://www.wixapis.com/ecom/v1/checkout-templates/825315ef-1b62-40f7-ab62-97b751ebf285' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json'
Response
JSON
{
Event TriggersThis method triggers the following events:
Did this help?

PATCH

Update Checkout Template


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a checkout template.

If the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously created from this template before the update will not be affected.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplate.id}

Path Params
checkoutTemplate.idstringRequired

Checkout template ID.

Body Params
checkoutTemplateCheckoutTemplateRequired

Checkout template info to update.

Response Object
checkoutTemplateCheckoutTemplate

Updated checkout template.

Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/ecom/v1/checkout-templates/825315ef-1b62-40f7-ab62-97b751ebf285' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "checkoutTemplate": { "id": "825315ef-1b62-40f7-ab62-97b751ebf285", "status": "INACTIVE", "lineItems": [ { "quantity": 4, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Small" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ] } }'
Response
JSON
{ "checkoutTemplate": { "id": "825315ef-1b62-40f7-ab62-97b751ebf285", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true }, "lockedGiftCard": false, "lockedCoupon": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }
Errors
400Invalid Argument

There are 4 errors with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

POST

Query Checkout Templates


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of checkout templates, given the provided paging, filtering, and sorting.

Query Checkout Templates runs with these defaults, which you can override:

  • id sorted in ASC order

The following table shows field support for filters and sorting for the checkout template object:

FieldSupported FiltersSortable
id$eq, $ne, $in, $startsWith, $exists, $hasSomeSortable
status$eq, $ne, $in, $exists, $hasSomeSortable

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkout-templates/query

Body Params
queryQuery

Query options.

Response Object
checkoutTemplatesArray <CheckoutTemplate>

Retrieved checkout templates.


pagingMetadataPagingMetadata

Paging metadata.

Query Checkout Templates using Cursor Paging
Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/checkout-templates/query' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "query": { "sort": [], "filter": { "status": "ACTIVE" }, "cursorPaging": { "limit": 3 } } }'
Response
JSON
{ "checkoutTemplates": [ { "checkoutTemplate": { "id": "d447475f-34ed-4be5-b199-b120c6938c39", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true, "disabledPolicyAgreementCheckbox": false }, "lockedGiftCard": false, "lockedCoupon": true, "disabledManualPayment": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }, { "id": "056e6325-fadb-4df3-b447-333639689e0a", "status": "ACTIVE", "customization": null, "lineItems": [ { "quantity": 1, "name": "Shirt & Hat Bundle", "price": "10", "priceDescription": null, "descriptionLines": [], "media": { "id": "1", "url": "https://images.squarespace-cdn.com/content/v1/626c8a4c9f0cac0699248dcf/1666767197763-D3TOWRQHU36NKG3PVVM6/Tee-%2B-Hat.png", "height": 0, "width": 0, "altText": null, "urlExpirationDate": null, "filename": null, "sizeInBytes": null }, "paymentOption": "FULL_PAYMENT_ONLINE", "id": null } ], "couponCode": "SUMMER_FLASH_SALE" }, { "id": "090c1a79-b066-4588-8943-c940ad9dd531", "status": "ACTIVE", "customization": null, "lineItems": [ { "quantity": 10, "name": "SHIRT", "price": "100", "priceDescription": null, "descriptionLines": [], "media": null, "paymentOption": "FULL_PAYMENT_ONLINE", "id": null } ], "couponCode": "SUMMER_FLASH_SALE" } ], "pagingMetadata": { "count": 3, "cursors": { "next": "25012ca406ecac3b31c45af1085bba46ac9580c3.EhYqFAoSCgZzdGF0dXMSCBoGQUNUSVZFIiQwOTBjMWE3OS1iMDY2LTQ1ODgtODk0My1jOTQwYWQ5ZGQ1MzE", "prev": null }, "hasNext": true } }
Did this help?

POST

Create Checkout From Template


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new checkout based on the checkout template.

Before using this endpoint, you must have a checkout template available. Create a checkout template with Create Checkout Template.

The customer can be directed to the new checkout using the checkout's checkoutUrl.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-checkout-from-template

Path Params
checkoutTemplateIdstringRequired

ID of the checkout template to use to create a checkout from.

Body Params
siteIdstringRequiredformat GUID

ID of the site associated with the checkout template.

Response Object
checkoutIdstringformat GUID

ID of the created checkout.


checkoutUrlstring

URL of the created checkout page.


purchaseFlowIdstringformat GUID

Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

Create Checkout From Template
Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39/create-checkout-from-template' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "siteId": "811d8a67-3bd7-46a5-8cd9-843bb77b2a7d" }'
Response
JSON
{ "checkoutId": "2c6ece26-baeb-4d9f-a7e5-695d295110da", "checkoutUrl": "https://example.wixsite.com/example-store/checkout?appSectionParams=%7B%0A%22checkoutId%22%3A%222c6ece26-baeb-4d9f-a7e5-695d295110da%22%2C%0A%22storeUrl%22%3A%22https%3A%2F%2Fexample.wixsite.com%2Fexample-store%22%2C%0A%22a11y%22%3Afalse%2C%0A%22isFastFlow%22%3Afalse%2C%0A%22isPickupFlow%22%3Afalse%2C%0A%22currentCurrency%22%3A%22USD%22%2C%0A%22linkSource%22%3A%22acMail%22%0A%7D&linkSource=acMail&checkoutOOI=true&disableContinueShopping=true" }
Errors
428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

GET

Create And Redirect To Checkout


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new checkout based on the checkout template and redirects to the new checkout page.

Before using this endpoint, you must have a checkout template available. Create a checkout template with Create Checkout Template.

To build a URL that uses this endpoint, follow this format: https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}

To create a checkout but not automatically redirect to the checkout page, use Create Checkout From Template.

Endpoint
GET
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout

Path Params
checkoutTemplateIdstringRequired

ID of the checkout template to use to create a checkout.

Query Params
siteIdstringRequired

ID of the site associated with the checkout template.

Response Object
bodybytes

statusCodeintegerformat uint32

headersArray <HeadersEntry>
Create And Redirect To Checkout From Template
Request
cURL
curl -X GET \ 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39/create-and-redirect-to-checkout' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "siteId": "811d8a67-3bd7-46a5-8cd9-843bb77b2a7d" }'
Response
JSON
{ "body": "", "statusCode": 302, "headers": [ { "key": "Location", "value": "https://example.wixsite.com/example-store/checkout?appSectionParams=%7B%0A%22checkoutId%22%3A%22af8ed7c2-b638-4def-973d-2c9c09f9f8d0%22%2C%0A%22storeUrl%22%3A%22https%3A%2F%2Fexample.wixsite.com%2Fexample-store%22%2C%0A%22a11y%22%3Afalse%2C%0A%22isFastFlow%22%3Afalse%2C%0A%22isPickupFlow%22%3Afalse%2C%0A%22currentCurrency%22%3A%22USD%22%2C%0A%22linkSource%22%3A%22acMail%22%0A%7D&linkSource=acMail&checkoutOOI=true&disableContinueShopping=true" } ] }
Errors
428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

Checkout Template Created


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a checkout template is created.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_template.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.ecom.v1.checkout_template_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

CheckoutTemplateCreated
JSON
{ "id": "79e70c2a-f3fe-4a3b-a62f-1089857bab84", "entityFqdn": "wix.ecom.v1.checkout_template", "slug": "created", "entityId": "5bf5cb44-13fa-4933-9655-1d8423636a74", "createdEvent": { "entity": { "id": "5bf5cb44-13fa-4933-9655-1d8423636a74", "status": "ACTIVE", "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }, "eventTime": "2023-09-11T14:58:22.481838Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" }
Did this help?

Checkout Template Updated


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a checkout template is updated.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_template.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.ecom.v1.checkout_template_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

CheckoutTemplateUpdated
JSON
{ "id": "295e8d31-92e3-4868-9b2f-c6da5cb0abff", "entityFqdn": "wix.ecom.v1.checkout_template", "slug": "updated", "entityId": "825315ef-1b62-40f7-ab62-97b751ebf285", "updatedEvent": { "currentEntity": { "id": "825315ef-1b62-40f7-ab62-97b751ebf285", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": true }, "lockedGiftCard": false, "lockedCoupon": true }, "lineItems": [ { "quantity": 4, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Small" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "couponCode": "SUMMER_FLASH_SALE" } }, "eventTime": "2023-09-11T09:32:02.365080Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "3" }
Did this help?

Checkout Template Deleted


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a checkout template is deleted.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_template.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.ecom.v1.checkout_template_deleted", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

CheckoutTemplateDeleted
JSON
{ "id": "5c55d2dd-8919-438d-b9c0-19ec2b3f913f", "entityFqdn": "wix.ecom.v1.checkout_template", "slug": "deleted", "entityId": "825315ef-1b62-40f7-ab62-97b751ebf285", "deletedEvent": { "movedToTrash": true }, "eventTime": "2023-09-11T09:40:28.303263Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "7" }
Did this help?

Checkout Template Used


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a checkout is created from a checkout template.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_template.


slugstring

Event name. Expected used.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.ecom.v1.checkout_template_used", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

CheckoutTemplateUsed
JSON
{ "id": "148a3b54-bb9a-450b-996c-5101d8889fb4", "entityFqdn": "wix.ecom.v1.checkout_template", "slug": "used", "entityId": "b3210445-9252-4094-8df2-48adec157322", "actionEvent": { "body": { "checkoutTemplate": { "id": "44efbcf4-481d-454c-b3d0-57b7a1cae99c", "status": "ACTIVE", "customization": { "webClient": { "disabledContinueShoppingButton": false }, "lockedGiftCard": true, "lockedCoupon": true }, "lineItems": [ { "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } } } ], "customLineItems": [], "couponCode": "SUMMERSALE20" }, "checkout": { "id": "b3210445-9252-4094-8df2-48adec157322", "lineItems": [ { "id": "00000000-0000-0000-0000-000000000001", "quantity": 2, "catalogReference": { "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e", "options": { "options": { "Size": "Medium" }, "variantId": "00000000-0000-0000-0000-000000000000" } }, "productName": { "original": "Hat 1", "translated": "Hat 1" }, "url": { "relativePath": "/product-page/hat-1", "url": "https://example.wixsite.com/example-store/product-page/hat-1" }, "price": { "amount": "25", "convertedAmount": "25", "formattedAmount": "$25.00", "formattedConvertedAmount": "$25.00" }, "lineItemPrice": { "amount": "50", "convertedAmount": "50", "formattedAmount": "$50.00", "formattedConvertedAmount": "$50.00" }, "fullPrice": { "amount": "25", "convertedAmount": "25", "formattedAmount": "$25.00", "formattedConvertedAmount": "$25.00" }, "priceBeforeDiscounts": { "amount": "25", "convertedAmount": "25", "formattedAmount": "$25.00", "formattedConvertedAmount": "$25.00" }, "totalPriceAfterTax": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "totalPriceBeforeTax": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "taxDetails": { "taxableAmount": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "taxRate": "0", "totalTax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "rateBreakdown": [] }, "discount": { "amount": "5", "convertedAmount": "5", "formattedAmount": "$5.00", "formattedConvertedAmount": "$5.00" }, "descriptionLines": [ { "name": { "original": "Size", "translated": "Size" }, "plainText": { "original": "Medium", "translated": "Medium" } } ], "media": { "id": "baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg", "url": "https://static.wixstatic.com/media/baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg", "height": 1500, "width": 2000, "filename": "baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg" }, "availability": { "status": "AVAILABLE" }, "physicalProperties": { "sku": "0002", "shippable": true }, "couponScopes": [ { "namespace": "stores", "group": { "name": "collection", "entityId": "d704acf4-11af-f65e-b9a5-fc49ab782122" } }, { "namespace": "stores", "group": { "name": "collection", "entityId": "00000000-000000-000000-000000000001" } }, { "namespace": "stores", "group": { "name": "product", "entityId": "8df1afe4-90d1-162d-2d42-b8308125c193" } } ], "itemType": { "preset": "PHYSICAL" }, "paymentOption": "FULL_PAYMENT_ONLINE", "rootCatalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193", "customLineItem": false } ], "shippingInfo": { "carrierServiceOptions": [] }, "buyerInfo": { "openAccess": true }, "conversionCurrency": "USD", "priceSummary": { "subtotal": { "amount": "50", "convertedAmount": "50", "formattedAmount": "$50.00", "formattedConvertedAmount": "$50.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "5", "convertedAmount": "5", "formattedAmount": "$5.00", "formattedConvertedAmount": "$5.00" }, "total": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "calculationErrors": { "orderValidationErrors": [] }, "appliedDiscounts": [ { "discountType": "SPECIFIC_ITEMS", "lineItemIds": ["00000000-0000-0000-0000-000000000001"], "coupon": { "id": "14d074d8-15f3-4d71-bfa9-dc5b4ac47e61", "code": "SUMMERSALE20", "amount": { "amount": "5", "convertedAmount": "5", "formattedAmount": "$5.00", "formattedConvertedAmount": "$5.00" }, "name": "summer sale", "couponType": "MoneyOff" }, "lineItemDiscounts": [] } ], "customFields": [], "weightUnit": "LB", "taxSummary": { "taxableAmount": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "totalTax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "manualTaxRate": "0", "aggregatedTaxBreakdown": [] }, "currency": "USD", "channelType": "WEB", "siteLanguage": "en", "buyerLanguage": "en", "completed": false, "taxIncludedInPrice": false, "createdBy": { "appId": "1380b703-ce81-ff05-f115-39571d94dfcd" }, "createdDate": "2024-01-07T14:42:19.240Z", "updatedDate": "2024-01-07T14:42:19.240Z", "payNow": { "subtotal": { "amount": "50", "convertedAmount": "50", "formattedAmount": "$50.00", "formattedConvertedAmount": "$50.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "5", "convertedAmount": "5", "formattedAmount": "$5.00", "formattedConvertedAmount": "$5.00" }, "total": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "payLater": { "subtotal": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "shipping": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "tax": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "discount": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "total": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" }, "additionalFees": { "amount": "0", "convertedAmount": "0", "formattedAmount": "$0.00", "formattedConvertedAmount": "$0.00" } }, "additionalFees": [], "payNowTotalAfterGiftCard": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "ecomId": "95b38c92-a577-4609-b950-3473cbb32134", "violations": [], "totalAfterGiftCard": { "amount": "45", "convertedAmount": "45", "formattedAmount": "$45.00", "formattedConvertedAmount": "$45.00" }, "purchaseFlowId": "4595d2bd-6e73-4f12-a876-ac7b3bce901f", "customSettings": { "lockGiftCard": true, "lockCouponCode": true } } } }, "eventTime": "2024-01-07T14:42:19.340889012Z", "triggeredByAnonymizeRequest": false }
Did this help?