GET

Get Checkout Template


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" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?