{"id":"dba9c409-03f6-43ba-9c2d-62ba1cd5d5cc","createdDate":"2024-06-10T10:05:01.130Z","updatedDate":"2024-06-10T10:05:01.130Z","resourceId":"189422e5-0053-44f4-9358-82cb20b97f90","api":{"schema":{"object":{"displayName":"Checkout Template Object","description":"A checkout template can be shared with customers to create checkouts with predefined information already included.","slug":"checkout-template-object","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","legacyExamples":[{"title":"CheckoutTemplate","content":"{\n \"checkoutTemplate\": {\n \"id\": \"825315ef-1b62-40f7-ab62-97b751ebf285\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Checkout Template","description":"Creates a checkout template.\n\nA checkout template is used to create a new checkout that will include predefined information. For example, a single link with\na `checkoutTemplateId` can be shared with customers and each time the link is clicked, a new checkout page will be created\nfor that customer with certain checkout information already populated.\n\nThe customizable features include the option to allow or to lock coupon codes or gift cards. For example, if a store owner is\nusing the checkout template to offer a flash sale to their social media followers, they may want to lock the option to apply an\nadditional coupon on top of the sale being offered. If so, they can set `customization.lockedCoupon` to `true`.\n\nA checkout can be created with a checkout template by calling [Create Checkout From Template](https://dev.wix.com/api/rest/wix-e-commerce/checkout-templates/create-checkout-from-template).\nThe site may add further customizations to the new checkout and then redirect the customer using the new checkout's `checkoutUrl`.","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.CreateCheckoutTemplate","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCheckoutTemplateRequest","description":"","properties":{"checkoutTemplate":{"description":"Checkout template to create.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["checkoutTemplate","checkoutTemplate.lineItems.catalogReference","checkoutTemplate.lineItems.catalogReference.appId","checkoutTemplate.lineItems.catalogReference.catalogItemId","checkoutTemplate.lineItems.quantity","checkoutTemplate.customLineItems.quantity","checkoutTemplate.customLineItems.productName","checkoutTemplate.customLineItems.itemType"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Checkout Template Created","description":"Triggered when a checkout template is created.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_CREATE_CHECKOUT_TEMPLATE_WITHOUT_ITEMS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_CREATE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/checkout-templates","rpcOnly":false,"triggeredEvents":[{"title":"Checkout Template Created","description":"Triggered when a checkout template is created.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_CREATE_CHECKOUT_TEMPLATE_WITHOUT_ITEMS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_CREATE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Checkout Template","slugifiedName":"create-checkout-template"}},{"summary":"Get Checkout Template","description":"Retrieves a checkout template.","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.GetCheckoutTemplate","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"checkoutTemplateId","description":"ID of the checkout template to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.GetCheckoutTemplateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateResponse"},"legacyExamples":[{"name":"GetCheckoutTemplate","type":"METHOD","content":{"title":"Get Checkout Template","request":"curl -X GET \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{\n \"checkoutTemplate\": {\n \"id\": \"d447475f-34ed-4be5-b199-b120c6938c39\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true,\n \"disabledPolicyAgreementCheckbox\": false\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true,\n \"disabledManualPayment\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"customLineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"5\",\n \"descriptionLines\": [],\n \"productName\": {\n \"original\": \"My Custom Item\"\n },\n \"itemType\": {\n \"preset\": \"PHYSICAL\"\n },\n \"couponScopes\": [],\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/checkout-templates/{checkoutTemplateId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateResponse"},"legacyExamples":[{"name":"GetCheckoutTemplate","type":"METHOD","content":{"title":"Get Checkout Template","request":"curl -X GET \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{\n \"checkoutTemplate\": {\n \"id\": \"d447475f-34ed-4be5-b199-b120c6938c39\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true,\n \"disabledPolicyAgreementCheckbox\": false\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true,\n \"disabledManualPayment\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"customLineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"5\",\n \"descriptionLines\": [],\n \"productName\": {\n \"original\": \"My Custom Item\"\n },\n \"itemType\": {\n \"preset\": \"PHYSICAL\"\n },\n \"couponScopes\": [],\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Checkout Template","slugifiedName":"get-checkout-template"}},{"summary":"Delete Checkout Template","description":"Deletes a checkout template.\n\nIf a checkout template is deleted and a customer attempts to create a checkout with that `checkoutTemplateId` then\nthe customer will be redirected to the domain site.","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.DeleteCheckoutTemplate","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"checkoutTemplateId","description":"ID of the checkout template to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Checkout Template Deleted","description":"Triggered when a checkout template is deleted.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_DELETE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateResponse"},"legacyExamples":[{"name":"DeleteCheckoutTemplate","type":"METHOD","content":{"title":"Delete Checkout Template","request":"curl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/825315ef-1b62-40f7-ab62-97b751ebf285' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/checkout-templates/{checkoutTemplateId}","rpcOnly":false,"triggeredEvents":[{"title":"Checkout Template Deleted","description":"Triggered when a checkout template is deleted.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_DELETE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateResponse"},"legacyExamples":[{"name":"DeleteCheckoutTemplate","type":"METHOD","content":{"title":"Delete Checkout Template","request":"curl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/825315ef-1b62-40f7-ab62-97b751ebf285' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Checkout Template","slugifiedName":"delete-checkout-template"}},{"summary":"Update Checkout Template","description":"Updates a checkout template.\n\nIf the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously\ncreated from this template before the update will not be affected.","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.UpdateCheckoutTemplate","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"checkoutTemplate.id","description":"Checkout template ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCheckoutTemplateRequest","description":"","properties":{"checkoutTemplate":{"description":"Checkout template info to update.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["checkoutTemplate","checkoutTemplate.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Checkout Template Updated","description":"Triggered when a checkout template is updated.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITHOUT_SPECIFIED_FIELDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_UNSUPPORTED_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_UPDATE_TEMPLATE_WITH_UNKNOWN_STATUS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_EMPTY_ITEMS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_UPDATE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/checkout-templates/{checkoutTemplate.id}","rpcOnly":false,"triggeredEvents":[{"title":"Checkout Template Updated","description":"Triggered when a checkout template is updated.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITHOUT_SPECIFIED_FIELDS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_UNSUPPORTED_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_UPDATE_TEMPLATE_WITH_UNKNOWN_STATUS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_EMPTY_ITEMS"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_UPDATE"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Checkout Template","slugifiedName":"update-checkout-template"}},{"summary":"Query Checkout Templates","description":"Retrieves a list of checkout templates, given the provided paging, filtering, and sorting.\n\nQuery Checkout Templates runs with these defaults, which you can override:\n- `id` sorted in `ASC` order\n\nThe following table shows field support for filters and sorting for the checkout template object:\n\n| Field | Supported Filters | Sortable |\n| ------------------ | --------------------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome` | Sortable |\n| `status` | `$eq`, `$ne`, `$in`, `$exists`, `$hasSome` | Sortable |\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),\nand [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.QueryCheckoutTemplates","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryCheckoutTemplatesRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesRequest","responseMessage":"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesResponse"},"legacyExamples":[{"name":"QueryCheckoutTemplates","type":"METHOD","content":{"title":"Query Checkout Templates using Cursor Paging","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"query\": {\n \"sort\": [],\n \"filter\": {\n \"status\": \"ACTIVE\"\n },\n \"cursorPaging\": {\n \"limit\": 3\n }\n }\n }'","response":"{\n \"checkoutTemplates\": [\n {\n \"checkoutTemplate\": {\n \"id\": \"d447475f-34ed-4be5-b199-b120c6938c39\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true,\n \"disabledPolicyAgreementCheckbox\": false\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true,\n \"disabledManualPayment\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n },\n {\n \"id\": \"056e6325-fadb-4df3-b447-333639689e0a\",\n \"status\": \"ACTIVE\",\n \"customization\": null,\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"name\": \"Shirt & Hat Bundle\",\n \"price\": \"10\",\n \"priceDescription\": null,\n \"descriptionLines\": [],\n \"media\": {\n \"id\": \"1\",\n \"url\": \"https://images.squarespace-cdn.com/content/v1/626c8a4c9f0cac0699248dcf/1666767197763-D3TOWRQHU36NKG3PVVM6/Tee-%2B-Hat.png\",\n \"height\": 0,\n \"width\": 0,\n \"altText\": null,\n \"urlExpirationDate\": null,\n \"filename\": null,\n \"sizeInBytes\": null\n },\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n \"id\": null\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n },\n {\n \"id\": \"090c1a79-b066-4588-8943-c940ad9dd531\",\n \"status\": \"ACTIVE\",\n \"customization\": null,\n \"lineItems\": [\n {\n \"quantity\": 10,\n \"name\": \"SHIRT\",\n \"price\": \"100\",\n \"priceDescription\": null,\n \"descriptionLines\": [],\n \"media\": null,\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n \"id\": null\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {\n \"next\": \"25012ca406ecac3b31c45af1085bba46ac9580c3.EhYqFAoSCgZzdGF0dXMSCBoGQUNUSVZFIiQwOTBjMWE3OS1iMDY2LTQ1ODgtODk0My1jOTQwYWQ5ZGQ1MzE\",\n \"prev\": null\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/checkout-templates/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesRequest","responseMessage":"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesResponse"},"legacyExamples":[{"name":"QueryCheckoutTemplates","type":"METHOD","content":{"title":"Query Checkout Templates using Cursor Paging","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"query\": {\n \"sort\": [],\n \"filter\": {\n \"status\": \"ACTIVE\"\n },\n \"cursorPaging\": {\n \"limit\": 3\n }\n }\n }'","response":"{\n \"checkoutTemplates\": [\n {\n \"checkoutTemplate\": {\n \"id\": \"d447475f-34ed-4be5-b199-b120c6938c39\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true,\n \"disabledPolicyAgreementCheckbox\": false\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true,\n \"disabledManualPayment\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n },\n {\n \"id\": \"056e6325-fadb-4df3-b447-333639689e0a\",\n \"status\": \"ACTIVE\",\n \"customization\": null,\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"name\": \"Shirt & Hat Bundle\",\n \"price\": \"10\",\n \"priceDescription\": null,\n \"descriptionLines\": [],\n \"media\": {\n \"id\": \"1\",\n \"url\": \"https://images.squarespace-cdn.com/content/v1/626c8a4c9f0cac0699248dcf/1666767197763-D3TOWRQHU36NKG3PVVM6/Tee-%2B-Hat.png\",\n \"height\": 0,\n \"width\": 0,\n \"altText\": null,\n \"urlExpirationDate\": null,\n \"filename\": null,\n \"sizeInBytes\": null\n },\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n \"id\": null\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n },\n {\n \"id\": \"090c1a79-b066-4588-8943-c940ad9dd531\",\n \"status\": \"ACTIVE\",\n \"customization\": null,\n \"lineItems\": [\n {\n \"quantity\": 10,\n \"name\": \"SHIRT\",\n \"price\": \"100\",\n \"priceDescription\": null,\n \"descriptionLines\": [],\n \"media\": null,\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n \"id\": null\n }\n ],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 3,\n \"cursors\": {\n \"next\": \"25012ca406ecac3b31c45af1085bba46ac9580c3.EhYqFAoSCgZzdGF0dXMSCBoGQUNUSVZFIiQwOTBjMWE3OS1iMDY2LTQ1ODgtODk0My1jOTQwYWQ5ZGQ1MzE\",\n \"prev\": null\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Checkout Templates","slugifiedName":"query-checkout-templates"}},{"summary":"Create Checkout From Template","description":"Creates a new checkout based on the checkout template.\n\nBefore using this endpoint, you must have a checkout template available. Create a checkout template with [Create Checkout Template](https://dev.wix.com/api/rest/wix-e-commerce/checkout-templates/create-checkout-template).\n\nThe customer can be directed to the new checkout using the checkout's `checkoutUrl`.","operationId":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService.CreateCheckoutFromTemplate","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"checkoutTemplateId","description":"ID of the checkout template to use to create a checkout from.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/checkout-templates","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/checkout-templates","destinationPath":"/v1/checkout-templates","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCheckoutFromTemplateRequest","description":"","properties":{"siteId":{"description":"ID of the site associated with the checkout template.","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["checkoutTemplateId","siteId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Checkout Template Used","description":"Triggered when a checkout is created from a checkout template.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"payload":{"schemaName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateUsed"},"exposure":"PUBLIC","maturity":"BETA","slug":"used","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_used","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_CREATE_CHECKOUT_FROM_INACTIVE_TEMPLATE"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_CREATE_CHECKOUT"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateResponse"},"legacyExamples":[{"name":"CreateCheckoutFromTemplate","type":"METHOD","content":{"title":"Create Checkout From Template","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39/create-checkout-from-template' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"siteId\": \"811d8a67-3bd7-46a5-8cd9-843bb77b2a7d\"\n }'","response":"{\n \"checkoutId\": \"2c6ece26-baeb-4d9f-a7e5-695d295110da\",\n \"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\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/checkout-templates/{checkoutTemplateId}/create-checkout-from-template","rpcOnly":false,"triggeredEvents":[{"title":"Checkout Template Used","description":"Triggered when a checkout is created from a checkout template.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"payload":{"schemaName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateUsed"},"exposure":"PUBLIC","maturity":"BETA","slug":"used","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.checkout_template_used","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_CREATE_CHECKOUT_FROM_INACTIVE_TEMPLATE"}],"exposure":"PUBLIC","maturity":"BETA","permissions":["ECOM.CHECKOUT_TEMPLATE_CREATE_CHECKOUT"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom:checkout-template","serviceArtifactId":"com.wixpress.ecom.checkout-template","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateRequest","responseMessage":"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateResponse"},"legacyExamples":[{"name":"CreateCheckoutFromTemplate","type":"METHOD","content":{"title":"Create Checkout From Template","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/checkout-templates/d447475f-34ed-4be5-b199-b120c6938c39/create-checkout-from-template' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"siteId\": \"811d8a67-3bd7-46a5-8cd9-843bb77b2a7d\"\n }'","response":"{\n \"checkoutId\": \"2c6ece26-baeb-4d9f-a7e5-695d295110da\",\n \"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\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Checkout From Template","slugifiedName":"create-checkout-from-template"}}],"webhooks":[{"summary":"Checkout Template Created","title":"Checkout Template Created","description":"Triggered when a checkout template is created.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.v1.checkout_template_created","legacyExamples":[{"name":"CheckoutTemplateCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"79e70c2a-f3fe-4a3b-a62f-1089857bab84\",\n \"entityFqdn\": \"wix.ecom.v1.checkout_template\",\n \"slug\": \"created\",\n \"entityId\": \"5bf5cb44-13fa-4933-9655-1d8423636a74\",\n \"createdEvent\": {\n \"entity\": \n {\n \"id\": \"5bf5cb44-13fa-4933-9655-1d8423636a74\",\n \"status\": \"ACTIVE\",\n \"lineItems\":\n [{\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n },\n \"eventTime\": \"2023-09-11T14:58:22.481838Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","contentLink":{"displayName":"Checkout Template Created","slugifiedName":"checkout-template-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Checkout Template Updated","title":"Checkout Template Updated","description":"Triggered when a checkout template is updated.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.v1.checkout_template_updated","legacyExamples":[{"name":"CheckoutTemplateUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"295e8d31-92e3-4868-9b2f-c6da5cb0abff\",\n \"entityFqdn\": \"wix.ecom.v1.checkout_template\",\n \"slug\": \"updated\",\n \"entityId\": \"825315ef-1b62-40f7-ab62-97b751ebf285\",\n \"updatedEvent\": {\n \"currentEntity\": \n {\n \"id\": \"825315ef-1b62-40f7-ab62-97b751ebf285\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": true\n },\n \"lockedGiftCard\": false,\n \"lockedCoupon\": true\n },\n \"lineItems\": [{\n \"quantity\": 4,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Small\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }],\n \"couponCode\": \"SUMMER_FLASH_SALE\"\n }\n },\n \"eventTime\": \"2023-09-11T09:32:02.365080Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"3\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","contentLink":{"displayName":"Checkout Template Updated","slugifiedName":"checkout-template-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Checkout Template Deleted","title":"Checkout Template Deleted","description":"Triggered when a checkout template is deleted.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.v1.checkout_template_deleted","legacyExamples":[{"name":"CheckoutTemplateDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"5c55d2dd-8919-438d-b9c0-19ec2b3f913f\",\n \"entityFqdn\": \"wix.ecom.v1.checkout_template\",\n \"slug\": \"deleted\",\n \"entityId\": \"825315ef-1b62-40f7-ab62-97b751ebf285\",\n \"deletedEvent\": {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2023-09-11T09:40:28.303263Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"7\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","contentLink":{"displayName":"Checkout Template Deleted","slugifiedName":"checkout-template-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Checkout Template Used","title":"Checkout Template Used","description":"Triggered when a checkout is created from a checkout template.","permissions":["ECOM.CHECKOUT_TEMPLATE_READ"],"payload":{"schemaName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateUsed"},"exposure":"PUBLIC","maturity":"BETA","slug":"used","eventTopic":"domain_events_wix.ecom.v1.checkout_template","serviceName":"wix.ecom.checkout_template.api.v1.CheckoutTemplateService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.v1.checkout_template_used","legacyExamples":[{"name":"CheckoutTemplateUsed","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"148a3b54-bb9a-450b-996c-5101d8889fb4\",\n \"entityFqdn\": \"wix.ecom.v1.checkout_template\",\n \"slug\": \"used\",\n \"entityId\": \"b3210445-9252-4094-8df2-48adec157322\",\n \"actionEvent\": {\n \"body\": {\n \"checkoutTemplate\": {\n \"id\": \"44efbcf4-481d-454c-b3d0-57b7a1cae99c\",\n \"status\": \"ACTIVE\",\n \"customization\": {\n \"webClient\": {\n \"disabledContinueShoppingButton\": false\n },\n \"lockedGiftCard\": true,\n \"lockedCoupon\": true\n },\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n }\n }\n ],\n \"customLineItems\": [],\n \"couponCode\": \"SUMMERSALE20\"\n },\n \"checkout\": {\n \"id\": \"b3210445-9252-4094-8df2-48adec157322\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 2,\n \"catalogReference\": {\n \"catalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"options\": {\n \"options\": {\n \"Size\": \"Medium\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\"\n }\n },\n \"productName\": {\n \"original\": \"Hat 1\",\n \"translated\": \"Hat 1\"\n },\n \"url\": {\n \"relativePath\": \"/product-page/hat-1\",\n \"url\": \"https://example.wixsite.com/example-store/product-page/hat-1\"\n },\n \"price\": {\n \"amount\": \"25\",\n \"convertedAmount\": \"25\",\n \"formattedAmount\": \"$25.00\",\n \"formattedConvertedAmount\": \"$25.00\"\n },\n \"lineItemPrice\": {\n \"amount\": \"50\",\n \"convertedAmount\": \"50\",\n \"formattedAmount\": \"$50.00\",\n \"formattedConvertedAmount\": \"$50.00\"\n },\n \"fullPrice\": {\n \"amount\": \"25\",\n \"convertedAmount\": \"25\",\n \"formattedAmount\": \"$25.00\",\n \"formattedConvertedAmount\": \"$25.00\"\n },\n \"priceBeforeDiscounts\": {\n \"amount\": \"25\",\n \"convertedAmount\": \"25\",\n \"formattedAmount\": \"$25.00\",\n \"formattedConvertedAmount\": \"$25.00\"\n },\n \"totalPriceAfterTax\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"totalPriceBeforeTax\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"taxDetails\": {\n \"taxableAmount\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"taxRate\": \"0\",\n \"totalTax\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"rateBreakdown\": []\n },\n \"discount\": {\n \"amount\": \"5\",\n \"convertedAmount\": \"5\",\n \"formattedAmount\": \"$5.00\",\n \"formattedConvertedAmount\": \"$5.00\"\n },\n \"descriptionLines\": [\n {\n \"name\": {\n \"original\": \"Size\",\n \"translated\": \"Size\"\n },\n \"plainText\": {\n \"original\": \"Medium\",\n \"translated\": \"Medium\"\n }\n }\n ],\n \"media\": {\n \"id\": \"baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg\",\n \"height\": 1500,\n \"width\": 2000,\n \"filename\": \"baac51_444fa6e3add545a6b3757f46a11ee9de~mv2_d_2000_1500_s_2.jpg\"\n },\n \"availability\": {\n \"status\": \"AVAILABLE\"\n },\n \"physicalProperties\": {\n \"sku\": \"0002\",\n \"shippable\": true\n },\n \"couponScopes\": [\n {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"d704acf4-11af-f65e-b9a5-fc49ab782122\"\n }\n },\n {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"00000000-000000-000000-000000000001\"\n }\n },\n {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"product\",\n \"entityId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\"\n }\n }\n ],\n \"itemType\": {\n \"preset\": \"PHYSICAL\"\n },\n \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n \"rootCatalogItemId\": \"8df1afe4-90d1-162d-2d42-b8308125c193\",\n \"customLineItem\": false\n }\n ],\n \"shippingInfo\": {\n \"carrierServiceOptions\": []\n },\n \"buyerInfo\": {\n \"openAccess\": true\n },\n \"conversionCurrency\": \"USD\",\n \"priceSummary\": {\n \"subtotal\": {\n \"amount\": \"50\",\n \"convertedAmount\": \"50\",\n \"formattedAmount\": \"$50.00\",\n \"formattedConvertedAmount\": \"$50.00\"\n },\n \"shipping\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"tax\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"discount\": {\n \"amount\": \"5\",\n \"convertedAmount\": \"5\",\n \"formattedAmount\": \"$5.00\",\n \"formattedConvertedAmount\": \"$5.00\"\n },\n \"total\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"additionalFees\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n }\n },\n \"calculationErrors\": {\n \"orderValidationErrors\": []\n },\n \"appliedDiscounts\": [\n {\n \"discountType\": \"SPECIFIC_ITEMS\",\n \"lineItemIds\": [\n \"00000000-0000-0000-0000-000000000001\"\n ],\n \"coupon\": {\n \"id\": \"14d074d8-15f3-4d71-bfa9-dc5b4ac47e61\",\n \"code\": \"SUMMERSALE20\",\n \"amount\": {\n \"amount\": \"5\",\n \"convertedAmount\": \"5\",\n \"formattedAmount\": \"$5.00\",\n \"formattedConvertedAmount\": \"$5.00\"\n },\n \"name\": \"summer sale\",\n \"couponType\": \"MoneyOff\"\n },\n \"lineItemDiscounts\": []\n }\n ],\n \"customFields\": [],\n \"weightUnit\": \"LB\",\n \"taxSummary\": {\n \"taxableAmount\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"totalTax\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"manualTaxRate\": \"0\",\n \"aggregatedTaxBreakdown\": []\n },\n \"currency\": \"USD\",\n \"channelType\": \"WEB\",\n \"siteLanguage\": \"en\",\n \"buyerLanguage\": \"en\",\n \"completed\": false,\n \"taxIncludedInPrice\": false,\n \"createdBy\": {\n \"appId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\"\n },\n \"createdDate\": \"2024-01-07T14:42:19.240Z\",\n \"updatedDate\": \"2024-01-07T14:42:19.240Z\",\n \"payNow\": {\n \"subtotal\": {\n \"amount\": \"50\",\n \"convertedAmount\": \"50\",\n \"formattedAmount\": \"$50.00\",\n \"formattedConvertedAmount\": \"$50.00\"\n },\n \"shipping\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"tax\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"discount\": {\n \"amount\": \"5\",\n \"convertedAmount\": \"5\",\n \"formattedAmount\": \"$5.00\",\n \"formattedConvertedAmount\": \"$5.00\"\n },\n \"total\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"additionalFees\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n }\n },\n \"payLater\": {\n \"subtotal\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"shipping\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"tax\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"discount\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"total\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n },\n \"additionalFees\": {\n \"amount\": \"0\",\n \"convertedAmount\": \"0\",\n \"formattedAmount\": \"$0.00\",\n \"formattedConvertedAmount\": \"$0.00\"\n }\n },\n \"additionalFees\": [],\n \"payNowTotalAfterGiftCard\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"ecomId\": \"95b38c92-a577-4609-b950-3473cbb32134\",\n \"violations\": [],\n \"totalAfterGiftCard\": {\n \"amount\": \"45\",\n \"convertedAmount\": \"45\",\n \"formattedAmount\": \"$45.00\",\n \"formattedConvertedAmount\": \"$45.00\"\n },\n \"purchaseFlowId\": \"4595d2bd-6e73-4f12-a876-ac7b3bce901f\",\n \"customSettings\": {\n \"lockGiftCard\": true,\n \"lockCouponCode\": true\n }\n }\n }\n },\n \"eventTime\": \"2024-01-07T14:42:19.340889012Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplateUsed","contentLink":{"displayName":"Checkout Template Used","slugifiedName":"checkout-template-used"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the eCommerce Checkout Templates API\n\nThe 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.\n\nWith the Checkout Templates API, you can:\n+ Run a sale on a specific product for a limited time\n+ Customize the checkout experience\n\n\n## Before you Begin\n\nIt’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.\n\n# Use Cases\n\n+ [Run a flash sale through social media](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::sample-flows*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/sample-flows)\n+ [Limit the number of checkouts for a specific coupon](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::sample-flows*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/sample-flows)\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"proto/appendices/docs/introduction.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Checkout Templates: Sample Use Case & Flow\nThis article shares some possible use cases your app could support, as well as an sample flow that could support each\nuse case. This can be a helpful jumping off point as you plan your app's implementation.\n\n## Run a flash sale through social media\nOffer 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.\n\nTo create and share the offer:\n\n1. Use [Create Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::create-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/create-checkout-template) with the product and coupon information for offer.\n2. 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}`.\n3. Post and share the URL to customers.\n\nTo turn off the offer at the end of the sale:\n\n1. Use [Update Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::update-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/update-checkout-template) to update `checkoutTemplate.status` to `INACTIVE`.\n\n## Limit the number of checkouts for a specific coupon\nOffer 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.\n\nCreate a checkout template and add your own custom logic:\n\n1. Use [Create Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::create-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/create-checkout-template) with the product and coupon information for offer.\n2. Create a bank of all new checkouts for this sale by collecting the `checkoutId`s of checkouts created from this `checkoutTemplateId`.\n3. Before a new checkout is created with the `checkoutTemplateId`, check the bank and count the number of `checkoutId`s being stored.\n4. Once the count hits `100` checkouts, use [Update Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::update-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/update-checkout-template) to update `checkoutTemplate.status` to `INACTIVE`.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"proto/appendices/docs/sample-flows.md"}],"components":{"schemas":{"wix.ecom.checkout_template.api.v1.CheckoutTemplate":{"type":"object","properties":{"id":{"description":"Checkout template ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`","title":"status","type":"string","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customization":{"description":"Custom settings to apply to the checkout page created from this template.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutCustomization","summary":"customization","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItems":{"description":"Line items.\n\nMax: 300 items","maxItems":300,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.LineItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"couponCode":{"description":"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the [Coupons API](https://dev.wix.com/docs/rest/api-reference/coupons/coupons/introduction).","title":"couponCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CheckoutTemplate","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.ecom.checkout_template.api.v1.CheckoutTemplate.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN_STATUS","ACTIVE","INACTIVE"]},"wix.ecom.checkout_template.api.v1.CheckoutCustomization":{"type":"object","properties":{"webClient":{"description":"Web client customizations. These customizations only apply to the standard Wix checkout page.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.WebClientCustomization","summary":"webClient","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lockedGiftCard":{"description":"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`","title":"lockedGiftCard","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lockedCoupon":{"description":"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`","title":"lockedCoupon","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CheckoutCustomization","description":""},"wix.ecom.checkout_template.api.v1.WebClientCustomization":{"type":"object","properties":{"disabledContinueShoppingButton":{"description":"Whether to disable the \"Continue shopping\" button.\n\nDefault: `false`","title":"disabledContinueShoppingButton","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"WebClientCustomization","description":""},"wix.ecom.checkout_template.api.v1.LineItem":{"type":"object","properties":{"quantity":{"description":"Item quantity.\n\nMin: `1`
\nMax: `100000`","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"catalogReference":{"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.\n\n> **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference","summary":"catalogReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItem","description":""},"com.wix.ecommerce.catalog_spi.api.v1.CatalogReference":{"type":"object","properties":{"catalogItemId":{"description":"ID of the item within the catalog it belongs to.","minLength":1,"maxLength":36,"title":"catalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`","minLength":1,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).","title":"options","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CatalogReference","description":"Used for grouping line items. Sent when an item is added to a cart, checkout, or order."},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wix.ecom.cart_checkout_common.api.v1.CatalogOverrideFields":{"type":"object","properties":{"productName":{"description":"Item product name","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ProductName","summary":"productName","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Item price **after** discounts.","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","lte":"999999999","maxScale":3}}},"fullPrice":{"description":"Item price **before** discount.","title":"fullPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","lte":"999999999","maxScale":3}}},"descriptionLines":{"description":"Line item description lines. Used for displaying the cart, checkout and order.","minItems":0,"maxItems":20,"title":"descriptionLines","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"physicalProperties":{"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"image":{"description":"Line item image details.","$ref":"#/components/schemas/com.wix.ecom.cart_checkout_common.api.v1.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CatalogOverrideFields","description":""},"com.wix.ecommerce.catalog_spi.api.v1.ProductName":{"type":"object","properties":{"original":{"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#request-envelope).\n\nMin: 1 character.\nMax: 200 characters.","minLength":1,"maxLength":200,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`.","minLength":1,"maxLength":400,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductName","description":""},"com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine":{"type":"object","properties":{"name":{"description":"Description line name.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLineName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DescriptionLine","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine.value"},{"description":"","summary":"descriptionLineValue","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine.descriptionLineValue"}]},"com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine.value":{"type":"object","title":"value","properties":{"plainText":{"description":"Description line plain text value.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PlainTextValue","summary":"plainText","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"colorInfo":{"description":"Description line color value.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.Color","summary":"colorInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine.descriptionLineValue":{"type":"object","title":"descriptionLineValue","properties":{}},"com.wix.ecommerce.catalog_spi.api.v1.DescriptionLineName":{"type":"object","properties":{"original":{"description":"Description line 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#request-envelope).","maxLength":100,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`.","maxLength":200,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DescriptionLineName","description":""},"com.wix.ecommerce.catalog_spi.api.v1.PlainTextValue":{"type":"object","properties":{"original":{"description":"Description line plain text value 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#request-envelope).","maxLength":600,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`.","maxLength":600,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlainTextValue","description":""},"com.wix.ecommerce.catalog_spi.api.v1.Color":{"type":"object","properties":{"original":{"description":"Description line color 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#request-envelope).","maxLength":500,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`.","maxLength":500,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"code":{"description":"HEX or RGB color code for display.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Color","description":""},"com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine.DescriptionLineType":{"type":"string","description":"","title":"DescriptionLineType","enum":["UNRECOGNISED","PLAIN_TEXT","COLOR"]},"com.wix.ecommerce.catalog_spi.api.v1.PhysicalProperties":{"type":"object","properties":{"weight":{"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.","title":"weight","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sku":{"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).","maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippable":{"description":"Whether this line item is shippable.","title":"shippable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PhysicalProperties","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"com.wix.ecom.cart_checkout_common.api.v1.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text. Optional.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename. Optional.","title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wix.ecom.cart_checkout_common.api.v1.CustomLineItem":{"type":"object","properties":{"quantity":{"description":"Custom line item quantity.\n\nMin: `1`\nMax: `100000`","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Custom line item price.\n\nMust be a number or a decimal without symbols.","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"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\".","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PriceDescription","summary":"priceDescription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"descriptionLines":{"description":"Custom line item description lines. Used for display purposes for the cart, checkout and order.","maxItems":10,"title":"descriptionLines","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Custom line item's media.","$ref":"#/components/schemas/com.wix.ecom.cart_checkout_common.api.v1.Image","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Custom line item ID. If passed, `id` must be unique.\nDefault: auto-generated ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxGroupId":{"description":"Tax group ID for this custom line item.","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productName":{"description":"Name of the item or product.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ProductName","summary":"productName","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Optional - 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.\nThe URL is optional and if not provided, the site URL will be used.","$ref":"#/components/schemas/wix.common.PageUrlV2","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemType":{"description":"Item type. Either a preset type or custom.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ItemType","summary":"itemType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fullPrice":{"description":"Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided.","format":"DECIMAL_VALUE","title":"fullPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantityAvailable":{"description":"Optional - Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.","minimum":0,"maximum":100000,"title":"quantityAvailable","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"physicalProperties":{"description":"Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentOption":{"description":"Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `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.","title":"paymentOption","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PaymentOptionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProperties":{"description":"Optional - Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ServiceProperties","summary":"serviceProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rootCatalogItemId":{"description":"Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ in most cases, this field is the name as `catalogReference.catalogItemId`.\n+ Used in membership validation.","minLength":1,"maxLength":36,"title":"rootCatalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"depositAmount":{"description":"Optional - partial payment for the given item to be paid upfront during the checkout.\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nIf omitted - item's price will not be split and is expected to be paid in single installment","format":"DECIMAL_VALUE","title":"depositAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"catalogReference":{"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference","summary":"catalogReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomLineItem","description":""},"com.wix.ecommerce.catalog_spi.api.v1.PriceDescription":{"type":"object","properties":{"original":{"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#request-envelope).","minLength":1,"maxLength":100,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`.","minLength":1,"maxLength":100,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PriceDescription","description":""},"wix.common.PageUrlV2":{"type":"object","properties":{"relativePath":{"description":"The relative path for the page within the site. For example, `/product-page/a-product`.","title":"relativePath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The page's full URL. For example, `https://mysite.com/product-page/a-product`.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrlV2","description":""},"com.wix.ecommerce.catalog_spi.api.v1.ItemType":{"type":"object","properties":{},"title":"ItemType","description":"","oneOf":[{"description":"","summary":"itemTypeData","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ItemType.itemTypeData"}]},"com.wix.ecommerce.catalog_spi.api.v1.ItemType.itemTypeData":{"type":"object","title":"itemTypeData","properties":{"preset":{"description":"Preset item type.","title":"preset","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ItemType.ItemType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Custom item type. When none of the preset types are suitable, specifies the custom type.","title":"custom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecommerce.catalog_spi.api.v1.ItemType.ItemType":{"type":"string","description":"","title":"ItemType","enum":["UNRECOGNISED","PHYSICAL","DIGITAL","GIFT_CARD","SERVICE"]},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.coupons.api.v2.Scope":{"type":"object","properties":{"namespace":{"description":"Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)","title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"group":{"description":"Coupon scope's applied group (e.g., event or ticket in Wix Events)","$ref":"#/components/schemas/wix.coupons.api.v2.Scope.Group","summary":"group","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Scope","description":""},"wix.coupons.api.v2.Scope.Group":{"type":"object","properties":{"name":{"description":"Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"Item ID (when the coupon scope is limited to just one item).","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Group","description":""},"com.wix.ecommerce.catalog_spi.api.v1.SubscriptionOptionInfo":{"type":"object","properties":{"subscriptionSettings":{"description":"Subscription option settings.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.SubscriptionSettings","summary":"subscriptionSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Subscription option title.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.Title","summary":"title","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Subscription option description.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.Description","summary":"description","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionOptionInfo","description":""},"com.wix.ecommerce.catalog_spi.api.v1.SubscriptionSettings":{"type":"object","properties":{"frequency":{"description":"Frequency of recurring payment.","title":"frequency","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v2.SubscriptionFrequency","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoRenewal":{"description":"Whether subscription is renewed automatically at the end of each period.","title":"autoRenewal","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"billingCycles":{"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.","minimum":2,"title":"billingCycles","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionSettings","description":""},"wix.payment.api.pay.v2.SubscriptionFrequency":{"type":"string","description":"Frequency unit of recurring payment","title":"SubscriptionFrequency","enum":["UNDEFINED","DAY","WEEK","MONTH","YEAR"]},"com.wix.ecommerce.catalog_spi.api.v1.Title":{"type":"object","properties":{"original":{"description":"Subscription option 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#request-envelope).","minLength":1,"maxLength":20,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Subscription option name translated into the buyer's language.\n\nDefault: Same as `original`.","minLength":1,"maxLength":20,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Title","description":""},"com.wix.ecommerce.catalog_spi.api.v1.Description":{"type":"object","properties":{"original":{"description":"Subscription option description.","maxLength":60,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Translated subscription option description.","maxLength":60,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Description","description":""},"com.wix.ecommerce.catalog_spi.api.v1.SecuredMedia":{"type":"object","properties":{"id":{"description":"Media ID in Wix Media Manager.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Original filename.","minLength":1,"maxLength":1000,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileType":{"description":"File type.","title":"fileType","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.SecuredMedia.FileType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SecuredMedia","description":""},"com.wix.ecommerce.catalog_spi.api.v1.SecuredMedia.FileType":{"type":"string","description":"","title":"FileType","enum":["UNSPECIFIED","SECURE_PICTURE","SECURE_VIDEO","SECURE_DOCUMENT","SECURE_MUSIC","SECURE_ARCHIVE"]},"com.wix.ecommerce.catalog_spi.api.v1.PaymentOptionType":{"type":"string","description":"Type of selected payment option for catalog item","title":"PaymentOptionType","enum":["FULL_PAYMENT_ONLINE","FULL_PAYMENT_OFFLINE","MEMBERSHIP","DEPOSIT_ONLINE","MEMBERSHIP_OFFLINE"]},"com.wix.ecommerce.catalog_spi.api.v1.ServiceProperties":{"type":"object","properties":{"scheduledDate":{"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.\nFor example, the start time of a class.","title":"scheduledDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberOfParticipants":{"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.","minimum":1,"maximum":10000,"title":"numberOfParticipants","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProperties","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"com.wix.ecom.cart_checkout_common.api.v1.CustomContentReference":{"type":"object","properties":{"appId":{"description":"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"componentId":{"description":"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).","format":"GUID","title":"componentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomContentReference","description":""},"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateRequest":{"type":"object","properties":{"checkoutTemplate":{"description":"Checkout template to create.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCheckoutTemplateRequest","description":""},"wix.ecom.checkout_template.api.v1.CreateCheckoutTemplateResponse":{"type":"object","properties":{"checkoutTemplate":{"description":"Created checkout template.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCheckoutTemplateResponse","description":""},"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateRequest":{"type":"object","properties":{"checkoutTemplateId":{"description":"ID of the checkout template to retrieve.","format":"GUID","title":"checkoutTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCheckoutTemplateRequest","description":""},"wix.ecom.checkout_template.api.v1.GetCheckoutTemplateResponse":{"type":"object","properties":{"checkoutTemplate":{"description":"Retrieved checkout template.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCheckoutTemplateResponse","description":""},"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateRequest":{"type":"object","properties":{"checkoutTemplate":{"description":"Checkout template info to update.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCheckoutTemplateRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.ecom.checkout_template.api.v1.UpdateCheckoutTemplateResponse":{"type":"object","properties":{"checkoutTemplate":{"description":"Updated checkout template.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCheckoutTemplateResponse","description":""},"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateRequest":{"type":"object","properties":{"checkoutTemplateId":{"description":"ID of the checkout template to delete.","format":"GUID","title":"checkoutTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCheckoutTemplateRequest","description":""},"wix.ecom.checkout_template.api.v1.DeleteCheckoutTemplateResponse":{"type":"object","properties":{},"title":"DeleteCheckoutTemplateResponse","description":""},"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCheckoutTemplatesRequest","description":""},"wix.ecom.checkout_template.api.v1.upstream.wix.query.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\n\nExample of operators: `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.query.CursorQuery.pagingMethod"}]},"wix.ecom.checkout_template.api.v1.upstream.wix.query.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.ecom.checkout_template.api.v1.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.ecom.checkout_template.api.v1.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.ecom.checkout_template.api.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results. \n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.ecom.checkout_template.api.v1.QueryCheckoutTemplatesResponse":{"type":"object","properties":{"checkoutTemplates":{"description":"Retrieved checkout templates.","title":"checkoutTemplates","type":"array","items":{"$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCheckoutTemplatesResponse","description":""},"wix.ecom.checkout_template.api.v1.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Offset that was requested.","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.ecom.checkout_template.api.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateRequest":{"type":"object","properties":{"checkoutTemplateId":{"description":"ID of the checkout template to use to create a checkout from.","format":"GUID","title":"checkoutTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"ID of the site associated with the checkout template.","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCheckoutFromTemplateRequest","description":""},"wix.ecom.checkout_template.api.v1.CreateCheckoutFromTemplateResponse":{"type":"object","properties":{"checkoutId":{"description":"ID of the created checkout.","format":"GUID","title":"checkoutId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"checkoutUrl":{"description":"URL of the created checkout page.","title":"checkoutUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"purchaseFlowId":{"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.","format":"GUID","title":"purchaseFlowId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCheckoutFromTemplateResponse","description":""},"wix.ecom.checkout_template.api.v1.CheckoutTemplateUsed":{"type":"object","properties":{"checkoutTemplate":{"description":"checkout template","$ref":"#/components/schemas/wix.ecom.checkout_template.api.v1.CheckoutTemplate","summary":"checkoutTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"checkout":{"description":"newly created checkout","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.Checkout","summary":"checkout","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CheckoutTemplateUsed","description":"Triggered when newly checkout created successfully from checkout template"},"com.wix.ecom.checkout.api.v1.Checkout":{"type":"object","properties":{"id":{"description":"Checkout ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItems":{"description":"Line items.\n\nMax: 300 items","minItems":1,"maxItems":300,"readOnly":true,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.LineItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"billingInfo":{"description":"Billing information.","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.AddressWithContact","summary":"billingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingInfo":{"description":"Shipping information.","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.ShippingInfo","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerNote":{"description":"[Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerInfo":{"description":"Buyer information.","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conversionCurrency":{"description":"All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","readOnly":true,"format":"CURRENCY","title":"conversionCurrency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceSummary":{"description":"Calculated price summary for the checkout.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.PriceSummary","summary":"priceSummary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"calculationErrors":{"description":"Errors when calculating totals.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.CalculationErrors","summary":"calculationErrors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"giftCard":{"description":"Applied gift card details.\n\n>**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.GiftCard","summary":"giftCard","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedDiscounts":{"description":"Applied discounts.","readOnly":true,"title":"appliedDiscounts","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.AppliedDiscount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customFields":{"description":"Custom fields.","title":"customFields","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.v1.CustomField"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"weightUnit":{"description":"Weight measurement unit - defaults to site's weight unit.","readOnly":true,"title":"weightUnit","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.WeightUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxSummary":{"description":"Tax summary.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.TaxSummary","summary":"taxSummary","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"The currency used when submitting the order.","format":"CURRENCY","readOnly":true,"title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"channelType":{"description":"Sales channel that submitted the order.\n+ `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n+ `\"WEB\"`: A web client.\n+ `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n+ `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n+ `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n+ `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n+ `\"WIX_INVOICES\"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)\n+ `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n+ `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n+ `\"OTHER_PLATFORM\"`: Other sales platform.","readOnly":true,"title":"channelType","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.ChannelType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteLanguage":{"description":"Site language in which original values are shown.","readOnly":true,"title":"siteLanguage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerLanguage":{"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected.","readOnly":true,"title":"buyerLanguage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"completed":{"description":"Whether an order was successfully created from this checkout.\nFor an order to be successful, it must be successfully paid for (unless the total is 0).","readOnly":true,"title":"completed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxIncludedInPrice":{"description":"Whether tax is included in line item prices.","readOnly":true,"title":"taxIncludedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdBy":{"description":"ID of the checkout's initiator.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.CreatedBy","summary":"createdBy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the checkout was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the checkout was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"payNow":{"description":"Minimal amount to pay in order to place the order.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.PriceSummary","summary":"payNow","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"payLater":{"description":"Remaining amount for the order to be fully paid.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.PriceSummary","summary":"payLater","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"membershipOptions":{"description":"Memberships to apply when creating the order.","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.MembershipOptions","summary":"membershipOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"additionalFees":{"description":"Additional Fees.","maxItems":100,"title":"additionalFees","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.AdditionalFee"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cartId":{"description":"Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.","format":"GUID","title":"cartId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"violations":{"description":"List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).","readOnly":true,"title":"violations","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Violation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom field data for the checkout object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"purchaseFlowId":{"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.","format":"GUID","readOnly":true,"title":"purchaseFlowId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customSettings":{"description":"Additional settings for customization of the checkout process.\n\nCustom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).","immutable":true,"$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.CustomSettings","summary":"customSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Checkout","description":""},"com.wix.ecom.checkout.api.v1.LineItem":{"type":"object","properties":{"id":{"description":"Line item ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Item quantity.\n\nMin: `\"1\"`\nMax: `\"100000\"`","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"catalogReference":{"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference","summary":"catalogReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productName":{"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ProductName","summary":"productName","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"URL to the item's page on the site.","readOnly":true,"$ref":"#/components/schemas/wix.common.PageUrlV2","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Item price **after** catalog-defined discount and line item discounts.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemPrice":{"description":"Total line item price **after** catalog-defined discount and line item discounts.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"lineItemPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fullPrice":{"description":"Item price **before** catalog-defined discount. Defaults to `price` when not provided.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"fullPrice","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceBeforeDiscounts":{"description":"Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"priceBeforeDiscounts","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalPriceAfterTax":{"description":"Total price after all discounts and tax.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalPriceAfterTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalPriceBeforeTax":{"description":"Total price after discounts, and before tax.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalPriceBeforeTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxDetails":{"description":"Tax details for this line item.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ItemTaxFullDetails","summary":"taxDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Discount for this line item's entire quantity.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"discount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"descriptionLines":{"description":"Line item description lines. Used for display purposes for the cart, checkout and order.","readOnly":true,"title":"descriptionLines","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.DescriptionLine"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"media":{"description":"Line item image details.","readOnly":true,"$ref":"#/components/schemas/wix.common.Image","summary":"media","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"availability":{"description":"Item availability details.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.ItemAvailabilityInfo","summary":"availability","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"physicalProperties":{"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PhysicalProperties","summary":"physicalProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemType":{"description":"Item type. Either a preset type or custom.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ItemType","summary":"itemType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentOption":{"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.\n+ `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.\n+ `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`.","readOnly":true,"title":"paymentOption","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PaymentOptionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProperties":{"description":"Service properties. When relevant, this contains information such as date and number of participants.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.ServiceProperties","summary":"serviceProperties","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rootCatalogItemId":{"description":"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field has the same value as `catalogReference.catalogItemId`.\n+ Used in membership validation.","minLength":1,"maxLength":36,"readOnly":true,"title":"rootCatalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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\".","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.PriceDescription","summary":"priceDescription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"depositAmount":{"description":"Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"depositAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItem","description":""},"com.wix.ecommerce.platform_common.api.MultiCurrencyPrice":{"type":"object","properties":{"amount":{"description":"Amount.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"convertedAmount":{"description":"Converted amount.","readOnly":true,"title":"convertedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"formattedAmount":{"description":"Amount formatted with currency symbol.","readOnly":true,"title":"formattedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedConvertedAmount":{"description":"Converted amount formatted with currency symbol.","readOnly":true,"title":"formattedConvertedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultiCurrencyPrice","description":""},"com.wix.ecom.totals_calculator.v1.ItemTaxFullDetails":{"type":"object","properties":{"taxableAmount":{"description":"Amount for which tax is calculated.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"taxableAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxRate":{"description":"Tax rate %, as a decimal point between 0 and 1.","title":"taxRate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1"}}},"totalTax":{"description":"Calculated tax, based on `taxable_amount` and `tax_rate`.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rateBreakdown":{"description":"If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.","readOnly":true,"title":"rateBreakdown","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.TaxRateBreakdown"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"ItemTaxFullDetails","description":""},"com.wix.ecom.totals_calculator.v1.TaxRateBreakdown":{"type":"object","properties":{"name":{"description":"Name of tax against which the calculation was performed.","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"Rate at which this tax detail was calculated.","title":"rate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1"}}},"tax":{"description":"Amount of tax for this tax detail.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"tax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaxRateBreakdown","description":""},"com.wix.ecom.totals_calculator.v1.TaxBreakdown":{"type":"object","properties":{"jurisdiction":{"description":"The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\".","maxLength":200,"title":"jurisdiction","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nonTaxableAmount":{"description":"The amount of this line item price that was considered nontaxable. (Decimal value)","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"nonTaxableAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)","title":"rate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","maxScale":6}}},"taxAmount":{"description":"The amount of tax estimated for this line item. (Decimal value)","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"taxAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxableAmount":{"description":"The taxable amount of this line item.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"taxableAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxType":{"description":"The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc.","maxLength":200,"title":"taxType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxName":{"description":"The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\nThis name should be explicit enough to allow the merchant to understand what tax was calculated.","maxLength":200,"title":"taxName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"jurisdictionType":{"description":"The type of the jurisdiction in which this tax detail applies.","title":"jurisdictionType","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.JurisdictionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaxBreakdown","description":"TaxBreakdown represents tax information for a line item.\nIt holds the tax amount and the tax rate for each tax authority that apply on the line item."},"com.wix.ecom.totals_calculator.v1.JurisdictionType":{"type":"string","description":"JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).","title":"JurisdictionType","enum":["UNDEFINED","COUNTRY","STATE","COUNTY","CITY","SPECIAL"]},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wix.ecom.checkout.api.v1.ItemAvailabilityInfo":{"type":"object","properties":{"status":{"description":"Item availability status.\n+ `\"NOT_FOUND\"`: Item does not exist\n+ `\"NOT_AVAILABLE\"`: Item not in stock\n+ `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested","title":"status","type":"string","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.ItemAvailabilityInfo.ItemAvailabilityStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantityAvailable":{"description":"Quantity available.","title":"quantityAvailable","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemAvailabilityInfo","description":""},"com.wix.ecom.checkout.api.v1.ItemAvailabilityInfo.ItemAvailabilityStatus":{"type":"string","description":"","title":"ItemAvailabilityStatus","enum":["AVAILABLE","NOT_FOUND","NOT_AVAILABLE","PARTIALLY_AVAILABLE"]},"com.wix.ecom.checkout.api.v1.AddressWithContact":{"type":"object","properties":{"address":{"description":"Address.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactDetails":{"description":"Contact details.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.FullAddressContactDetails","summary":"contactDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressWithContact","description":"Billing Info and shipping details"},"com.wix.ecommerce.platform_common.api.Address":{"type":"object","properties":{"country":{"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivision":{"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.","maxLength":50,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name.","maxLength":50,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"postalCode":{"description":"Postal or zip code.","maxLength":50,"title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"streetAddress":{"description":"Street address.","$ref":"#/components/schemas/wix.common.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine":{"description":"Main address line (usually street name and number).","maxLength":150,"title":"addressLine","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine2":{"description":"Free text providing more detailed address info. Usually contains apt, suite, floor.","maxLength":100,"title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"countryFullname":{"description":"Country's full name.","readOnly":true,"title":"countryFullname","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivisionFullname":{"description":"Subdivision full-name.","readOnly":true,"title":"subdivisionFullname","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Address","description":"Physical address"},"wix.common.StreetAddress":{"type":"object","properties":{"number":{"description":"Street number.","title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Street name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StreetAddress","description":""},"wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"description":"Address latitude.","title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"Address longitude.","title":"longitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressLocation","description":""},"com.wix.ecommerce.platform_common.api.FullAddressContactDetails":{"type":"object","properties":{"firstName":{"description":"First name.","maxLength":100,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastName":{"description":"Last name.","maxLength":100,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number.","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"company":{"description":"Company name.","maxLength":1000,"title":"company","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"vatId":{"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.","$ref":"#/components/schemas/wix.common.VatId","summary":"vatId","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FullAddressContactDetails","description":"Full contact details for an address"},"wix.common.VatId":{"type":"object","properties":{"id":{"description":"Customer's tax ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations","title":"type","type":"string","$ref":"#/components/schemas/wix.common.VatType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VatId","description":""},"wix.common.VatType":{"type":"string","description":"tax info types","title":"VatType","enum":["UNSPECIFIED","CPF","CNPJ"]},"com.wix.ecom.checkout.api.v1.ShippingInfo":{"type":"object","properties":{"shippingDestination":{"description":"Shipping address and contact details.","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.AddressWithContact","summary":"shippingDestination","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"selectedCarrierServiceOption":{"description":"Selected option out of the options allowed for the `region`.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOption","summary":"selectedCarrierServiceOption","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"region":{"description":"Shipping region. Based on the address provided.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ShippingRegion","summary":"region","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"carrierServiceOptions":{"description":"All carrier options for this shipping rule.","readOnly":true,"title":"carrierServiceOptions","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.CarrierServiceOption"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ShippingInfo","description":""},"com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOption":{"type":"object","properties":{"code":{"description":"Unique identifier of selected option. For example, \"usps_std_overnight\".","maxLength":100,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\".","maxLength":250,"readOnly":true,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"logistics":{"description":"Delivery logistics.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.DeliveryLogistics","summary":"logistics","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cost":{"description":"Shipping costs.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOptionPrices","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requestedShippingOption":{"description":"Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)","readOnly":true,"title":"requestedShippingOption","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"otherCharges":{"description":"Other charges","title":"otherCharges","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOptionOtherCharge"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"carrierId":{"description":"This carrier's unique ID","format":"GUID","title":"carrierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SelectedCarrierServiceOption","description":""},"com.wix.ecom.totals_calculator.v1.DeliveryLogistics":{"type":"object","properties":{"deliveryTime":{"description":"Expected delivery time, in free text. For example, \"3-5 business days\".","maxLength":500,"title":"deliveryTime","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instructions":{"description":"Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\".","maxLength":1000,"title":"instructions","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pickupDetails":{"description":"Pickup details.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.PickupDetails","summary":"pickupDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeliveryLogistics","description":""},"com.wix.ecom.totals_calculator.v1.PickupDetails":{"type":"object","properties":{"address":{"description":"Pickup address.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"businessLocation":{"description":"Whether the pickup address is that of a business - this may effect tax calculation.","title":"businessLocation","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"pickupMethod":{"description":"Pickup method","title":"pickupMethod","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.PickupDetails.PickupMethod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PickupDetails","description":""},"com.wix.ecom.totals_calculator.v1.PickupDetails.PickupMethod":{"type":"string","description":"","title":"PickupMethod","enum":["UNKNOWN_METHOD","STORE_PICKUP","PICKUP_POINT"]},"com.wix.ecom.totals_calculator.v1.DeliveryTimeSlot":{"type":"object","properties":{"from":{"description":"starting time of the delivery time slot","title":"from","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"ending time of the delivery time slot","title":"to","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeliveryTimeSlot","description":""},"com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOptionPrices":{"type":"object","properties":{"totalPriceAfterTax":{"description":"Total shipping price, after discount and after tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalPriceAfterTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalPriceBeforeTax":{"description":"Total price of shipping after discounts (when relevant), and before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalPriceBeforeTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxDetails":{"description":"Tax details.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ItemTaxFullDetails","summary":"taxDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalDiscount":{"description":"Shipping discount before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalDiscount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Shipping price before discount and before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SelectedCarrierServiceOptionPrices","description":""},"com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOptionOtherCharge":{"type":"object","properties":{"type":{"description":"Type of additional cost.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ChargeType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"details":{"description":"Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.","maxLength":200,"title":"details","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cost":{"description":"Price of added charge.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.SelectedCarrierServiceOptionPrices","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SelectedCarrierServiceOptionOtherCharge","description":""},"com.wix.ecom.totals_calculator.v1.ChargeType":{"type":"string","description":"","title":"ChargeType","enum":["HANDLING_FEE","INSURANCE"]},"com.wix.ecom.totals_calculator.v1.ShippingRegion":{"type":"object","properties":{"id":{"description":"Shipping region ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Shipping region name.","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ShippingRegion","description":""},"com.wix.ecom.totals_calculator.v1.CarrierServiceOption":{"type":"object","properties":{"carrierId":{"description":"Carrier ID.","format":"GUID","title":"carrierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingOptions":{"description":"Shipping options offered by this carrier for this request.","title":"shippingOptions","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ShippingOption"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CarrierServiceOption","description":""},"com.wix.ecom.totals_calculator.v1.ShippingOption":{"type":"object","properties":{"code":{"description":"Unique code of provided shipping option like \"usps_std_overnight\".\nFor legacy calculators this would be the UUID of the option.","maxLength":100,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\".","maxLength":250,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"logistics":{"description":"Delivery logistics.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.DeliveryLogistics","summary":"logistics","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cost":{"description":"Sipping price information.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ShippingPrice","summary":"cost","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ShippingOption","description":""},"com.wix.ecom.totals_calculator.v1.ShippingPrice":{"type":"object","properties":{"price":{"description":"Shipping price.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"otherCharges":{"description":"Other costs such as insurance, handling & packaging for fragile items, etc.","title":"otherCharges","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.OtherCharge"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ShippingPrice","description":""},"com.wix.ecom.totals_calculator.v1.OtherCharge":{"type":"object","properties":{"type":{"description":"Type of additional cost.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ChargeType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Price of added cost.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OtherCharge","description":""},"com.wix.ecom.checkout.api.v1.BuyerInfo":{"type":"object","properties":{"contactId":{"description":"Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Buyer email address.","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BuyerInfo","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.BuyerInfo.id"}]},"com.wix.ecom.checkout.api.v1.BuyerInfo.id":{"type":"object","title":"id","properties":{"visitorId":{"description":"Visitor ID (if site visitor is **not** a member).","format":"GUID","readOnly":true,"title":"visitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"Member ID (if site visitor is a site member).","format":"GUID","readOnly":true,"title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.totals_calculator.v1.PriceSummary":{"type":"object","properties":{"subtotal":{"description":"Subtotal of all line items, before discounts and before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"subtotal","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shipping":{"description":"Total shipping price, before discounts and before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"shipping","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tax":{"description":"Total tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"tax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Total calculated discount value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"discount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total price after discounts, gift cards, and tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"total","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"additionalFees":{"description":"Total additional fees price before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"additionalFees","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PriceSummary","description":""},"com.wix.ecom.totals_calculator.v1.CalculationErrors":{"type":"object","properties":{"taxCalculationError":{"description":"Tax calculation error.","$ref":"#/components/schemas/wix.api.Details","summary":"taxCalculationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"couponCalculationError":{"description":"Coupon calculation error.","$ref":"#/components/schemas/wix.api.Details","summary":"couponCalculationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"giftCardCalculationError":{"description":"Gift card calculation error.","$ref":"#/components/schemas/wix.api.Details","summary":"giftCardCalculationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orderValidationErrors":{"description":"Order validation errors.","title":"orderValidationErrors","type":"array","items":{"$ref":"#/components/schemas/wix.api.ApplicationError"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"membershipError":{"description":"Membership payment methods calculation errors\nFor example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid","$ref":"#/components/schemas/wix.api.Details","summary":"membershipError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountsCalculationError":{"description":"Discount Rule calculation error.","$ref":"#/components/schemas/wix.api.Details","summary":"discountsCalculationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculationErrors","description":"","oneOf":[{"description":"","summary":"shippingCalculationError","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.CalculationErrors.shippingCalculationError"}]},"com.wix.ecom.totals_calculator.v1.CalculationErrors.shippingCalculationError":{"type":"object","title":"shippingCalculationError","properties":{"generalShippingCalculationError":{"description":"General shipping calculation error.","$ref":"#/components/schemas/wix.api.Details","summary":"generalShippingCalculationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"carrierErrors":{"description":"Carrier errors.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.CarrierErrors","summary":"carrierErrors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.api.Details":{"type":"object","properties":{"tracing":{"description":"deprecated in API's - to enable migration from rendering arbitrary tracing to rest response","title":"tracing","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"Details","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.api.Details.kind"}]},"wix.api.Details.kind":{"type":"object","title":"kind","properties":{"applicationError":{"description":"","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"applicationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"validationError":{"description":"","$ref":"#/components/schemas/wix.api.ValidationError","summary":"validationError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"systemError":{"description":"","$ref":"#/components/schemas/wix.api.SystemError","summary":"systemError","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.api.ValidationError":{"type":"object","properties":{"fieldViolations":{"description":"","title":"fieldViolations","type":"array","items":{"$ref":"#/components/schemas/wix.api.ValidationError.FieldViolation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidationError","description":"example result:\n{\n\"fieldViolations\": [\n{\n\"field\": \"fieldA\",\n\"description\": \"invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]\",\n\"violatedRule\": \"OTHER\",\n\"ruleName\": \"INVALID_NOTE\",\n\"data\": {\n\"value\": \"FI\"\n}\n},\n{\n\"field\": \"fieldB\",\n\"description\": \"field value out of range. supported range: [0-20]\",\n\"violatedRule\": \"MAX\",\n\"data\": {\n\"threshold\": 20\n}\n},\n{\n\"field\": \"fieldC\",\n\"description\": \"invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]\",\n\"violatedRule\": \"FORMAT\",\n\"data\": {\n\"type\": \"PHONE\"\n}\n}\n]\n}"},"wix.api.ValidationError.RuleType":{"type":"string","description":"","title":"RuleType","enum":["VALIDATION","OTHER","MAX","MIN","MAX_LENGTH","MIN_LENGTH","MAX_SIZE","MIN_SIZE","FORMAT","DECIMAL_LTE","DECIMAL_GTE","DECIMAL_LT","DECIMAL_GT","DECIMAL_MAX_SCALE","INVALID_ENUM_VALUE","REQUIRED_FIELD","FIELD_NOT_ALLOWED","ONE_OF_ALIGNMENT"]},"wix.api.ValidationError.FieldViolation":{"type":"object","properties":{"field":{"description":"","title":"field","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"violatedRule":{"description":"","title":"violatedRule","type":"string","$ref":"#/components/schemas/wix.api.ValidationError.RuleType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ruleName":{"description":"applicable when violated_rule=OTHER","title":"ruleName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldViolation","description":""},"wix.api.SystemError":{"type":"object","properties":{"errorCode":{"description":"Error code.","title":"errorCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SystemError","description":""},"com.wix.ecom.totals_calculator.v1.CarrierErrors":{"type":"object","properties":{"errors":{"description":"Carrier errors.","title":"errors","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.CarrierError"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CarrierErrors","description":""},"com.wix.ecom.totals_calculator.v1.CarrierError":{"type":"object","properties":{"carrierId":{"description":"Carrier ID.","title":"carrierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Error details.","$ref":"#/components/schemas/wix.api.Details","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CarrierError","description":""},"com.wix.ecom.totals_calculator.v1.GiftCard":{"type":"object","properties":{"id":{"description":"Gift Card ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"obfuscatedCode":{"description":"Gift card obfuscated code.","title":"obfuscatedCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Gift card value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"App ID of the gift card provider.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GiftCard","description":""},"com.wix.ecom.totals_calculator.v1.AppliedDiscount":{"type":"object","properties":{"discountType":{"description":"Discount type.","title":"discountType","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.AppliedDiscount.DiscountType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemIds":{"description":"IDs of line items the discount applies to.","format":"GUID","title":"lineItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"IDs of line items the discount applies to.","replacedBy":"line_items_discounts","targetRemovalDate":"2024-06-01"}}}},"title":"AppliedDiscount","description":"","oneOf":[{"description":"","summary":"DiscountSource","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.AppliedDiscount.DiscountSource"}]},"com.wix.ecom.totals_calculator.v1.AppliedDiscount.DiscountSource":{"type":"object","title":"DiscountSource","properties":{"coupon":{"description":"Coupon details.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"merchantDiscount":{"description":"Merchant discount.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.MerchantDiscount","summary":"merchantDiscount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountRule":{"description":"Discount rule","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.totals_calculator.v1.AppliedDiscount.DiscountType":{"type":"string","description":"","title":"DiscountType","enum":["GLOBAL","SPECIFIC_ITEMS","SHIPPING"]},"com.wix.ecom.totals_calculator.v1.Coupon":{"type":"object","properties":{"id":{"description":"Coupon ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"code":{"description":"Coupon code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Coupon value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Coupon name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Coupon","description":"Coupon"},"com.wix.ecom.totals_calculator.v1.MerchantDiscount":{"type":"object","properties":{"amount":{"description":"Discount value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"percentage":{"description":"Discount Percentage. Will be calculated from items price before other discounts.","minimum":1,"maximum":100,"title":"percentage","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MerchantDiscount","description":""},"com.wix.ecom.totals_calculator.v1.DiscountRule":{"type":"object","properties":{"id":{"description":"Discount rule ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Discount rule name","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.DiscountRuleName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Discount value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountRule","description":""},"com.wix.ecom.totals_calculator.v1.DiscountRuleName":{"type":"object","properties":{"original":{"description":"Original discount rule name (in site's default language).","minLength":1,"maxLength":256,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Translated discount rule name according to buyer language. Defaults to `original` when not provided.","minLength":1,"maxLength":500,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountRuleName","description":""},"com.wix.ecom.totals_calculator.v1.LineItemDiscount":{"type":"object","properties":{"id":{"description":"ID of line item the discount applies to.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalDiscountAmount":{"description":"Discount value.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalDiscountAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItemDiscount","description":""},"com.wix.ecom.orders.v1.CustomField":{"type":"object","properties":{"value":{"description":"Custom field value.","title":"value","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Custom field title.","minLength":1,"maxLength":500,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translatedTitle":{"description":"Translated custom field title.","minLength":1,"maxLength":500,"title":"translatedTitle","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomField","description":""},"com.wix.ecommerce.platform_common.api.WeightUnit":{"type":"string","description":"","title":"WeightUnit","enum":["UNSPECIFIED_WEIGHT_UNIT","KG","LB"]},"com.wix.ecom.totals_calculator.v1.TaxSummary":{"type":"object","properties":{"taxableAmount":{"description":"Amount for which tax is calculated, added from line items.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"taxableAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalTax":{"description":"Calculated tax, added from line items.","readOnly":true,"$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"totalTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"calculationDetails":{"description":"Tax calculator that was active when the order was created.","$ref":"#/components/schemas/com.wix.ecom.tax.api.TaxCalculationDetails","summary":"calculationDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"TaxSummary","description":""},"com.wix.ecom.tax.api.TaxCalculationDetails":{"type":"object","properties":{"rateType":{"description":"Rate calculation type.","title":"rateType","type":"string","$ref":"#/components/schemas/com.wix.ecom.tax.api.RateType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaxCalculationDetails","description":"","oneOf":[{"description":"","summary":"CalculationDetails","$ref":"#/components/schemas/com.wix.ecom.tax.api.TaxCalculationDetails.CalculationDetails"}]},"com.wix.ecom.tax.api.TaxCalculationDetails.CalculationDetails":{"type":"object","title":"CalculationDetails","properties":{"manualRateReason":{"description":"Reason the manual calculation was used.","title":"manualRateReason","type":"string","$ref":"#/components/schemas/com.wix.ecom.tax.api.ManualCalculationReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoTaxFallbackDetails":{"description":"Details of the fallback rate calculation.","$ref":"#/components/schemas/com.wix.ecom.tax.api.AutoTaxFallbackCalculationDetails","summary":"autoTaxFallbackDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.tax.api.RateType":{"type":"string","description":"","title":"RateType","enum":["NO_TAX_COLLECTED","MANUAL_RATE","AUTO_RATE","FALLBACK_RATE"]},"com.wix.ecom.tax.api.ManualCalculationReason":{"type":"string","description":"","title":"ManualCalculationReason","enum":["GLOBAL_SETTING_TO_MANUAL","REGION_SETTING_TO_MANUAL"]},"com.wix.ecom.tax.api.AutoTaxFallbackCalculationDetails":{"type":"object","properties":{"fallbackReason":{"description":"reason for fallback","title":"fallbackReason","type":"string","$ref":"#/components/schemas/com.wix.ecom.tax.api.AutoTaxFallbackCalculationDetails.FallbackReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AutoTaxFallbackCalculationDetails","description":""},"com.wix.ecom.tax.api.AutoTaxFallbackCalculationDetails.FallbackReason":{"type":"string","description":"","title":"FallbackReason","enum":["AUTO_TAX_FAILED","AUTO_TAX_DEACTIVATED"]},"com.wix.ecom.totals_calculator.v1.AggregatedTaxBreakdown":{"type":"object","properties":{"taxName":{"description":"The name of the tax against which this tax amount was calculated.","maxLength":200,"title":"taxName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxType":{"description":"The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.","maxLength":200,"title":"taxType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"jurisdiction":{"description":"The name of the jurisdiction in which this tax detail applies.","maxLength":200,"title":"jurisdiction","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"jurisdictionTypeEnum":{"description":"The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).","title":"jurisdictionTypeEnum","type":"string","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.JurisdictionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rate":{"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)","title":"rate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","maxScale":6}}},"aggregatedTaxAmount":{"description":"The sum of all the tax from line items that calculated by the tax identifiers.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"aggregatedTaxAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregatedTaxBreakdown","description":"The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\nTax breakdown is the tax amount split to the tax authorities that applied on the line item."},"com.wix.ecommerce.platform_common.api.ChannelType":{"type":"string","description":"","title":"ChannelType","enum":["UNSPECIFIED","WEB","POS","EBAY","AMAZON","OTHER_PLATFORM","WIX_APP_STORE","WIX_INVOICES","BACKOFFICE_MERCHANT","WISH","CLASS_PASS","GLOBAL_E","FACEBOOK","ETSY","TIKTOK","FAIRE_COM"]},"com.wix.ecom.checkout.api.v1.CreatedBy":{"type":"object","properties":{},"title":"CreatedBy","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wix.ecom.checkout.api.v1.CreatedBy.id"}]},"com.wix.ecom.checkout.api.v1.CreatedBy.id":{"type":"object","title":"id","properties":{"userId":{"description":"User ID - when the order was created by a Wix user on behalf of a buyer.\nFor example, via POS (point of service).","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"Member ID - when the order was created by a **logged in** site visitor.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visitorId":{"description":"Visitor ID - when the order was created by a site visitor that was **not** logged in.","format":"GUID","title":"visitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"App ID - when the order was created by an external application or Wix service.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.checkout.api.v1.MembershipOptions":{"type":"object","properties":{"eligibleMemberships":{"description":"Reserved for internal use.","readOnly":true,"maxItems":300,"title":"eligibleMemberships","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.host.Membership"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"invalidMemberships":{"description":"Reserved for internal use.","readOnly":true,"maxItems":300,"title":"invalidMemberships","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.host.InvalidMembership"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"selectedMemberships":{"description":"Selected membership to apply to this checkout.","$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.host.SelectedMemberships","summary":"selectedMemberships","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipOptions","description":"Reserved for internal use."},"com.wix.ecom.memberships_spi.v1.host.Membership":{"type":"object","properties":{"id":{"description":"Membership ID.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the application providing this payment option.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"The name of this membership.","$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.MembershipName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemIds":{"description":"Line item IDs which are \"paid\" for by this membership.","minItems":1,"maxItems":300,"title":"lineItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"credits":{"description":"Optional - For a membership that has limited credits, information about credit usage.","$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.MembershipPaymentCredits","summary":"credits","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expirationDate":{"description":"Optional - TMembership expiry date.","title":"expirationDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"additionalData":{"description":"Additional data about this membership.","title":"additionalData","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Membership","description":""},"com.wix.ecom.memberships_spi.v1.MembershipName":{"type":"object","properties":{"original":{"description":"The name of this membership","maxLength":100,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Optional - Translated name of this membership. Defaults to `original` when not provided.","maxLength":100,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipName","description":""},"com.wix.ecom.memberships_spi.v1.MembershipPaymentCredits":{"type":"object","properties":{"total":{"description":"How much credit this membership has in total","minimum":1,"maximum":100000,"title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"remaining":{"description":"How much credit remained for this membership","minimum":0,"maximum":100000,"title":"remaining","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipPaymentCredits","description":""},"com.wix.ecom.memberships_spi.v1.host.InvalidMembership":{"type":"object","properties":{"membership":{"description":"Membership details.","$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.host.Membership","summary":"membership","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reason":{"description":"Reason why this membership is invalid and cannot be used.","minLength":1,"maxLength":100,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidMembership","description":""},"com.wix.ecom.memberships_spi.v1.host.SelectedMemberships":{"type":"object","properties":{"memberships":{"description":"Selected memberships.","maxItems":300,"title":"memberships","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.host.SelectedMembership"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SelectedMemberships","description":""},"com.wix.ecom.memberships_spi.v1.host.SelectedMembership":{"type":"object","properties":{"id":{"description":"Membership ID.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app providing this payment option.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemIds":{"description":"IDs of the line items this membership applies to.","minItems":1,"maxItems":300,"title":"lineItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SelectedMembership","description":""},"com.wix.ecom.totals_calculator.v1.AdditionalFee":{"type":"object","properties":{"code":{"description":"Additional fee's unique code (or ID) for future processing.","minLength":1,"maxLength":100,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Translated additional fee's name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Additional fee's price.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"price","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxDetails":{"description":"Tax details.","$ref":"#/components/schemas/com.wix.ecom.totals_calculator.v1.ItemTaxFullDetails","summary":"taxDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerAppId":{"description":"Provider's app id.","minLength":1,"maxLength":100,"title":"providerAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceBeforeTax":{"description":"Additional fee's price before tax.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"priceBeforeTax","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemIds":{"description":"Optional - Line items associated with this additional fee.\nIf no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.","format":"GUID","title":"lineItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AdditionalFee","description":""},"com.wix.ecom.checkout.api.v1.ConversionInfo":{"type":"object","properties":{"siteCurrency":{"description":"The site currency.","readOnly":true,"format":"CURRENCY","title":"siteCurrency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conversionRate":{"description":"The rate used when converting from the site currency to the checkout currency.","readOnly":true,"title":"conversionRate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","lte":"1000000000000000"}}}},"title":"ConversionInfo","description":""},"com.wix.ecommerce.validations_spi.v1.Violation":{"type":"object","properties":{"severity":{"description":"Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow.","title":"severity","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Violation.Severity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"target":{"description":"Target location on a checkout or cart page where the violation will be displayed.","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target","summary":"target","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`.","minLength":1,"maxLength":1000,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Violation","description":""},"com.wix.ecommerce.validations_spi.v1.Violation.Severity":{"type":"string","description":"","title":"Severity","enum":["WARNING","ERROR"]},"com.wix.ecommerce.validations_spi.v1.Target":{"type":"object","properties":{},"title":"Target","description":"","oneOf":[{"description":"","summary":"targetType","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target.targetType"}]},"com.wix.ecommerce.validations_spi.v1.Target.targetType":{"type":"object","title":"targetType","properties":{"other":{"description":"General (other) violation.","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target.Other","summary":"other","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItem":{"description":"Specific line item violation.","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target.LineItem","summary":"lineItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecommerce.validations_spi.v1.Target.NameInOther":{"type":"string","description":"Available locations on the webpage","title":"NameInOther","enum":["OTHER_DEFAULT"]},"com.wix.ecommerce.validations_spi.v1.Target.NameInLineItem":{"type":"string","description":"Available locations on the line item","title":"NameInLineItem","enum":["LINE_ITEM_DEFAULT"]},"com.wix.ecommerce.validations_spi.v1.Target.Other":{"type":"object","properties":{"name":{"description":"Location on a checkout or a cart page where a general (other) violation will be displayed.","title":"name","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target.NameInOther","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Other","description":"General (other) violation."},"com.wix.ecommerce.validations_spi.v1.Target.LineItem":{"type":"object","properties":{"name":{"description":"Location on a checkout or a cart page where the specific line item violation will be displayed.","title":"name","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.validations_spi.v1.Target.NameInLineItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"ID of the line item containing the violation.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItem","description":"Specific line item violation."},"com.wix.ecom.checkout.api.v1.CustomSettings":{"type":"object","properties":{"lockGiftCard":{"description":"Whether to restrict the option to add or remove a gift card on the checkout page.\n\nDefault: `false`","title":"lockGiftCard","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lockCouponCode":{"description":"Whether to restrict the option to add or remove a coupon code on the checkout page.\n\nDefault: `false`","title":"lockCouponCode","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomSettings","description":""},"wix.ecom.checkout_template.api.v1.CreateAndRedirectToCheckoutRequest":{"type":"object","properties":{"checkoutTemplateId":{"description":"ID of the checkout template to use to create a checkout.","format":"GUID","title":"checkoutTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"ID of the site associated with the checkout template.","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateAndRedirectToCheckoutRequest","description":""},"com.wixpress.rest.RawHttpResponse":{"type":"object","properties":{"body":{"description":"","title":"body","type":"bytes","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"statusCode":{"description":"","title":"statusCode","type":"integer","format":"uint32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"headers":{"description":"","title":"headers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.rest.HeadersEntry"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RawHttpResponse","description":""},"google.protobuf.UInt32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt32Value","description":""},"com.wixpress.rest.HeadersEntry":{"type":"object","properties":{"key":{"description":"","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HeadersEntry","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Checkout Template","description":"A checkout template can be shared with customers to create checkouts with predefined information already included.","fqdn":"wix.ecom.v1.checkout_template"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the eCommerce Checkout Templates API\n\nThe 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.\n\nWith the Checkout Templates API, you can:\n+ Run a sale on a specific product for a limited time\n+ Customize the checkout experience\n\n\n## Before you Begin\n\nIt’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.\n\n# Use Cases\n\n+ [Run a flash sale through social media](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::sample-flows*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/sample-flows)\n+ [Limit the number of checkouts for a specific coupon](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::sample-flows*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/sample-flows)\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Checkout Templates: Sample Use Case & Flow\nThis article shares some possible use cases your app could support, as well as an sample flow that could support each\nuse case. This can be a helpful jumping off point as you plan your app's implementation.\n\n## Run a flash sale through social media\nOffer 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.\n\nTo create and share the offer:\n\n1. Use [Create Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::create-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/create-checkout-template) with the product and coupon information for offer.\n2. 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}`.\n3. Post and share the URL to customers.\n\nTo turn off the offer at the end of the sale:\n\n1. Use [Update Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::update-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/update-checkout-template) to update `checkoutTemplate.status` to `INACTIVE`.\n\n## Limit the number of checkouts for a specific coupon\nOffer 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.\n\nCreate a checkout template and add your own custom logic:\n\n1. Use [Create Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::create-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/create-checkout-template) with the product and coupon information for offer.\n2. Create a bank of all new checkouts for this sale by collecting the `checkoutId`s of checkouts created from this `checkoutTemplateId`.\n3. Before a new checkout is created with the `checkoutTemplateId`, check the bank and count the number of `checkoutId`s being stored.\n4. Once the count hits `100` checkouts, use [Update Checkout Template](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::189422e5-0053-44f4-9358-82cb20b97f90slug::update-checkout-template*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout-templates/update-checkout-template) to update `checkoutTemplate.status` to `INACTIVE`.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Get Checkout Template

Permission Scopes