{"id":"102c7288-c90b-41a3-9ccf-e61066825d05","createdDate":"2024-03-07T13:39:52.907Z","updatedDate":"2024-03-07T13:39:52.907Z","resourceId":"8cd4a233-1cc5-4a34-aa56-67f7aaca2a53","api":{"schema":{"object":{"displayName":"Cart Object","description":"Read and Write carts from Wix Stores, produce cart lifecycle events","slug":"cart-object","$ref":"#/components/schemas/wix.cart.api.v1.Cart","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Get Cart","description":"Get a cart by ID.\n\n

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[Get Cart](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/get-cart)\nand will be removed on September 4, 2024.\n\nTo help with migration from the Stores Cart API to the eCommerce Cart API, refer to the [Cart Conversion Table](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/cart-object-conversion) for field changes in name and/or location.\n\n

","operationId":"wix.cart.api.v1.Carts.Get","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Cart ID","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.cart.api.v1.GetResponse","description":""}},"deprecated":true,"servers":[],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.cart.api.v1.Carts","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_CARTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-cart-services-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-cart-services-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.cart.api.v1.GetRequest","responseMessage":"wix.cart.api.v1.GetResponse"},"deprecated":{"replacedBy":"GetCart","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"Get","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/stores/v1/carts/6000dbd9-cb49-4066-820e-2d95cb1e228b' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"cart\": {\n \"id\": \"6000dbd9-cb49-4066-820e-2d95cb1e228b\",\n \"status\": \"COMPLETE\",\n \"weightUnit\": \"LB\",\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"convertedCurrency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10001\",\n \"addressLine\": \"123123\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"0548799654\",\n \"email\": \"johndoe@anydomain.com\"\n }\n },\n \"totals\": {\n \"subtotal\": 50.0,\n \"shipping\": 0.0,\n \"tax\": 0.0,\n \"discount\": 0.0,\n \"total\": 50.0,\n \"weight\": 0.0,\n \"quantity\": 2\n },\n \"convertedTotals\": {\n \"subtotal\": 50.0,\n \"shipping\": 0.0,\n \"tax\": 0.0,\n \"discount\": 0.0,\n \"total\": 50.0,\n \"weight\": 0.0,\n \"quantity\": 2\n },\n \"shippingInfo\": {\n \"shippingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10001\",\n \"addressLine\": \"123123\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"0548799654\",\n \"email\": \"johndoe@anydomain.com\"\n }\n }\n },\n \"buyerInfo\": {\n \"id\": \"d24e958a-85f7-4bea-1f75-4d7678a42019\",\n \"identityType\": \"MEMBER\",\n \"email\": \"johndoe@anydomain.com\",\n \"phone\": \"0548799654\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n },\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"25.00\",\n \"name\": \"Gadget\",\n \"productId\": \"d956c56d-4fc7-9420-480e-ae6544287fff\",\n \"totalPrice\": \"50.00\",\n \"lineItemType\": \"DIGITAL\",\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/8ed856_a70af7fc0eca9f1ab5b5c966b5274b79~mv2.gif/v1/fit/w_322,h_322,q_90/file.webp\",\n \"width\": 322,\n \"height\": 322\n },\n \"sku\": \"5678\",\n \"options\": [],\n \"id\" : 1\n }\n ]\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/carts/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.cart.api.v1.Carts","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_CARTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-cart-services-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-cart-services-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.cart.api.v1.GetRequest","responseMessage":"wix.cart.api.v1.GetResponse"},"legacyExamples":[{"name":"Get","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/stores/v1/carts/6000dbd9-cb49-4066-820e-2d95cb1e228b' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"cart\": {\n \"id\": \"6000dbd9-cb49-4066-820e-2d95cb1e228b\",\n \"status\": \"COMPLETE\",\n \"weightUnit\": \"LB\",\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"convertedCurrency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10001\",\n \"addressLine\": \"123123\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"0548799654\",\n \"email\": \"johndoe@anydomain.com\"\n }\n },\n \"totals\": {\n \"subtotal\": 50.0,\n \"shipping\": 0.0,\n \"tax\": 0.0,\n \"discount\": 0.0,\n \"total\": 50.0,\n \"weight\": 0.0,\n \"quantity\": 2\n },\n \"convertedTotals\": {\n \"subtotal\": 50.0,\n \"shipping\": 0.0,\n \"tax\": 0.0,\n \"discount\": 0.0,\n \"total\": 50.0,\n \"weight\": 0.0,\n \"quantity\": 2\n },\n \"shippingInfo\": {\n \"shippingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10001\",\n \"addressLine\": \"123123\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"0548799654\",\n \"email\": \"johndoe@anydomain.com\"\n }\n }\n },\n \"buyerInfo\": {\n \"id\": \"d24e958a-85f7-4bea-1f75-4d7678a42019\",\n \"identityType\": \"MEMBER\",\n \"email\": \"johndoe@anydomain.com\",\n \"phone\": \"0548799654\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n },\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"25.00\",\n \"name\": \"Gadget\",\n \"productId\": \"d956c56d-4fc7-9420-480e-ae6544287fff\",\n \"totalPrice\": \"50.00\",\n \"lineItemType\": \"DIGITAL\",\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/8ed856_a70af7fc0eca9f1ab5b5c966b5274b79~mv2.gif/v1/fit/w_322,h_322,q_90/file.webp\",\n \"width\": 322,\n \"height\": 322\n },\n \"sku\": \"5678\",\n \"options\": [],\n \"id\" : 1\n }\n ]\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Cart","slugifiedName":"get-cart"},"deprecationDetails":{"replacedBy":"GetCart","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Get Cart Checkout Url","description":"Get a cart's checkout URL by ID.\n\n

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[Get Checkout URL](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/get-checkout-url)\nand will be removed on September 4, 2024.\n\n

","operationId":"wix.cart.api.v1.Carts.GetCartCheckoutUrl","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"The requested cart ID to checkout","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.cart.api.v1.GetCartCheckoutUrlResponse","description":""}},"deprecated":true,"servers":[],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.cart.api.v1.Carts","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_CARTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-cart-services-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-cart-services-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.cart.api.v1.GetCartCheckoutUrlRequest","responseMessage":"wix.cart.api.v1.GetCartCheckoutUrlResponse"},"deprecated":{"replacedBy":"GetCheckoutURL","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"GetCartCheckoutUrl","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/stores/v1/carts/6000dbd9-cb49-4066-820e-2d95cb1e228b/checkoutUrl' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"url\": \"https://somesite.wixsite.com/website/checkout?appSectionParams=%7B%22a11y%22%3Afalse%2C%22cartId%22%3A%6000dbd9-cb49-4066-820e-2d95cb1e228b%22%2C%22storeUrl%22%3A%22https%3A%2F%2Fsomesite.wixsite.com%2Fwebsite%22%2C%22isFastFlow%22%3Afalse%2C%22isPickupFlow%22%3Afalse%7D&linkSource=acMail\"\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/carts/{id}/checkoutUrl","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.cart.api.v1.Carts","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_CARTS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-cart-services-api","serviceArtifactId":"com.wixpress.ecommerce.wix-ecommerce-cart-services-web","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.cart.api.v1.GetCartCheckoutUrlRequest","responseMessage":"wix.cart.api.v1.GetCartCheckoutUrlResponse"},"legacyExamples":[{"name":"GetCartCheckoutUrl","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/stores/v1/carts/6000dbd9-cb49-4066-820e-2d95cb1e228b/checkoutUrl' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"url\": \"https://somesite.wixsite.com/website/checkout?appSectionParams=%7B%22a11y%22%3Afalse%2C%22cartId%22%3A%6000dbd9-cb49-4066-820e-2d95cb1e228b%22%2C%22storeUrl%22%3A%22https%3A%2F%2Fsomesite.wixsite.com%2Fwebsite%22%2C%22isFastFlow%22%3Afalse%2C%22isPickupFlow%22%3Afalse%7D&linkSource=acMail\"\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Cart Checkout Url","slugifiedName":"get-cart-checkout-url"},"deprecationDetails":{"replacedBy":"GetCheckoutURL","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true}],"webhooks":[{"summary":"Cart Created Event","title":"Cart Cart Created Event","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with the\n[Cart Created Webhook](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/cart-created)\nand will be removed on September 4, 2024.\n\nTo help with migration from the Stores Cart API to the eCommerce Cart API, refer to the [Cart Conversion Table](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/cart-object-conversion) for field changes in name and/or location.\n\n

","permissions":["WIX_STORES.READ_CARTS"],"payload":{"schemaName":"wix.cart.api.v1.CartCreatedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"cart_created_event","eventTopic":"wixStores-cart-created","serviceName":"wix.cart.api.v1.Carts","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.cart.api.v1.CartCreatedEvent","legacyExamples":[{"name":"Cart Created Event","type":"LEGACY_EVENT","content":"{\n \"cartId\": \"808b0f9c-730d-466a-8cbd-320996f659ef\",\n \"weightUnit\": \"LB\",\n \"buyerInfo\": {\n \"email\": \"johndeo@anydomain.com\",\n \"firstName\": \"John\",\n \"id\": \"d11e902a-38f7-4bea-9f75-4d7678a47015\",\n \"identityType\": \"MEMBER\",\n \"lastName\": \"Doe\",\n \"phone\": \"0548799654\"\n },\n \"currency\": {\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"totals\": {\n \"discount\": 0,\n \"quantity\": 1,\n \"subtotal\": 100,\n \"total\": 100\n },\n \"creationTime\": \"2020-08-12T08:07:47.281Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.cart.api.v1.CartCreatedEvent","contentLink":{"displayName":"Cart Created Event","slugifiedName":"cart-created-event"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Cart Completed Event","title":"Cart Cart Completed Event","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with the\n[Checkout Marked As Completed Webhook](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/checkout-marked-as-completed)\nand will be removed on September 4, 2024.\n\nTo help with migration from the Stores Cart API to the eCommerce Checkout API, refer to the [Conversion Table](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/stores-cart-to-e-commerce-checkout-object-conversion) for field changes in name and/or location.\n\n

","permissions":["WIX_STORES.READ_CARTS"],"payload":{"schemaName":"wix.cart.api.v1.CartCompletedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"cart_completed_event","eventTopic":"wixStores-cart-completed","serviceName":"wix.cart.api.v1.Carts","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"com.wix.ecommerce.cart.api.v1.CartCompletedEvent","legacyExamples":[{"name":"Cart Completed Event","type":"LEGACY_EVENT","content":"{\n \"cartId\": \"2bd3c22c-4776-419f-ad4f-ad207465a0a8\",\n \"completedTime\": \"2020-08-11T13:04:51.009Z\",\n \"buyerInfo\": {\n \"id\": \"d11e902a-38f7-4bea-9f75-4d7678a47015\",\n \"identityType\": \"MEMBER\",\n \"email\": \"johndoe@anydomain.com\",\n \"phone\": \"515-522-4422\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n },\n \"weightUnit\": \"LB\",\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-IA\",\n \"city\": \"New York\",\n \"postalCode\": \"10011\",\n \"addressLine\": \"235 W 23rd St\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"515-522-4422\",\n \"email\": \"johndoe@anydomain.com\"\n }\n },\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"totals\": {\n \"subtotal\": 25,\n \"discount\": 0,\n \"total\": 25,\n \"quantity\": 1\n },\n \"shippingInfo\": {\n \"shippingRuleDetails\": {\n \"ruleId\": \"00000000-0000-0000-0000-000000000001\",\n \"optionId\": \"1\",\n \"deliveryOption\": \"Standard Shipping\"\n },\n \"shippingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-IA\",\n \"city\": \"New York\",\n \"postalCode\": \"10011\",\n \"addressLine\": \"235 W 23rd St\"\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"515-522-4422\",\n \"email\": \"johndoe@anydomain.com\"\n }\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.cart.api.v1.CartCompletedEvent","contentLink":{"displayName":"Cart Completed Event","slugifiedName":"cart-completed-event"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"## About The Stores Carts API\n\nThe Wix Stores Cart API allows for retrieving a cart and listening to events when a cart is created or completed.\n\n

\n\n__Deprecation Notice:__\n\nStores Carts API has been replaced with\n[eCommerce Cart API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::958a4dc3-8e6f-4827-bd1e-cf16a4712ac6slug::introduction*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/introduction)\nand will be removed on September 4, 2024.\n\nTo help with migration from the Stores Cart API to the eCommerce Cart API, refer to the [Cart Conversion Table](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::958a4dc3-8e6f-4827-bd1e-cf16a4712ac6slug::cart-object-conversion*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/cart-object-conversion) for field changes in name and/or location.\n\n

","sourceRepo":"git@github.com:wix-private/ecom.git","path":"appendices/docs/introduction.md"}],"components":{"schemas":{"wix.cart.api.v1.Cart":{"type":"object","properties":{"id":{"description":"Cart ID, generated from customer identity","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"description":"Cart status can be INCOMPLETE, COMPLETE","title":"status","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.CartStatus","x-wix-docs":{"exposure":"PUBLIC"}},"weightUnit":{"description":"Weight unit used in this store","title":"weightUnit","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.WeightUnit","x-wix-docs":{"exposure":"PUBLIC"}},"buyerNote":{"description":"Message from the customer","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for pricing in this store","$ref":"#/components/schemas/wix.cart.api.v1.Currency","summary":"currency","x-wix-docs":{"exposure":"PUBLIC"}},"convertedCurrency":{"description":"Conversion currency used for pricing in this store","readOnly":true,"$ref":"#/components/schemas/wix.cart.api.v1.Currency","summary":"convertedCurrency","x-wix-docs":{"exposure":"PUBLIC"}},"billingAddress":{"description":"Customer's billing address","$ref":"#/components/schemas/wix.cart.api.v1.CartAddress","summary":"billingAddress","x-wix-docs":{"exposure":"PUBLIC"}},"appliedCoupon":{"description":"Coupon applied to the cart","$ref":"#/components/schemas/wix.cart.api.v1.AppliedCoupon","summary":"appliedCoupon","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"description":"Order totals","$ref":"#/components/schemas/wix.cart.api.v1.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC"}},"convertedTotals":{"description":"Converted Order totals","readOnly":true,"$ref":"#/components/schemas/wix.cart.api.v1.Totals","summary":"convertedTotals","x-wix-docs":{"exposure":"PUBLIC"}},"shippingInfo":{"description":"Cart shipping information","$ref":"#/components/schemas/wix.cart.api.v1.ShippingInfo","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Customer's Wix ID","$ref":"#/components/schemas/wix.cart.api.v1.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"lineItems":{"description":"Line items ordered","minItems":1,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/wix.cart.api.v1.LineItem"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cart","description":""},"wix.cart.api.v1.CartStatus":{"type":"string","description":"","title":"CartStatus","enum":["INCOMPLETE","COMPLETE"]},"wix.cart.api.v1.WeightUnit":{"type":"string","description":"","title":"WeightUnit","enum":["UNSPECIFIED_WEIGHT_UNIT","KG","LB"]},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"wix.cart.api.v1.Currency":{"type":"object","properties":{"code":{"description":"Currency code","maxLength":3,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"symbol":{"description":"Currency symbol","title":"symbol","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Currency","description":""},"wix.cart.api.v1.CartAddress":{"type":"object","properties":{"address":{"description":"Address","$ref":"#/components/schemas/wix.common.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC"}},"contactDetails":{"description":"Contact details","$ref":"#/components/schemas/wix.common.FullAddressContactDetails","summary":"contactDetails","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CartAddress","description":""},"wix.common.Address":{"type":"object","properties":{"country":{"description":"Country code.","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"description":"Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).","title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"description":"City name.","title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"postalCode":{"description":"Zip/postal code.","title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine2":{"description":"Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.","title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":"Physical address","oneOf":[{"description":"","summary":"street","$ref":"#/components/schemas/wix.common.Address.street"}]},"wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"description":"Street name and number.","$ref":"#/components/schemas/wix.common.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine":{"description":"Main address line, usually street and number as free text.","title":"addressLine","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.StreetAddress":{"type":"object","properties":{"number":{"description":"Street number.","title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Street name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StreetAddress","description":""},"wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"description":"Address latitude.","title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"description":"Address longitude.","title":"longitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DoubleValue","description":""},"wix.common.Subdivision":{"type":"object","properties":{"code":{"description":"Short subdivision code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Subdivision full name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Subdivision","description":""},"wix.common.Subdivision.SubdivisionType":{"type":"string","description":"","title":"SubdivisionType","enum":["UNKNOWN_SUBDIVISION_TYPE","ADMINISTRATIVE_AREA_LEVEL_1","ADMINISTRATIVE_AREA_LEVEL_2","ADMINISTRATIVE_AREA_LEVEL_3","ADMINISTRATIVE_AREA_LEVEL_4","ADMINISTRATIVE_AREA_LEVEL_5","COUNTRY"]},"wix.common.FullAddressContactDetails":{"type":"object","properties":{"firstName":{"description":"Contact's first name.","title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"description":"Contact's last name.","title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Contact's phone number.","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"company":{"description":"Contact's company name.","title":"company","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Email associated with the address.","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"vatId":{"description":"Tax info. Currently usable only in Brazil.","$ref":"#/components/schemas/wix.common.VatId","summary":"vatId","x-wix-docs":{"exposure":"PUBLIC"}}},"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"}},"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"}}},"title":"VatId","description":""},"wix.common.VatType":{"type":"string","description":"tax info types","title":"VatType","enum":["UNSPECIFIED","CPF","CNPJ"]},"wix.cart.api.v1.AppliedCoupon":{"type":"object","properties":{"couponId":{"description":"Coupon internal ID","format":"GUID","title":"couponId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Coupon name","maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"code":{"description":"Coupon code","maxLength":50,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"discountValue":{"description":"Discount value","title":"discountValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"convertedDiscountValue":{"description":"Converted discount value","title":"convertedDiscountValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"couponType":{"description":"Type (e.g., moneyOff, percentOff)","maxLength":50,"title":"couponType","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AppliedCoupon","description":""},"wix.cart.api.v1.Totals":{"type":"object","properties":{"subtotal":{"description":"Subtotal of all line items, before tax","minimum":0,"maximum":999999999.99,"title":"subtotal","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"shipping":{"description":"Total shipping price, including tax","minimum":0,"maximum":999999999.99,"title":"shipping","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Total tax","minimum":0,"maximum":999999999.99,"title":"tax","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Total calculated discount value, according to order.discount","title":"discount","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"description":"Total price","minimum":0,"maximum":999999999.99,"title":"total","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"weight":{"description":"Total items weight","minimum":0,"maximum":999999999.99,"title":"weight","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Total line items quantity","minimum":0,"maximum":999999999.99,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Totals","description":""},"wix.cart.api.v1.ShippingInfo":{"type":"object","properties":{"shippingRuleDetails":{"description":"Selected shipping rule details","$ref":"#/components/schemas/wix.cart.api.v1.ShippingRuleDetails","summary":"shippingRuleDetails","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShippingInfo","description":"","oneOf":[{"description":"","summary":"details","$ref":"#/components/schemas/wix.cart.api.v1.ShippingInfo.details"}]},"wix.cart.api.v1.ShippingInfo.details":{"type":"object","title":"details","properties":{"pickupDetails":{"description":"Pickup details when this object describes pickup","$ref":"#/components/schemas/wix.cart.api.v1.PickupDetails","summary":"pickupDetails","x-wix-docs":{"exposure":"PUBLIC"}},"shippingAddress":{"description":"Shipment details when this object describes shipment","$ref":"#/components/schemas/wix.cart.api.v1.CartAddress","summary":"shippingAddress","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.cart.api.v1.ShippingRuleDetails":{"type":"object","properties":{"ruleId":{"description":"Selected shipping rule ID","format":"GUID","title":"ruleId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"optionId":{"description":"Selected option ID","title":"optionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"deliveryOption":{"description":"Rule title (as provided by the store owner)","maxLength":100,"title":"deliveryOption","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"estimatedDeliveryTime":{"description":"Shipping option delivery time","maxLength":500,"title":"estimatedDeliveryTime","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShippingRuleDetails","description":""},"wix.cart.api.v1.PickupDetails":{"type":"object","properties":{"pickupAddress":{"description":"Pickup address","$ref":"#/components/schemas/wix.common.Address","summary":"pickupAddress","x-wix-docs":{"exposure":"PUBLIC"}},"buyerDetails":{"description":"Customer details","$ref":"#/components/schemas/wix.cart.api.v1.BuyerDetails","summary":"buyerDetails","x-wix-docs":{"exposure":"PUBLIC"}},"pickupInstructions":{"description":"Store owner's pickup instructions","maxLength":1000,"title":"pickupInstructions","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PickupDetails","description":""},"wix.cart.api.v1.BuyerDetails":{"type":"object","properties":{"firstName":{"description":"Customer's first name","title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"description":"Customer's last name","title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Email address","maxLength":50,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Phone number","maxLength":30,"format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerDetails","description":""},"wix.cart.api.v1.BuyerInfo":{"type":"object","properties":{"id":{"description":"Customer details","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"identity_Type":{"description":"Customer's relationship to the website","title":"identity_Type","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.BuyerInfo.IdentityType","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Customer's email address","maxLength":50,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Customer's phone number","format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"firstName":{"description":"Customer's first name","title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"description":"Customer's last name","title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerInfo","description":"This might expand and add additional data"},"wix.cart.api.v1.BuyerInfo.IdentityType":{"type":"string","description":"","title":"IdentityType","enum":["ADMIN","MEMBER","VISITOR","CONTACT"]},"wix.cart.api.v1.LineItem":{"type":"object","properties":{"id":{"description":"Cart line item ID","title":"id","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"productId":{"description":"Line item product ID (optional for POS orders)","format":"GUID","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Line item name","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Line item quantity","minimum":1,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"weight":{"description":"Line item weight","format":"DECIMAL_VALUE","title":"weight","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sku":{"description":"Line item SKU","maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lineItemType":{"description":"Line item type","title":"lineItemType","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.LineItem.LineItemType","x-wix-docs":{"exposure":"PUBLIC"}},"notes":{"description":"Line item notes","maxLength":1000,"title":"notes","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"customTextFields":{"description":"Line item custom text field selections","title":"customTextFields","type":"array","items":{"$ref":"#/components/schemas/wix.cart.api.v1.CustomTextFieldSelection"},"x-wix-docs":{"exposure":"PUBLIC"}},"mediaItem":{"description":"Line item's primary media for preview","$ref":"#/components/schemas/wix.cart.api.v1.MediaItem","summary":"mediaItem","x-wix-docs":{"exposure":"PUBLIC"}},"options":{"description":"Line item options ordered","title":"options","type":"array","items":{"$ref":"#/components/schemas/wix.cart.api.v1.OptionSelection"},"x-wix-docs":{"exposure":"PUBLIC"}},"convertedPriceData":{"description":"Line item converted price data","readOnly":true,"$ref":"#/components/schemas/wix.cart.api.v1.LineItemPriceData","summary":"convertedPriceData","x-wix-docs":{"exposure":"PUBLIC"}},"priceData":{"description":"Line item price data","$ref":"#/components/schemas/wix.cart.api.v1.LineItemPriceData","summary":"priceData","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"description":"Deprecated (use priceData)","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"totalPrice":{"description":"Deprecated (use priceData)","format":"DECIMAL_VALUE","title":"totalPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}}},"title":"LineItem","description":""},"wix.cart.api.v1.LineItem.LineItemType":{"type":"string","description":"","title":"LineItemType","enum":["UNSPECIFIED","PHYSICAL","DIGITAL","CUSTOM_AMOUNT_ITEM"]},"wix.cart.api.v1.CustomTextFieldSelection":{"type":"object","properties":{"title":{"description":"Custom text field name","maxLength":50,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"value":{"description":"Custom text field value","maxLength":16000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CustomTextFieldSelection","description":""},"wix.cart.api.v1.MediaItem":{"type":"object","properties":{"mediaType":{"description":"Media type","title":"mediaType","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.MediaItemType","x-wix-docs":{"exposure":"PUBLIC"}},"url":{"description":"Media URL","format":"WEB_URL","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"width":{"description":"Media item width","minimum":0,"maximum":5000,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"height":{"description":"Media item height","minimum":0,"maximum":5000,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MediaItem","description":""},"wix.cart.api.v1.MediaItemType":{"type":"string","description":"","title":"MediaItemType","enum":["UNSPECIFIED_MEDIA_TYPE_ITEM","IMAGE"]},"wix.cart.api.v1.OptionSelection":{"type":"object","properties":{"option":{"description":"Option name","maxLength":50,"title":"option","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"selection":{"description":"Selected choice for this option","maxLength":16000,"title":"selection","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OptionSelection","description":""},"wix.cart.api.v1.LineItemPriceData":{"type":"object","properties":{"price":{"description":"Line item price","minimum":0,"maximum":999999999.99,"title":"price","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"totalPrice":{"description":"Total price charged to the customer (for all line items) after computation of quantity and discount","minimum":0,"maximum":999999999.99,"title":"totalPrice","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItemPriceData","description":""},"wix.cart.api.v1.CartCreatedEvent":{"type":"object","properties":{"cartId":{"description":"","format":"GUID","title":"cartId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"creationTime":{"description":"Time the cart was created","readOnly":true,"title":"creationTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Customer's wix ID","$ref":"#/components/schemas/wix.cart.api.v1.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"weightUnit":{"description":"Weight unit used in this store","title":"weightUnit","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.WeightUnit","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for pricing in this store","$ref":"#/components/schemas/wix.cart.api.v1.Currency","summary":"currency","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"description":"Totals for order's line items","$ref":"#/components/schemas/wix.cart.api.v1.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CartCreatedEvent","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.cart.api.v1.CartCompletedEvent":{"type":"object","properties":{"cartId":{"description":"","format":"GUID","title":"cartId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"completedTime":{"description":"Time the cart was created","readOnly":true,"title":"completedTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Customer's Wix ID","$ref":"#/components/schemas/wix.cart.api.v1.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"weightUnit":{"description":"Weight unit used in this store","title":"weightUnit","type":"string","$ref":"#/components/schemas/wix.cart.api.v1.WeightUnit","x-wix-docs":{"exposure":"PUBLIC"}},"buyerNote":{"description":"Message from the customer","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"billingAddress":{"description":"Customer's billing address","$ref":"#/components/schemas/wix.cart.api.v1.CartAddress","summary":"billingAddress","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for pricing in this store","$ref":"#/components/schemas/wix.cart.api.v1.Currency","summary":"currency","x-wix-docs":{"exposure":"PUBLIC"}},"appliedCoupon":{"description":"Coupon applied to this cart","$ref":"#/components/schemas/wix.cart.api.v1.AppliedCoupon","summary":"appliedCoupon","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"description":"Totals for order's line items","$ref":"#/components/schemas/wix.cart.api.v1.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC"}},"shippingInfo":{"description":"Cart shipping information","$ref":"#/components/schemas/wix.cart.api.v1.ShippingInfo","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CartCompletedEvent","description":"This webhook is triggered when a customer has completed their checkout. In most cases, an order will be created immediately and an Order Event webhook will also be triggered. In some cases, the payment provider may list the order as \"pending\" - and the order will not be created until the payment is listed as \"approved.\""},"wix.cart.api.v1.GetMyCartRequest":{"type":"object","properties":{},"title":"GetMyCartRequest","description":""},"wix.cart.api.v1.GetMyCartResponse":{"type":"object","properties":{"cart":{"description":"The requested cart","$ref":"#/components/schemas/wix.cart.api.v1.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetMyCartResponse","description":""},"wix.cart.api.v1.GetCurrentCartRequest":{"type":"object","properties":{},"title":"GetCurrentCartRequest","description":""},"wix.cart.api.v1.GetCurrentCartResponse":{"type":"object","properties":{"cart":{"description":"The requested cart","$ref":"#/components/schemas/wix.cart.api.v1.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCurrentCartResponse","description":""},"wix.cart.api.v1.GetRequest":{"type":"object","properties":{"id":{"description":"Cart ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetRequest","description":""},"wix.cart.api.v1.GetResponse":{"type":"object","properties":{"cart":{"description":"Cart details","$ref":"#/components/schemas/wix.cart.api.v1.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetResponse","description":""},"wix.cart.api.v1.GetCartCheckoutUrlRequest":{"type":"object","properties":{"id":{"description":"The requested cart ID to checkout","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCartCheckoutUrlRequest","description":""},"wix.cart.api.v1.GetCartCheckoutUrlResponse":{"type":"object","properties":{"url":{"description":"","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCartCheckoutUrlResponse","description":""},"wix.cart.api.v1.CreateVolatileCartRequest":{"type":"object","properties":{"productId":{"description":"Line item product ID","format":"GUID","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"optionSelectionId":{"description":"Line item options ordered","title":"optionSelectionId","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC"}},"customTextFieldSelection":{"description":"Line item's custom text field selections","title":"customTextFieldSelection","type":"array","items":{"$ref":"#/components/schemas/wix.cart.api.v1.CustomTextFieldSelection"},"x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Line item's quantity","minimum":1,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"buyerNote":{"description":"Message from the customer","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subscriptionOptionId":{"description":"subscription option id: optional, must be provided only when need to create subscription","format":"GUID","title":"subscriptionOptionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateVolatileCartRequest","description":""},"wix.cart.api.v1.CreateVolatileCartResponse":{"type":"object","properties":{"cart":{"description":"The new cart","$ref":"#/components/schemas/wix.cart.api.v1.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateVolatileCartResponse","description":""},"wix.cart.api.v1.DeleteCartRequest":{"type":"object","properties":{"id":{"description":"Cart ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteCartRequest","description":""},"wix.cart.api.v1.DeleteCartResponse":{"type":"object","properties":{},"title":"DeleteCartResponse","description":""},"wix.cart.api.v1.AddCustomItemsRequest":{"type":"object","properties":{"id":{"description":"Cart ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"customItems":{"description":"Custom Items","title":"customItems","type":"array","items":{"$ref":"#/components/schemas/wix.cart.api.v1.CustomItem"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddCustomItemsRequest","description":""},"wix.cart.api.v1.CustomItem":{"type":"object","properties":{"name":{"description":"Name","minLength":1,"maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"Amount","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"quantity":{"description":"Quantity","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"note":{"description":"Note","minLength":1,"maxLength":1000,"title":"note","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CustomItem","description":""},"wix.cart.api.v1.AddCustomItemsResponse":{"type":"object","properties":{"cart":{"description":"","$ref":"#/components/schemas/wix.cart.api.v1.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddCustomItemsResponse","description":""},"wix.cart.api.v1.GetDestinationCompletenessRequest":{"type":"object","properties":{"address":{"description":"Address","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetDestinationCompletenessRequest","description":""},"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"}},"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"}},"city":{"description":"City name.","maxLength":50,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"postalCode":{"description":"Postal or zip code.","maxLength":50,"title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"streetAddress":{"description":"Street address.","$ref":"#/components/schemas/wix.common.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine":{"description":"Main address line (usually street name and number).","maxLength":150,"title":"addressLine","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"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"}},"countryFullname":{"description":"Country's full name.","readOnly":true,"title":"countryFullname","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivisionFullname":{"description":"Subdivision full-name.","readOnly":true,"title":"subdivisionFullname","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":"Physical address"},"wix.cart.api.v1.GetDestinationCompletenessResponse":{"type":"object","properties":{"destinationLevels":{"description":"","title":"destinationLevels","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetDestinationCompletenessResponse","description":""}}},"title":"Cart","description":"Read and Write carts from Wix Stores, produce cart lifecycle events","fqdn":"wix.cart.api.v1.cart"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"## About The Stores Carts API\n\nThe Wix Stores Cart API allows for retrieving a cart and listening to events when a cart is created or completed.\n\n

\n\n__Deprecation Notice:__\n\nStores Carts API has been replaced with\n[eCommerce Cart API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::958a4dc3-8e6f-4827-bd1e-cf16a4712ac6slug::introduction*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/introduction)\nand will be removed on September 4, 2024.\n\nTo help with migration from the Stores Cart API to the eCommerce Cart API, refer to the [Cart Conversion Table](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::958a4dc3-8e6f-4827-bd1e-cf16a4712ac6slug::cart-object-conversion*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/api-reference/wix-e-commerce/cart/cart-object-conversion) for field changes in name and/or location.\n\n

"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}