{"id":"d888d5ff-94ef-40d7-81d1-846967615de4","createdDate":"2024-07-25T04:09:55.036Z","updatedDate":"2024-07-25T04:09:55.036Z","resourceId":"deb61afb-94d1-482e-8f47-c4a3a36b1d02","api":{"schema":{"object":{"displayName":"Coupon Object","description":"The `Coupon` object represents all information available for a coupon\nincluding its basic definition and runtime information.","slug":"coupon-object","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create A Coupon","description":"Creates a new coupon.\n\nWhen creating a coupon, the `specification` object must contain values for `name`, `code`, `startTime`,\nand either `scope` or `minimumSubtotal`. The exception is for a `freeShipping` coupon type, for which you cannot apply\na `scope` and `minimumSubtotal` is optional.\n\nThe coupon `scope` defines the items a coupon applies to. A coupon can apply to all items in a specific Wix application,\na group within the application, or a single item within a group.\nSee [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).\n\nThe `specification` object must also contain a value for exactly 1 of the following coupon properties.\nThis defines the coupon type.\n\n+ `\"moneyOffAmount\"`\n+ `\"percentOffRate\"`\n+ `\"freeShipping\"`\n+ `\"fixedPriceAmount\"`\n+ `\"buyXGetY\"`","operationId":"wix.coupons.api.v2.CouponsV2.Create","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.CreateCouponResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/coupons","destinationPath":"/v2/coupons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCouponRequest","description":"","properties":{"specification":{"description":"Coupon to create.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"specification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Coupon Created","description":"Triggered when a coupon is created.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.CreateCouponRequest","responseMessage":"wix.coupons.api.v2.CreateCouponResponse"},"legacyExamples":[{"name":"Create","type":"METHOD","order":2,"content":{"title":"Create a \"moneyOffAmount\" coupon that applies to all the bookings services","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"Discount\",\n \"code\":\"ABCD\",\n \"active\":true,\n \"startTime\":1554126066895,\n \"scope\":{\n \"namespace\":\"bookings\"\n },\n \"moneyOffAmount\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":3,"content":{"title":"Create a \"freeShipping\" coupon that applies to a minimum subtotal","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"FreeShipping\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126275300,\n \"minimumSubtotal\":5,\n \"limitedToOneItem\":true,\n \"freeShipping\":true\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":5,"content":{"title":"Create a \"percentOffRate\" coupon that applies to all event tickets","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"111\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126716133,\n \"scope\":{\n \"namespace\":\"events\",\n \"group\":{\n \"name\":\"ticket\"\n }\n },\n \"limitedToOneItem\":true,\n \"percentOffRate\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":1,"content":{"title":"Create a \"buyXGetY\" coupon that applies to all the store's products","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n --data-binary '{\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"id\":\"d4974fa7-58e3-4140-a263-a6c08b7f2438\"\n}"}},{"name":"Create","type":"METHOD","order":4,"content":{"title":"Create a \"fixedPriceAmount\" coupon that applies to a specific product","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"SalePrice\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126541151,\n \"scope\":{\n \"namespace\":\"stores\",\n \"group\":{\n \"name\":\"product\",\n \"entityId\":\"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\":true,\n \"fixedPriceAmount\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/coupons","rpcOnly":false,"triggeredEvents":[{"title":"Coupon Created","description":"Triggered when a coupon is created.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.CreateCouponRequest","responseMessage":"wix.coupons.api.v2.CreateCouponResponse"},"legacyExamples":[{"name":"Create","type":"METHOD","order":2,"content":{"title":"Create a \"moneyOffAmount\" coupon that applies to all the bookings services","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"Discount\",\n \"code\":\"ABCD\",\n \"active\":true,\n \"startTime\":1554126066895,\n \"scope\":{\n \"namespace\":\"bookings\"\n },\n \"moneyOffAmount\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":3,"content":{"title":"Create a \"freeShipping\" coupon that applies to a minimum subtotal","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"FreeShipping\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126275300,\n \"minimumSubtotal\":5,\n \"limitedToOneItem\":true,\n \"freeShipping\":true\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":5,"content":{"title":"Create a \"percentOffRate\" coupon that applies to all event tickets","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"111\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126716133,\n \"scope\":{\n \"namespace\":\"events\",\n \"group\":{\n \"name\":\"ticket\"\n }\n },\n \"limitedToOneItem\":true,\n \"percentOffRate\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}},{"name":"Create","type":"METHOD","order":1,"content":{"title":"Create a \"buyXGetY\" coupon that applies to all the store's products","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n --data-binary '{\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"id\":\"d4974fa7-58e3-4140-a263-a6c08b7f2438\"\n}"}},{"name":"Create","type":"METHOD","order":4,"content":{"title":"Create a \"fixedPriceAmount\" coupon that applies to a specific product","request":"curl 'https://www.wixapis.com/stores/v2/coupons' \\\n--data-binary '{\n \"specification\":{\n \"name\":\"SalePrice\",\n \"code\":\"ABC\",\n \"active\":true,\n \"startTime\":1554126541151,\n \"scope\":{\n \"namespace\":\"stores\",\n \"group\":{\n \"name\":\"product\",\n \"entityId\":\"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\":true,\n \"fixedPriceAmount\":5\n }\n}' \\\n-H 'Content-Type: application/json'\\\n-H 'Authorization: '","response":"{\n \"id\":\"b126d319-aefd-4004-9b5b-b969915450cb\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create A Coupon","slugifiedName":"create-a-coupon"}},{"summary":"Get A Coupon","description":"Retrieves a coupon by ID.","operationId":"wix.coupons.api.v2.CouponsV2.Get","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the coupon to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.GetCouponResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/coupons","destinationPath":"/v2/coupons","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.GetCouponRequest","responseMessage":"wix.coupons.api.v2.GetCouponResponse"},"legacyExamples":[{"name":"Get","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/abeb638b-f9f4-4bb8-8fe7-2319504df6d9' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"coupon\":{\n \"id\":\"abeb638b-f9f4-4bb8-8fe7-2319504df6d9\",\n \"specification\":{\n \"name\":\"Shark\",\n \"code\":\"Shark\",\n \"startTime\":\"1601877381344\",\n \"limitedToOneItem\":false,\n \"active\":true,\n \"scope\":{\n \"namespace\":\"events\",\n \"group\":{\n \"name\":\"ticket\"\n }\n },\n \"moneyOffAmount\":10,\n \"type\":\"MoneyOff\"\n },\n \"dateCreated\":\"1601877547061\",\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v2/coupons/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.GetCouponRequest","responseMessage":"wix.coupons.api.v2.GetCouponResponse"},"legacyExamples":[{"name":"Get","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/abeb638b-f9f4-4bb8-8fe7-2319504df6d9' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"coupon\":{\n \"id\":\"abeb638b-f9f4-4bb8-8fe7-2319504df6d9\",\n \"specification\":{\n \"name\":\"Shark\",\n \"code\":\"Shark\",\n \"startTime\":\"1601877381344\",\n \"limitedToOneItem\":false,\n \"active\":true,\n \"scope\":{\n \"namespace\":\"events\",\n \"group\":{\n \"name\":\"ticket\"\n }\n },\n \"moneyOffAmount\":10,\n \"type\":\"MoneyOff\"\n },\n \"dateCreated\":\"1601877547061\",\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get A Coupon","slugifiedName":"get-a-coupon"}},{"summary":"Delete A Coupon","description":"Deletes a coupon.","operationId":"wix.coupons.api.v2.CouponsV2.Delete","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the coupon to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.DeleteCouponResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/coupons","destinationPath":"/v2/coupons","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Coupon Deleted","description":"Triggered when a coupon is deleted.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.DeleteCouponRequest","responseMessage":"wix.coupons.api.v2.DeleteCouponResponse"},"legacyExamples":[{"name":"Delete","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/6df8d9ea-9e31-49af-b272-5e22861cce92' \\\n -X DELETE \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v2/coupons/{id}","rpcOnly":false,"triggeredEvents":[{"title":"Coupon Deleted","description":"Triggered when a coupon is deleted.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.DeleteCouponRequest","responseMessage":"wix.coupons.api.v2.DeleteCouponResponse"},"legacyExamples":[{"name":"Delete","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/6df8d9ea-9e31-49af-b272-5e22861cce92' \\\n -X DELETE \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete A Coupon","slugifiedName":"delete-a-coupon"}},{"summary":"Update A Coupon","description":"Updates a coupon.\n\nOnly the properties passed in the `specification` object will be updated. All other properties will remain the same.\n\nTo remove a value from the coupon, pass its corresponding property with a value of `null`.\n\nWhen updating a coupon, you cannot change the coupon's `type`. For example, if the coupon's `type` is `moneyOffAmount`,\nyou cannot change it to `fixedPriceAmount`. You can update the coupon type's value. For example, you can change the\nvalue of `moneyOffAmount` from `5` to `10`.\n\nThe coupon `scope` defines the items a coupon applies to. A coupon can apply to all items in a specific Wix application,\na group within the application, or a single item within a group.\nSee [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).","operationId":"wix.coupons.api.v2.CouponsV2.Update","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the coupon to update.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.UpdateCouponResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/coupons","destinationPath":"/v2/coupons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCouponRequest","description":"","properties":{"specification":{"description":"Coupon information to update.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"specification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Coupon Updated","description":"Triggered when a coupon specification is updated.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.UpdateCouponRequest","responseMessage":"wix.coupons.api.v2.UpdateCouponResponse"},"legacyExamples":[{"name":"Update","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/6df8d9ea-9e31-49af-b272-5e22861cce92' \\\n -X PATCH \\\n --data-binary '{\n \"specification\": {\n \"active\": false\n },\n \"fieldMask\": {\n \"paths\": [\n \"active\"\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v2/coupons/{id}","rpcOnly":false,"triggeredEvents":[{"title":"Coupon Updated","description":"Triggered when a coupon specification is updated.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.UpdateCouponRequest","responseMessage":"wix.coupons.api.v2.UpdateCouponResponse"},"legacyExamples":[{"name":"Update","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/6df8d9ea-9e31-49af-b272-5e22861cce92' \\\n -X PATCH \\\n --data-binary '{\n \"specification\": {\n \"active\": false\n },\n \"fieldMask\": {\n \"paths\": [\n \"active\"\n ]\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update A Coupon","slugifiedName":"update-a-coupon"}},{"summary":"Query Coupons","description":"Retrieves a list of coupons with pagination and filters.\nA maximum of 100 coupons will be returned per request.","operationId":"wix.coupons.api.v2.CouponsV2.Query","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.QueryCouponsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/coupons","destinationPath":"/v2/coupons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryCouponsRequest","description":"","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.coupons.api.v2.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.QueryCouponsRequest","responseMessage":"wix.coupons.api.v2.QueryCouponsResponse"},"legacyExamples":[{"name":"Query","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' \\\n --data-binary '{\n \"query\": {\n \"sort\": \"[{\\\"dateCreated\\\": \\\"asc\\\"}]\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"coupons\": [\n {\n \"id\": \"c5656e10-00a5-4766-99e1-d215d9f2ced7\",\n \"specification\": {\n \"name\": \"officia-pariatur\",\n \"code\": \"WUNYJ\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"limitedToOneItem\": false,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"moneyOffAmount\": 123,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1574772439003\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"419403ac-2e1e-49fb-be55-022f0f1c3848\",\n \"specification\": {\n \"name\": \"officia-pariatur\",\n \"code\": \"WUNYI\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"limitedToOneItem\": false,\n \"active\": true,\n \"freeShipping\": true,\n \"type\": \"FreeShipping\"\n },\n \"dateCreated\": \"1574772347627\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"64d637d8-0ddb-426d-b6fd-cbadd8069374\",\n \"specification\": {\n \"name\": \"AAA\",\n \"code\": \"AAA\",\n \"startTime\": \"1558900675028\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"bookings\",\n \"group\": {\n \"name\": \"service\",\n \"entityId\": \"df47adc9-d5cc-4cc4-8c83-304e2ebb5492\"\n }\n },\n \"moneyOffAmount\": 1,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1558900687419\",\n \"displayData\": {\n \"name\": \"my service\",\n \"formattedPrice\": \"5\"\n }\n },\n {\n \"id\": \"18a6259a-3121-454e-a707-84356e567666\",\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABCD\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"usageLimit\": 10,\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n },\n \"type\": \"BuyXGetY\"\n },\n \"dateCreated\": \"1557689237798\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"9fad9c8f-737e-4656-b32c-50319ac11d01\",\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"startTime\": \"1554066000000\",\n \"expirationTime\": \"1554325199999\",\n \"usageLimit\": 10,\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n },\n \"type\": \"BuyXGetY\"\n },\n \"dateCreated\": \"1557659443707\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"c9d162d9-46ff-4fbf-aa10-583bb49aa999\",\n \"specification\": {\n \"name\": \"xxxx\",\n \"code\": \"12345\",\n \"startTime\": \"1559163600000\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"moneyOffAmount\": 30,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1557649176434\"\n },\n {\n \"id\": \"5e02a750-2e1f-47ef-b49b-e34d3bb116c0\",\n \"specification\": {\n \"name\": \"asdasda\",\n \"code\": \"asdasda\",\n \"startTime\": \"1548346416306\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"product\",\n \"entityId\": \"3be4b9a7-d0b9-3d22-0e64-03053f3abd16\"\n }\n },\n \"moneyOffAmount\": 3,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1548346421718\"\n }\n ],\n \"totalResults\": 7\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/coupons/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.QueryCouponsRequest","responseMessage":"wix.coupons.api.v2.QueryCouponsResponse"},"legacyExamples":[{"name":"Query","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' \\\n --data-binary '{\n \"query\": {\n \"sort\": \"[{\\\"dateCreated\\\": \\\"asc\\\"}]\"\n }\n }' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"coupons\": [\n {\n \"id\": \"c5656e10-00a5-4766-99e1-d215d9f2ced7\",\n \"specification\": {\n \"name\": \"officia-pariatur\",\n \"code\": \"WUNYJ\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"limitedToOneItem\": false,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"moneyOffAmount\": 123,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1574772439003\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"419403ac-2e1e-49fb-be55-022f0f1c3848\",\n \"specification\": {\n \"name\": \"officia-pariatur\",\n \"code\": \"WUNYI\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"limitedToOneItem\": false,\n \"active\": true,\n \"freeShipping\": true,\n \"type\": \"FreeShipping\"\n },\n \"dateCreated\": \"1574772347627\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"64d637d8-0ddb-426d-b6fd-cbadd8069374\",\n \"specification\": {\n \"name\": \"AAA\",\n \"code\": \"AAA\",\n \"startTime\": \"1558900675028\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"bookings\",\n \"group\": {\n \"name\": \"service\",\n \"entityId\": \"df47adc9-d5cc-4cc4-8c83-304e2ebb5492\"\n }\n },\n \"moneyOffAmount\": 1,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1558900687419\",\n \"displayData\": {\n \"name\": \"my service\",\n \"formattedPrice\": \"5\"\n }\n },\n {\n \"id\": \"18a6259a-3121-454e-a707-84356e567666\",\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABCD\",\n \"startTime\": \"1557689091957\",\n \"expirationTime\": \"1557689091958\",\n \"usageLimit\": 10,\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n },\n \"type\": \"BuyXGetY\"\n },\n \"dateCreated\": \"1557689237798\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"9fad9c8f-737e-4656-b32c-50319ac11d01\",\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"startTime\": \"1554066000000\",\n \"expirationTime\": \"1554325199999\",\n \"usageLimit\": 10,\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n },\n \"type\": \"BuyXGetY\"\n },\n \"dateCreated\": \"1557659443707\",\n \"expired\": true,\n \"appId\": \"d655aab0-fd9e-44d8-9020-20700f0047c3\"\n },\n {\n \"id\": \"c9d162d9-46ff-4fbf-aa10-583bb49aa999\",\n \"specification\": {\n \"name\": \"xxxx\",\n \"code\": \"12345\",\n \"startTime\": \"1559163600000\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"moneyOffAmount\": 30,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1557649176434\"\n },\n {\n \"id\": \"5e02a750-2e1f-47ef-b49b-e34d3bb116c0\",\n \"specification\": {\n \"name\": \"asdasda\",\n \"code\": \"asdasda\",\n \"startTime\": \"1548346416306\",\n \"limitedToOneItem\": true,\n \"active\": true,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"product\",\n \"entityId\": \"3be4b9a7-d0b9-3d22-0e64-03053f3abd16\"\n }\n },\n \"moneyOffAmount\": 3,\n \"type\": \"MoneyOff\"\n },\n \"dateCreated\": \"1548346421718\"\n }\n ],\n \"totalResults\": 7\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Coupons","slugifiedName":"query-coupons"}},{"summary":"Bulk Delete Coupons","description":"Deletes multiple coupons.","operationId":"wix.coupons.api.v2.CouponsV2.BulkDeleteCoupons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.BulkDeleteCouponsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/bulk/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/bulk/coupons","destinationPath":"/v2/bulk/coupons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteCouponsRequest","description":"","properties":{"ids":{"description":"IDs of coupons to delete.","maxLength":100,"format":"GUID","title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Coupon Deleted","description":"Triggered when a coupon is deleted.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.BulkDeleteCouponsRequest","responseMessage":"wix.coupons.api.v2.BulkDeleteCouponsResponse"},"legacyExamples":[{"name":"BulkDeleteCoupons","type":"METHOD","content":{"title":"Delete multiple coupons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v2/bulk/coupons/delete' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n --data-binary '{\n \"ids\": [\n \"0e206f85-bb2b-4744-a7be-8c87be96ee03\",\n \"b403cb59-ac11-45d0-b0fa-4a55ed601301\"\n ]\n }' \\","response":"{\n \"results\": [\n {\n \"id\": \"0e206f85-bb2b-4744-a7be-8c87be96ee03\",\n \"success\": true\n },\n {\n \"id\": \"b403cb59-ac11-45d0-b0fa-4a55ed601301\",\n \"success\": true\n }\n ],\n \"deleteMetadata\": {\n \"totalSuccesses\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/bulk/coupons/delete","rpcOnly":false,"triggeredEvents":[{"title":"Coupon Deleted","description":"Triggered when a coupon is deleted.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.BulkDeleteCouponsRequest","responseMessage":"wix.coupons.api.v2.BulkDeleteCouponsResponse"},"legacyExamples":[{"name":"BulkDeleteCoupons","type":"METHOD","content":{"title":"Delete multiple coupons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v2/bulk/coupons/delete' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n --data-binary '{\n \"ids\": [\n \"0e206f85-bb2b-4744-a7be-8c87be96ee03\",\n \"b403cb59-ac11-45d0-b0fa-4a55ed601301\"\n ]\n }' \\","response":"{\n \"results\": [\n {\n \"id\": \"0e206f85-bb2b-4744-a7be-8c87be96ee03\",\n \"success\": true\n },\n {\n \"id\": \"b403cb59-ac11-45d0-b0fa-4a55ed601301\",\n \"success\": true\n }\n ],\n \"deleteMetadata\": {\n \"totalSuccesses\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Coupons","slugifiedName":"bulk-delete-coupons"}},{"summary":"Bulk Create Coupons","description":"Creates multiple coupons.","operationId":"wix.coupons.api.v2.CouponsV2.BulkCreateCoupons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.coupons.api.v2.BulkCreateCouponsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v2/bulk/coupons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/bulk/coupons","destinationPath":"/v2/bulk/coupons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateCouponsRequest","description":"","properties":{"specifications":{"description":"List of coupon specifications to be created.","minItems":1,"maxItems":100,"title":"specifications","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Specification"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return full coupon entity in the response.\n\nDefault: `false`","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Coupon Created","description":"Triggered when a coupon is created.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.BulkCreateCouponsRequest","responseMessage":"wix.coupons.api.v2.BulkCreateCouponsResponse"},"legacyExamples":[{"name":"BulkCreateCoupons","type":"METHOD","content":{"title":"Create 3 coupons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v2/bulk/coupons/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n --data-binary ' {\n \"specifications\": [\n {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n },\n {\n \"name\": \"Discount\",\n \"code\": \"ABCD\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"bookings\"\n },\n \"moneyOffAmount\": 5\n },\n {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n ]\n }' \\","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"error\": {\n \"description\": \"Duplicate coupon code 'ABC' in bulk request\",\n \"data\": {}\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b403cb59-ac11-45d0-b0fa-4a55ed601301\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"originalIndex\": 2,\n \"error\": {\n \"description\": \"Duplicate coupon code 'ABC' in bulk request\",\n \"data\": {}\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/bulk/coupons/create","rpcOnly":false,"triggeredEvents":[{"title":"Coupon Created","description":"Triggered when a coupon is created.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecommerce.coupons.v2.coupon_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"wix.coupons.api.v2.CouponsV2","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["COUPONS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"protoArtifactId":"com.wixpress.platform:coupons-api","serviceArtifactId":"com.wixpress.platform.coupons-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.coupons.api.v2.BulkCreateCouponsRequest","responseMessage":"wix.coupons.api.v2.BulkCreateCouponsResponse"},"legacyExamples":[{"name":"BulkCreateCoupons","type":"METHOD","content":{"title":"Create 3 coupons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v2/bulk/coupons/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n --data-binary ' {\n \"specifications\": [\n {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n },\n {\n \"name\": \"Discount\",\n \"code\": \"ABCD\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"bookings\"\n },\n \"moneyOffAmount\": 5\n },\n {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n ]\n }' \\","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"error\": {\n \"description\": \"Duplicate coupon code 'ABC' in bulk request\",\n \"data\": {}\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"b403cb59-ac11-45d0-b0fa-4a55ed601301\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"originalIndex\": 2,\n \"error\": {\n \"description\": \"Duplicate coupon code 'ABC' in bulk request\",\n \"data\": {}\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Coupons","slugifiedName":"bulk-create-coupons"}}],"webhooks":[{"summary":"Coupon Created","title":"Coupon Created","description":"Triggered when a coupon is created.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"eventType":"wix.ecommerce.coupons.v2.coupon_created","legacyExamples":[{"name":"CouponCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"64f6f913-a474-4cc2-83bf-d4fff1a0668c\",\n \"entityFqdn\": \"wix.ecommerce.coupons.v2.coupon\",\n \"slug\": \"created\",\n \"entityId\": \"94ac22bd-dd4d-4ed7-beda-a63ddeeb2c54\",\n \"createdEvent\": {\n \"entity\": {\n \"numberOfUsages\": 0,\n \"expired\": false,\n \"specification\": {\n \"name\": {\n \"value\": \"FLASH\"\n },\n \"startTime\": {\n \"value\": \"1598241600000\"\n },\n \"expirationTime\": {\n \"value\": \"1598846400000\"\n },\n \"limitedToOneItem\": {\n \"value\": true\n },\n \"scope\": {\n \"namespace\": \"bookings\"\n },\n \"moneyOffAmount\": 10,\n \"usageLimit\": {\n \"value\": 100\n },\n \"code\": {\n \"value\": \"FLASH\"\n },\n \"type\": \"MoneyOff\",\n \"active\": {\n \"value\": true\n }\n },\n \"id\": \"e32fad40-5013-4c39-ae16-13c6221d07d7\",\n \"dateCreated\": \"1597591586834\"\n }\n },\n \"eventTime\": \"2020-08-16T15:26:26.980Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","contentLink":{"displayName":"Coupon Created","slugifiedName":"coupon-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Coupon Updated","title":"Coupon Updated","description":"Triggered when a coupon specification is updated.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"eventType":"wix.ecommerce.coupons.v2.coupon_updated","legacyExamples":[{"name":"CouponUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"64f6f913-a474-4cc2-83bf-d4fff1a0668c\",\n \"entityFqdn\": \"wix.ecommerce.coupons.v2.coupon\",\n \"slug\": \"updated\",\n \"entityId\": \"94ac22bd-dd4d-4ed7-beda-a63ddeeb2c54\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"numberOfUsages\": 0,\n \"expired\": false,\n \"specification\": {\n \"name\": {\n \"value\": \"FLASH\"\n },\n \"startTime\": {\n \"value\": \"1595237792787\"\n },\n \"limitedToOneItem\": {\n \"value\": false\n },\n \"percentOffRate\": 10,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"code\": {\n \"value\": \"FLASH\"\n },\n \"type\": \"PercentOff\",\n \"active\": {\n \"value\": false\n }\n },\n \"id\": \"e32fad40-5013-4c39-ae16-13c6221d07d7\",\n \"dateCreated\": \"1595237792835\"\n }\n },\n \"eventTime\": \"2020-08-16T15:55:09.376Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","contentLink":{"displayName":"Coupon Updated","slugifiedName":"coupon-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Coupon Deleted","title":"Coupon Deleted","description":"Triggered when a coupon is deleted.","permissions":["COUPONS.MANAGE"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"eventType":"wix.ecommerce.coupons.v2.coupon_deleted","legacyExamples":[{"name":"CouponDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"64f6f913-a474-4cc2-83bf-d4fff1a0668c\",\n \"entityFqdn\": \"wix.ecommerce.coupons.v2.coupon\",\n \"slug\": \"deleted\",\n \"entityId\": \"94ac22bd-dd4d-4ed7-beda-a63ddeeb2c54\",\n \"deletedEvent\": {},\n \"eventTime\": \"2020-08-16T15:59:04.030Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","contentLink":{"displayName":"Coupon Deleted","slugifiedName":"coupon-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Coupon Applied","title":"Coupon Applied","description":"Triggered when a coupon is applied.","permissions":["COUPONS.MANAGE"],"payload":{"schemaName":"wix.coupons.api.v2.CouponApplied"},"exposure":"PUBLIC","maturity":"GA","slug":"applied","eventTopic":"domain_events_wix.ecommerce.coupons.v2.coupon","serviceName":"wix.coupons.api.v2.CouponsV2","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Coupons","scopeId":"SCOPE.DC-COUPONS.MANAGE-COUPONS"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"}],"eventType":"wix.ecommerce.coupons.v2.coupon_applied","legacyExamples":[{"name":"CouponApplied","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"64f6f913-a474-4cc2-83bf-d4fff1a0668c\",\n \"entityFqdn\": \"wix.ecommerce.coupons.v2.coupon\",\n \"slug\": \"applied\",\n \"entityId\": \"94ac22bd-dd4d-4ed7-beda-a63ddeeb2c54\",\n \"actionEvent\": {\n \"body\": {\n \"coupon\": {\n \"numberOfUsages\": 264,\n \"expired\": false,\n \"specification\": {\n \"name\": {\n \"value\": \"FLASH\"\n },\n \"startTime\": {\n \"value\": \"1597388155847\"\n },\n \"expirationTime\": {\n \"value\": \"1597852799999\"\n },\n \"limitedToOneItem\": {\n \"value\": false\n },\n \"percentOffRate\": 10,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"code\": {\n \"value\": \"FLASH\"\n },\n \"type\": \"PercentOff\",\n \"active\": {\n \"value\": true\n }\n },\n \"id\": \"e32fad40-5013-4c39-ae16-13c6221d07d7\",\n \"dateCreated\": \"1597388543796\"\n },\n \"wixAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"wixAppOrderId\": \"3efa8732-3bb6-46b1-b19b-14ed64d9ae16\"\n }\n },\n \"eventTime\": \"2020-08-16T15:26:04.507Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.coupons.api.v2.CouponApplied","contentLink":{"displayName":"Coupon Applied","slugifiedName":"coupon-applied"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Coupons API\n\nWix site owners can create coupons to offer their customers discounts for products on their site. \n\nWith the Coupons API, you can manage a site's coupons. \n\n## Checking for Installed Apps\n\nTo use the Coupons API, the user's site must have a valid app installed.\nIn the response to the [Get App Instance](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5a829a3f-423e-484e-80c5-b70320bf9383slug::get-app-instance*fallback::https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance) endpoint, check the `site.installedWixApps` array for the following values:\n+ `stores`\n+ `bookings`\n+ `events`\n+ `pricingPlans`\n\n## Coupon Types\nWix supports the following types of coupons:\n* *$ discount* - a.k.a. `moneyOffAmount`, a fixed discount amount\n* *% discount* - a.k.a. `percentOffAmount`, a discount as a % (e.g., 20% off)\n* *Free Shipping* - free shipping\n* *Sale Price* - a.k.a. `fixedPrice`, a fixed sale price\n* *Buy X Get Y* - purchase one or more of a specified product (X), and get one or more additional products (Y) for free. Both X and Y can be defined either as specified products or as a specified collection of products. All items must be in the customer's cart at time of purchase.\n\n\n## Usage Limits\nCoupons can be limited to:\n\n- 1 item per order\n- Minimum subtotal\n- X number of uses in total (all purchases by all customers, including repeat uses by the same customer)\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/intro.md"},{"displayName":"Filter and sort","slugifyName":"filter-and-sort","content":"# Filter and sort\n\n## Query Language\n\nEndpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).\n\n## Fields That Allow Filtering\n\n| Field | Operators | Sorting Allowed|\n| --- | --- | --- |\n| id |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| dateCreated |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| expired |$eq,$ne||\n| specification.active |$eq,$ne||\n| specification.name |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.code |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.usageLimit |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.limitedToOneItem |$eq,$ne||\n| scope.namespace |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| scope.group.name |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| scope.group.entityId |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n\n** Note that \"HasSome\" is same as the operator \"IN\" in SQL\n\n## Examples\n\n**Query valid (i.e., non-expired) coupons**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"filter\":\"{\\\"expired\\\": false}\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n``` \n\n**Get all coupons, sorted by creation date**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"sort\":\"[{\\\"dateCreated\\\": \\\"asc\\\"}]\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n``` \n\n**Get coupons by IDs**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"filter\":\"{\\\"id\\\": {\\\"$hasSome\\\": [\\\"COUPON_ID_1\\\",\\\"COUPON_ID_2\\\"]}}\"}}' -H 'Content-Type: application/json' -H 'Authorization: xxx'\n``` \n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/filterAndSort.md"},{"displayName":"Valid scope values","slugifyName":"valid-scope-values","content":"# Scope Values\n\nWix site owners can define the coupon to apply to a specific product, a collection of products, or to all of their products within a specific Wix Business Solution. \n\nCoupons are available for the following Wix business solutions:\n\n- Wix Stores\n- Wix Bookings\n- Wix Events\n- Wix Pricing Plans\n\nWhen creating a coupon via API, you will need to apply a coupon scope. The scope should include:\n* Namespace (required)\n* Group (optional - if not listed, the coupon will apply to all products/services/events in the namespace)\n* Entity ID - (required only when Group is listed)\n\n## Wix Stores\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| stores|N/A|N/A|Coupon applies to all products |\n| stores|product|product ID|Coupon applies to the specific product with the provided ID |\n| stores|collection|collection ID|Coupon applies to the specific collection with the provided ID |\n\n## Wix Bookings\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| bookings|N/A|N/A|Coupon applies to all services |\n| bookings|service|service ID|Coupon applies to the specific service with the provided ID |\n\n## Wix Events\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| events|event|N/A|Coupon applies to all events |\n| events|event|event ID|Coupon applies to the specific event with the provided ID |\n| events|ticket|N/A|Coupon applies to all tickets |\n| events|ticket|ticket ID|Coupon applies to the specific ticket with the provided ID |\n\n## Wix Pricing Plans\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| pricingPlans|N/A|N/A|Coupon applies to all pricing plans |\n| pricingPlans|plan|plan ID|Coupon applies to the specific pricing plan with the provided ID |\n\n\n## Wix Restaurants\n\n| Namespace | Group | Entity ID | Result |\n|--------------|-------------|-----------------|----------------------------------------------------|\n| restaurants | N/A | N/A | Coupon applies to all menu items |\n| restaurants | menu | menu ID | Coupon applies to items of a specific menu |\n| restaurants | menuSection | menu section ID | Coupon applies to items of a specific menu section |\n| restaurants | menuItem | menu item ID | Coupon applies to the specific menu item |\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/validScopeValues.md"},{"displayName":"Use cases","slugifyName":"use-cases","content":"# Use Cases\n\nThird party apps can use coupons to help site owners improve brand loyalty, increase customer engagement and incentivize customer purchases on Wix sites. \nCoupons can be set to activate and expire automatically, and to deactivate after a maximum amount of uses, so that the entire coupon lifecycle is set during creation. \nCoupons can also be changed both before they become active and while they are active, including deactivation, or deleted.\n\n\nThis article shares possible use cases your app could support, as well as an example flow that could support each use case. \nYou're certainly not limited to what's on this page, but it can be a helpful jumping off point as you plan your app.\n\n## Create a \"Buy X Get Y Free\" coupon \n\nThis use case describes creating a coupon that grants an extra 2 entities (products/services/events/tickets) for free when the customer purchases 3 of the same entity at the regular price. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\n- If the coupon should apply to any product in Wix Stores, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n ```\n\n- If the coupon should apply to a specific service in Wix Bookings, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"bookings\",\n \"group\": {\n \"name\": \"service\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n }\n ```\n\n- If the coupon should apply to all tickets in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\"\n }\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n ```\n\n\n## Create an \"X Amount Off a Purchase\" coupon \n\nThis use case describes creating a coupon that grants a flat discount of 5 (currency is taken from the Wix site's settings) off a purchase. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\n- If the coupon should apply to all products in a specific Wix Stores collection, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"usageLimit\": 10,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n- If the coupon should apply to all services in Wix Bookings, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"bookings\"\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n- If the coupon should apply to a specific ticket in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n## Create a \"Fixed Discount\" coupon \n\nThis use case describes creating a coupon that grants a special price of 5 (currency is taken from the Wix site's settings) to a specific entity (product/service/event/ticket). \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\nIf the coupon should apply to a specific product in Wix Stores, your request can look like this:\n\n```json\n{\n \"specification\": {\n \"name\": \"SalePrice\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126541151,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"product\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": true,\n \"fixedPriceAmount\": 5\n }\n}\n```\n\n## Create a \"Percentage Discount\" coupon\n\nThis use case describes creating a coupon that grants 5 percent off of a specific entity (product/service/event/ticket). \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`.\n\n- If the coupon should apply to a specific collection in Wix Stores, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"111\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126716133,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": true,\n \"percentOffRate\": 5\n }\n }\n ```\n\n- If the coupon should apply to a specific ticket in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"111\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126716133,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\"\n }\n },\n \"limitedToOneItem\": true,\n \"percentOffRate\": 5\n }\n }\n ```\n\n## Create a \"Free Shipping\" coupon that applies to a minimum subtotal\n\nThis use case describes creating a coupon that grants free shipping to a purchase requiring shipping, when a minimum subtotal is reached. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`.\n\n- If the coupon should apply to all namespaces (stores, bookings, and events) with physical products that require shipping, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n }\n ```\n\n- If the coupon should apply to all Wix Stores purchases with physical products that require shipping, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"scope\": {\n \"namespace\": \"stores,\"\n },\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n }\n ```\n\n## Invalidate a coupon \n\nThis use case describes changing the coupon to make it inactive.\n\n```json\n{\n \"specification\": {\n \"active\": false\n },\n \"fieldMask\": {\n \"paths\": [\n \"active\"\n ]\n }\n}\n```\n\n## Delete a coupon\n\nThis use case describes deleting a coupon.\n\n```curl\ncurl 'https://www.wixapis.com/stores/v2/coupons/' \\\n -X DELETE \\\n -H 'Authorization: '\n```\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/usecases.md"},{"displayName":"Functionality","slugifyName":"functionality","content":"# Coupon Functionality\n\n- Price discounts for collections apply to every item in that collection, no matter the item's price. If the coupon sets a $10 discount and there is an $8 item in that collection, that item will be free when a customer applies the coupon code.\n- Only 1 coupon can be applied per order. (It is, however, possible to offer free shipping above a set price along with another coupon.)\n- Coupon codes are case and space sensitive. (We recommend instructing customers to copy and paste the coupon code without making any changes.)\n- All discounts require a coupon.\n- Limit to 1 discount per order: If a customer buys multiple items that the coupon applies to, the discount is applied to the item with the lowest price.\n- Limited number of uses: You can set a limit for the number of times the coupon can be used in total, but you can't limit the number of times a specific customer can use the coupon.\n- If you or the Wix site owner created a coupon for a product, and then deletes that product, there is no notification that this product has a coupon attached to it.\n- Buy X Get Y: \n - Applies only to products in the user’s cart (e.g., to apply a buy 3 get 1 free coupon, the customer must add 4 of the relevant product(s) to their cart. \n - The defined scope for the coupon applies both to the product purchased and the product received for free (e.g., buy 3 of product X, the 4th is free, or buy 3 products from collection X, get the 4th for free).\n- Coupons can't be limited to a specific type/subset of customers (e.g., first-time or returning customers, customers from specific locales, etc.).\n- Coupons are not available for quantity based discounts in Wix Stores (e.g., if you buy 10 shirts, you get a 10% discount on the total price). However, you can add a quantity product option with a negative charge.\n- Gift card features are not available at this time.\n- There is no bulk upload capability for coupons.\n- Coupon currency can't be defined per coupon - $ discount coupons will be applied in any currency that the Wix site owner has set up in their dashboard settings.\n- Coupons for bookings scopes can't be applied to membership plans, or to services that are set to \"Free/Prices Vary\".\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/limitations.md"}],"components":{"schemas":{"wix.coupons.api.v2.Coupon":{"type":"object","properties":{"id":{"description":"Coupon ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"specification":{"description":"Basic coupon info.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"specification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateCreated":{"description":"Time the coupon was created (UNIX Epoch time in milliseconds).","title":"dateCreated","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expired":{"description":"Whether the coupon is expired.","title":"expired","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberOfUsages":{"description":"How many times this coupon has been used.","title":"numberOfUsages","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayData":{"description":"Coupon display information.","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon.DisplayData","summary":"displayData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that created the coupon. Empty if created by the site owner.","format":"GUID","readOnly":true,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Coupon","description":"The `Coupon` object represents all information available for a coupon\nincluding its basic definition and runtime information."},"wix.coupons.api.v2.MediaItem":{"type":"object","properties":{"url":{"description":"Media item URL.","format":"WEB_URL","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Media item width.","minimum":0,"maximum":5000,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Media item height.","minimum":0,"maximum":5000,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MediaItem","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.coupons.api.v2.Specification":{"type":"object","properties":{"name":{"description":"Name of coupon.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"code":{"description":"Coupon code. Must be unique for all coupons on your site.\n\nMax: 20 characters","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startTime":{"description":"Coupon valid from this date and time.","minimum":1000000000000,"title":"startTime","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expirationTime":{"description":"Coupon expires at this date and time.","minimum":1000000000000,"title":"expirationTime","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"usageLimit":{"description":"Maximum number of times the coupon can be used.\n\n>**Note:** Multiple purchases by the same customer or purchases by different customers are both counted toward `usageLimit`.","title":"usageLimit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limitPerCustomer":{"description":"Maximum number of times the coupon can be used per customer.","title":"limitPerCustomer","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limitedToOneItem":{"description":"Whether the coupon is limited to one item.\n\nIf `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.\nCoupons with a `bookings` `scope.namespace` are always limited to one item.","title":"limitedToOneItem","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliesToSubscriptions":{"description":"Whether the coupon applies to subscription products.","title":"appliesToSubscriptions","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountedCycleCount":{"description":"Specifies the amount of discounted cycles for a subscription item.\n\n+ Can only be set when `scope.namespace = pricingPlans`.\n+ If `discountedCycleCount` is empty, the coupon applies to all available cycles.\n+ `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.\n\nMax: `999`","title":"discountedCycleCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"active":{"description":"Whether the coupon is currently [active](https://support.wix.com/en/article/wix-stores-activating-and-deactivating-coupons).\n\nDefault: `true`","title":"active","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Coupon type. Read-only.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Specification","description":"Coupon information","oneOf":[{"description":"","summary":"ScopeOrMinSubtotal","$ref":"#/components/schemas/wix.coupons.api.v2.Specification.ScopeOrMinSubtotal"},{"description":"","summary":"Behavior","$ref":"#/components/schemas/wix.coupons.api.v2.Specification.Behavior"}]},"wix.coupons.api.v2.Specification.ScopeOrMinSubtotal":{"type":"object","title":"ScopeOrMinSubtotal","properties":{"scope":{"description":"Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).","$ref":"#/components/schemas/wix.coupons.api.v2.Scope","summary":"scope","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minimumSubtotal":{"description":"Limit the coupon to carts with a subtotal above this number.","title":"minimumSubtotal","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.coupons.api.v2.Specification.Behavior":{"type":"object","title":"Behavior","properties":{"moneyOffAmount":{"description":"Discount as a fixed amount.","title":"moneyOffAmount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"percentOffRate":{"description":"Discount as a percentage.","title":"percentOffRate","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"freeShipping":{"description":"Free shipping.\n\nIf `true`, the coupon applies to all items in all `namespaces`.","title":"freeShipping","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fixedPriceAmount":{"description":"Fixed sale price.","title":"fixedPriceAmount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyXGetY":{"description":"Receive free products when making a purchase.\n\nFor example, purchase `x` number of products and receive `y` number of products for free.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification.BuyXGetY","summary":"buyXGetY","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","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":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.coupons.api.v2.Specification.BuyXGetY":{"type":"object","properties":{"x":{"description":"Number of purchased items required to receive free items.","title":"x","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"y":{"description":"Number of items received for free if required number of items were purchased.","title":"y","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BuyXGetY","description":"Coupon type."},"wix.coupons.api.v2.Coupon.DisplayData":{"type":"object","properties":{"name":{"description":"Coupon name to be displayed.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mediaItem":{"description":"Displayed media item information.","$ref":"#/components/schemas/wix.coupons.api.v2.MediaItem","summary":"mediaItem","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedPrice":{"description":"Formatted price for display.","title":"formattedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DisplayData","description":""},"wix.coupons.api.v2.CreateCouponRequest":{"type":"object","properties":{"specification":{"description":"Coupon to create.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"specification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCouponRequest","description":""},"wix.coupons.api.v2.CreateCouponResponse":{"type":"object","properties":{"id":{"description":"ID of the newly created coupon.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCouponResponse","description":""},"wix.coupons.api.v2.UpdateCouponRequest":{"type":"object","properties":{"id":{"description":"ID of the coupon to update.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"specification":{"description":"Coupon information to update.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"specification","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCouponRequest","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.coupons.api.v2.UpdateCouponResponse":{"type":"object","properties":{},"title":"UpdateCouponResponse","description":""},"wix.coupons.api.v2.GetCouponRequest":{"type":"object","properties":{"id":{"description":"ID of the coupon to retrieve.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCouponRequest","description":""},"wix.coupons.api.v2.GetCouponResponse":{"type":"object","properties":{"coupon":{"description":"Retrieved coupon.","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCouponResponse","description":""},"wix.coupons.api.v2.DeleteCouponRequest":{"type":"object","properties":{"id":{"description":"ID of the coupon to delete.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCouponRequest","description":""},"wix.coupons.api.v2.DeleteCouponResponse":{"type":"object","properties":{},"title":"DeleteCouponResponse","description":""},"wix.coupons.api.v2.QueryCouponsRequest":{"type":"object","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.coupons.api.v2.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCouponsRequest","description":""},"wix.coupons.api.v2.Query":{"type":"object","properties":{"paging":{"description":"Optional pagination parameters","$ref":"#/components/schemas/wix.coupons.api.v2.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter string (e.g., when {\"expired\":\"true\"}, expired coupons will be returned).","title":"filter","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort string.","title":"sort","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"wix.coupons.api.v2.Paging":{"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"}},"offset":{"description":"Offset since the beginning of the collection.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"wix.coupons.api.v2.QueryCouponsResponse":{"type":"object","properties":{"coupons":{"description":"Returned coupons.","title":"coupons","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Coupon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalResults":{"description":"Total results.","title":"totalResults","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCouponsResponse","description":""},"wix.coupons.api.v2.CalculateRequest":{"type":"object","properties":{"cart":{"description":"Cart to which the coupon will be applied.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currencySymbol":{"description":"Currency symbol for error message and applied coupon.","title":"currencySymbol","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"precision":{"description":"Round the result to places after the decimal dot. Defaults to 2 if not provided.","title":"precision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uniqueUserIdentifier":{"description":"Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer.","title":"uniqueUserIdentifier","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateRequest","description":"","oneOf":[{"description":"","summary":"CalculateBy","$ref":"#/components/schemas/wix.coupons.api.v2.CalculateRequest.CalculateBy"}]},"wix.coupons.api.v2.CalculateRequest.CalculateBy":{"type":"object","title":"CalculateBy","properties":{"id":{"description":"For calculating by coupon ID (usually for cart calculate phase).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"code":{"description":"For calculating by coupon code (usually for apply coupon phase - for validation).","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Type of in-memory discount that can be applied when coupon doesn't exist.","$ref":"#/components/schemas/wix.coupons.api.v2.Specification","summary":"discount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.coupons.api.v2.Cart":{"type":"object","properties":{"lineItems":{"description":"Array of cart line items.","title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Cart.LineItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shipping":{"description":"Cart shipping information.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart.Shipping","summary":"shipping","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totals":{"description":"Summary of cart totals.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cart","description":"Cart is passed to coupon service's apply function in order to\napply the coupons calculation on it"},"wix.coupons.api.v2.Cart.AppliedDiscount":{"type":"object","properties":{"discountAmount":{"description":"Discount amount, in case discount is applied per line.","title":"discountAmount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"afterDiscountAmount":{"description":"Line item price after applied discount.","title":"afterDiscountAmount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppliedDiscount","description":""},"wix.coupons.api.v2.Cart.LineItem":{"type":"object","properties":{"lineId":{"description":"Cart line item ID - represents index position (required).","title":"lineId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"Item ID in the external system - will usually be a product ID.","title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Line item amount (while quantity = 1).","title":"amount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Line item quantity. Must be greater than 0.","title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scopes":{"description":"Coupon scopes this line item applies to.","title":"scopes","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedDiscount":{"description":"Applied discount on line item after calculation.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart.AppliedDiscount","summary":"appliedDiscount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscription":{"description":"Whether the line item is of type subscription.","title":"subscription","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItem","description":"represents a single line in the cart"},"wix.coupons.api.v2.Cart.Shipping":{"type":"object","properties":{"amount":{"description":"Shipping price before applying the coupon.","title":"amount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedDiscount":{"description":"Discount on shipping price.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart.AppliedDiscount","summary":"appliedDiscount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Shipping","description":"represents the shipping line in the cart\nthe coupons need to know about it because of the free shipping coupon"},"wix.coupons.api.v2.Cart.Totals":{"type":"object","properties":{"subTotal":{"description":"Cart subtotal.","title":"subTotal","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Sum of all discounts.","title":"discount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"","title":"total","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Totals","description":""},"wix.coupons.api.v2.CalculateResponse":{"type":"object","properties":{"cart":{"description":"Cart after applying the coupon.","$ref":"#/components/schemas/wix.coupons.api.v2.Cart","summary":"cart","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedCoupon":{"description":"Applied coupon information.","$ref":"#/components/schemas/wix.coupons.api.v2.CalculateResponse.AppliedCoupon","summary":"appliedCoupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Errors, in case call failed.","title":"error","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Error"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateResponse","description":""},"wix.coupons.api.v2.CalculateResponse.AppliedCoupon":{"type":"object","properties":{"name":{"description":"Name of the coupon applied.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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"}},"isFreeShipping":{"description":"Whether the coupon type entitles free shipping.","title":"isFreeShipping","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"couponType":{"description":"Coupon type (e.g., moneyOffAmount, buyXGetY, percentOffRate).","title":"couponType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountValue":{"description":"Discount value (e.g., $10, 10%).","title":"discountValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountedCycleCount":{"description":"Amount of discounted cycles for subscription item. None specifies for all cycles.","title":"discountedCycleCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppliedCoupon","description":""},"wix.coupons.api.v2.Error":{"type":"object","properties":{"code":{"description":"error code","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"descriptive error message","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Error","description":""},"wix.coupons.api.v2.IncreaseUsageRequest":{"type":"object","properties":{"id":{"description":"Coupon ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"usedBy":{"description":"Unique ID of the entity that the coupon was applied to (e.g., orderId).","title":"usedBy","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uniqueUserIdentifier":{"description":"Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer.","title":"uniqueUserIdentifier","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixAppId":{"description":"ID of app that applied the coupon (e.g. bookings appDefId).","format":"GUID","title":"wixAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncreaseUsageRequest","description":""},"wix.coupons.api.v2.IncreaseUsageResponse":{"type":"object","properties":{"error":{"description":"Errors, in case call failed.","title":"error","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Error"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncreaseUsageResponse","description":""},"wix.coupons.api.v2.CouponApplied":{"type":"object","properties":{"coupon":{"description":"Applied coupon information.","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixAppId":{"description":"ID of Wix app that applied the coupon. Supported values:\n+ Wix Stores - `1380b703-ce81-ff05-f115-39571d94dfcd`\n+ Wix Bookings - `13d21c63-b5ec-5912-8397-c3a5ddb27a97`\n+ Wix Events - `140603ad-af8d-84a5-2c80-a0f60cb47351`","format":"GUID","title":"wixAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixAppOrderId":{"description":"ID of the entity that the coupon was applied to (orderId, bookingId, etc.).","title":"wixAppOrderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CouponApplied","description":""},"wix.coupons.api.v2.HasCouponsRequest":{"type":"object","properties":{},"title":"HasCouponsRequest","description":""},"wix.coupons.api.v2.HasCouponsResponse":{"type":"object","properties":{"hasCoupons":{"description":"True if site has ever had a coupon.","title":"hasCoupons","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HasCouponsResponse","description":""},"wix.coupons.api.v2.BulkDeleteCouponsRequest":{"type":"object","properties":{"ids":{"description":"IDs of coupons to delete.","maxLength":100,"format":"GUID","title":"ids","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCouponsRequest","description":""},"wix.coupons.api.v2.BulkDeleteCouponsResponse":{"type":"object","properties":{"results":{"description":"Item metadata.","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.ItemMetadata"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"deleteMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCouponsResponse","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"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":""},"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":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"wix.coupons.api.v2.BulkCreateCouponsRequest":{"type":"object","properties":{"specifications":{"description":"List of coupon specifications to be created.","minItems":1,"maxItems":100,"title":"specifications","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.Specification"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return full coupon entity in the response.\n\nDefault: `false`","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCouponsRequest","description":""},"wix.coupons.api.v2.BulkCreateCouponsResponse":{"type":"object","properties":{"results":{"description":"Items created by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.coupons.api.v2.BulkCreateCouponResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCouponsResponse","description":""},"wix.coupons.api.v2.BulkCreateCouponResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coupon":{"description":"New coupons.","$ref":"#/components/schemas/wix.coupons.api.v2.Coupon","summary":"coupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCouponResult","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"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","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.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":""},"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":"Coupon","description":"The `Coupon` object represents all information available for a coupon\nincluding its basic definition and runtime information.","fqdn":"wix.ecommerce.coupons.v2.coupon"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Coupons API\n\nWix site owners can create coupons to offer their customers discounts for products on their site. \n\nWith the Coupons API, you can manage a site's coupons. \n\n## Checking for Installed Apps\n\nTo use the Coupons API, the user's site must have a valid app installed.\nIn the response to the [Get App Instance](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::5a829a3f-423e-484e-80c5-b70320bf9383slug::get-app-instance*fallback::https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance) endpoint, check the `site.installedWixApps` array for the following values:\n+ `stores`\n+ `bookings`\n+ `events`\n+ `pricingPlans`\n\n## Coupon Types\nWix supports the following types of coupons:\n* *$ discount* - a.k.a. `moneyOffAmount`, a fixed discount amount\n* *% discount* - a.k.a. `percentOffAmount`, a discount as a % (e.g., 20% off)\n* *Free Shipping* - free shipping\n* *Sale Price* - a.k.a. `fixedPrice`, a fixed sale price\n* *Buy X Get Y* - purchase one or more of a specified product (X), and get one or more additional products (Y) for free. Both X and Y can be defined either as specified products or as a specified collection of products. All items must be in the customer's cart at time of purchase.\n\n\n## Usage Limits\nCoupons can be limited to:\n\n- 1 item per order\n- Minimum subtotal\n- X number of uses in total (all purchases by all customers, including repeat uses by the same customer)\n"},{"displayName":"Filter and sort","slugifyName":"filter-and-sort","content":"# Filter and sort\n\n## Query Language\n\nEndpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).\n\n## Fields That Allow Filtering\n\n| Field | Operators | Sorting Allowed|\n| --- | --- | --- |\n| id |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| dateCreated |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| expired |$eq,$ne||\n| specification.active |$eq,$ne||\n| specification.name |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.code |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.usageLimit |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| specification.limitedToOneItem |$eq,$ne||\n| scope.namespace |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| scope.group.name |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n| scope.group.entityId |$eq,$ne,$hasSome,$contains,$startsWith|Allowed|\n\n** Note that \"HasSome\" is same as the operator \"IN\" in SQL\n\n## Examples\n\n**Query valid (i.e., non-expired) coupons**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"filter\":\"{\\\"expired\\\": false}\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n``` \n\n**Get all coupons, sorted by creation date**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"sort\":\"[{\\\"dateCreated\\\": \\\"asc\\\"}]\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n``` \n\n**Get coupons by IDs**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/coupons/query' --data-binary '{\"query\":{\"filter\":\"{\\\"id\\\": {\\\"$hasSome\\\": [\\\"COUPON_ID_1\\\",\\\"COUPON_ID_2\\\"]}}\"}}' -H 'Content-Type: application/json' -H 'Authorization: xxx'\n``` \n"},{"displayName":"Valid scope values","slugifyName":"valid-scope-values","content":"# Scope Values\n\nWix site owners can define the coupon to apply to a specific product, a collection of products, or to all of their products within a specific Wix Business Solution. \n\nCoupons are available for the following Wix business solutions:\n\n- Wix Stores\n- Wix Bookings\n- Wix Events\n- Wix Pricing Plans\n\nWhen creating a coupon via API, you will need to apply a coupon scope. The scope should include:\n* Namespace (required)\n* Group (optional - if not listed, the coupon will apply to all products/services/events in the namespace)\n* Entity ID - (required only when Group is listed)\n\n## Wix Stores\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| stores|N/A|N/A|Coupon applies to all products |\n| stores|product|product ID|Coupon applies to the specific product with the provided ID |\n| stores|collection|collection ID|Coupon applies to the specific collection with the provided ID |\n\n## Wix Bookings\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| bookings|N/A|N/A|Coupon applies to all services |\n| bookings|service|service ID|Coupon applies to the specific service with the provided ID |\n\n## Wix Events\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| events|event|N/A|Coupon applies to all events |\n| events|event|event ID|Coupon applies to the specific event with the provided ID |\n| events|ticket|N/A|Coupon applies to all tickets |\n| events|ticket|ticket ID|Coupon applies to the specific ticket with the provided ID |\n\n## Wix Pricing Plans\n\n| Namespace | Group | Entity ID | Result|\n| --- | --- | --- | --- |\n| pricingPlans|N/A|N/A|Coupon applies to all pricing plans |\n| pricingPlans|plan|plan ID|Coupon applies to the specific pricing plan with the provided ID |\n\n\n## Wix Restaurants\n\n| Namespace | Group | Entity ID | Result |\n|--------------|-------------|-----------------|----------------------------------------------------|\n| restaurants | N/A | N/A | Coupon applies to all menu items |\n| restaurants | menu | menu ID | Coupon applies to items of a specific menu |\n| restaurants | menuSection | menu section ID | Coupon applies to items of a specific menu section |\n| restaurants | menuItem | menu item ID | Coupon applies to the specific menu item |\n"},{"displayName":"Use cases","slugifyName":"use-cases","content":"# Use Cases\n\nThird party apps can use coupons to help site owners improve brand loyalty, increase customer engagement and incentivize customer purchases on Wix sites. \nCoupons can be set to activate and expire automatically, and to deactivate after a maximum amount of uses, so that the entire coupon lifecycle is set during creation. \nCoupons can also be changed both before they become active and while they are active, including deactivation, or deleted.\n\n\nThis article shares possible use cases your app could support, as well as an example flow that could support each use case. \nYou're certainly not limited to what's on this page, but it can be a helpful jumping off point as you plan your app.\n\n## Create a \"Buy X Get Y Free\" coupon \n\nThis use case describes creating a coupon that grants an extra 2 entities (products/services/events/tickets) for free when the customer purchases 3 of the same entity at the regular price. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\n- If the coupon should apply to any product in Wix Stores, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"stores\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n ```\n\n- If the coupon should apply to a specific service in Wix Bookings, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"bookings\",\n \"group\": {\n \"name\": \"service\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n }\n ```\n\n- If the coupon should apply to all tickets in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"BuyXGetY\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554066000000,\n \"usageLimit\": 10,\n \"expirationTime\": 1554325199999,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\"\n }\n },\n \"limitedToOneItem\": true,\n \"buyXGetY\": {\n \"x\": 3,\n \"y\": 2\n }\n }\n }\n ```\n\n\n## Create an \"X Amount Off a Purchase\" coupon \n\nThis use case describes creating a coupon that grants a flat discount of 5 (currency is taken from the Wix site's settings) off a purchase. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\n- If the coupon should apply to all products in a specific Wix Stores collection, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"usageLimit\": 10,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n- If the coupon should apply to all services in Wix Bookings, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"bookings\"\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n- If the coupon should apply to a specific ticket in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"Discount\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126066895,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": false,\n \"moneyOffAmount\": 5\n }\n }\n ```\n\n## Create a \"Fixed Discount\" coupon \n\nThis use case describes creating a coupon that grants a special price of 5 (currency is taken from the Wix site's settings) to a specific entity (product/service/event/ticket). \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`, Valid until: `April 3, 2019 11:59:59 PM`.\n\nIf the coupon should apply to a specific product in Wix Stores, your request can look like this:\n\n```json\n{\n \"specification\": {\n \"name\": \"SalePrice\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126541151,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"product\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": true,\n \"fixedPriceAmount\": 5\n }\n}\n```\n\n## Create a \"Percentage Discount\" coupon\n\nThis use case describes creating a coupon that grants 5 percent off of a specific entity (product/service/event/ticket). \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`.\n\n- If the coupon should apply to a specific collection in Wix Stores, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"111\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126716133,\n \"scope\": {\n \"namespace\": \"stores\",\n \"group\": {\n \"name\": \"collection\",\n \"entityId\": \"e599b709-1a8b-478a-ae80-26192944aef5\"\n }\n },\n \"limitedToOneItem\": true,\n \"percentOffRate\": 5\n }\n }\n ```\n\n- If the coupon should apply to a specific ticket in Wix Events, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"111\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126716133,\n \"scope\": {\n \"namespace\": \"events\",\n \"group\": {\n \"name\": \"ticket\"\n }\n },\n \"limitedToOneItem\": true,\n \"percentOffRate\": 5\n }\n }\n ```\n\n## Create a \"Free Shipping\" coupon that applies to a minimum subtotal\n\nThis use case describes creating a coupon that grants free shipping to a purchase requiring shipping, when a minimum subtotal is reached. \nCoupon details include: coupon code: ABC, Active upon creation: true, Total usage limit: 10 uses, Valid from: `April 1, 2019 12:00:00 AM`.\n\n- If the coupon should apply to all namespaces (stores, bookings, and events) with physical products that require shipping, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n }\n ```\n\n- If the coupon should apply to all Wix Stores purchases with physical products that require shipping, your request can look like this: \n\n ```json\n {\n \"specification\": {\n \"name\": \"FreeShipping\",\n \"code\": \"ABC\",\n \"active\": true,\n \"startTime\": 1554126275300,\n \"scope\": {\n \"namespace\": \"stores,\"\n },\n \"minimumSubtotal\": 5,\n \"limitedToOneItem\": true,\n \"freeShipping\": true\n }\n }\n ```\n\n## Invalidate a coupon \n\nThis use case describes changing the coupon to make it inactive.\n\n```json\n{\n \"specification\": {\n \"active\": false\n },\n \"fieldMask\": {\n \"paths\": [\n \"active\"\n ]\n }\n}\n```\n\n## Delete a coupon\n\nThis use case describes deleting a coupon.\n\n```curl\ncurl 'https://www.wixapis.com/stores/v2/coupons/' \\\n -X DELETE \\\n -H 'Authorization: '\n```\n"},{"displayName":"Functionality","slugifyName":"functionality","content":"# Coupon Functionality\n\n- Price discounts for collections apply to every item in that collection, no matter the item's price. If the coupon sets a $10 discount and there is an $8 item in that collection, that item will be free when a customer applies the coupon code.\n- Only 1 coupon can be applied per order. (It is, however, possible to offer free shipping above a set price along with another coupon.)\n- Coupon codes are case and space sensitive. (We recommend instructing customers to copy and paste the coupon code without making any changes.)\n- All discounts require a coupon.\n- Limit to 1 discount per order: If a customer buys multiple items that the coupon applies to, the discount is applied to the item with the lowest price.\n- Limited number of uses: You can set a limit for the number of times the coupon can be used in total, but you can't limit the number of times a specific customer can use the coupon.\n- If you or the Wix site owner created a coupon for a product, and then deletes that product, there is no notification that this product has a coupon attached to it.\n- Buy X Get Y: \n - Applies only to products in the user’s cart (e.g., to apply a buy 3 get 1 free coupon, the customer must add 4 of the relevant product(s) to their cart. \n - The defined scope for the coupon applies both to the product purchased and the product received for free (e.g., buy 3 of product X, the 4th is free, or buy 3 products from collection X, get the 4th for free).\n- Coupons can't be limited to a specific type/subset of customers (e.g., first-time or returning customers, customers from specific locales, etc.).\n- Coupons are not available for quantity based discounts in Wix Stores (e.g., if you buy 10 shirts, you get a 10% discount on the total price). However, you can add a quantity product option with a negative charge.\n- Gift card features are not available at this time.\n- There is no bulk upload capability for coupons.\n- Coupon currency can't be defined per coupon - $ discount coupons will be applied in any currency that the Wix site owner has set up in their dashboard settings.\n- Coupons for bookings scopes can't be applied to membership plans, or to services that are set to \"Free/Prices Vary\".\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Bulk Create Coupons

Permission Scopes