PATCH

Update Checkout Template


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.

This method may also return standard errors. Learn more about standard Wix errors.

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