{"id":"a659bae5-36a7-44e2-9959-80e1f0102dd2","createdDate":"2024-07-09T12:01:27.948Z","updatedDate":"2024-07-09T12:01:27.948Z","resourceId":"ba57503d-4c65-46b4-9bdb-0b3cacd38075","api":{"schema":{"object":{"displayName":"Discount Rule Object","description":"Manage Discount Rules.","slug":"discount-rule-object","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","legacyExamples":[{"title":"DiscountRule","content":"{\n \"id\": \"15bac455-10d0-4478-8358-e06f697f6180\",\n \"revision\": \"8\",\n \"createdDate\": \"2022-08-07T08:12:22.347Z\",\n \"updatedDate\": \"2022-08-09T07:45:44.044Z\",\n \"active\": true,\n \"name\": \"My Amazing 10% Discount\",\n \"trigger\": {\n \"and\": {\n \"triggers\": [\n {\n \"subtotalRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": \"100\",\n \"to\": null\n },\n \"triggerType\": \"SUBTOTAL_RANGE\"\n },\n {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n ]\n },\n \"triggerType\": \"AND\"\n },\n \"activeTimeInfo\": {\n \"start\": \"2022-08-07T08:11:00Z\",\n \"end\": \"2022-08-11T07:43:00Z\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ]\n },\n \"percentage\": 10,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 6\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Discount Rule","description":"Creates a new discount rule.","operationId":"com.wix.ecom.discounts.DiscountRuleService.CreateDiscountRule","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.discounts.CreateDiscountRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/discount-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/discount-rules","destinationPath":"/v1/discount-rules","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateDiscountRuleRequest","description":"","properties":{"discountRule":{"description":"Discount rule info.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["discountRule","discountRule.name","discountRule.discounts"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Discount Rule Created","description":"Triggered when a discount rule is created.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MAX_DISCOUNT_RULES_REACHED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.CreateDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.CreateDiscountRuleResponse"},"legacyExamples":[{"name":"CreateDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogItemIds\": [],\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n }\n ]\n },\n \"discountType\": \"PERCENTAGE\",\n \"percentage\": 15\n }\n ]\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"discountRule\": {\n \"id\": \"f6a7b058-62c3-44aa-a23a-e6d0898dcdc2\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-06-27T09:33:04.796Z\",\n \"updatedDate\": \"2023-06-27T09:33:04.796Z\",\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n}\n~~~"}},{"name":"CreateDiscountRule","type":"METHOD","order":2,"content":{"title":"Create Buy X Get Y Discount Rule","description":"If the customer purchases a shirt from the shirts category, they'll get a hat from the hats category for free. Discount can be applied up to 2 times (buy 2 hats, get 2 hats).","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"active\": true,\n \"name\": \"Buy one Shirt, Get a Hat Free!\",\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"BUY_X_GET_Y\",\n \"fixedPrice\": \"0\",\n \"discountType\": \"FIXED_PRICE\",\n \"buyXGetYInfo\": {\n \"customerBuys\": {\n \"minimumQuantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"bfe6699a-256a-47ed-b05e-ddfc0230c297\"\n ]\n }\n }\n }\n ]\n },\n \"customerGets\": {\n \"quantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"088f9822-3455-beba-8b9b-72494f6e6aa7\"\n ]\n }\n }\n }\n ]\n },\n \"limit\": 2\n }\n }\n ]\n }\n }\n }'","response":"{\n \"discountRule\": {\n \"id\": \"f6a7b058-62c3-44aa-a23a-e6d0898dcdc2\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-06-27T09:33:04.796Z\",\n \"updatedDate\": \"2023-06-27T09:33:04.796Z\",\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"BUY_X_GET_Y\",\n \"fixedPrice\": \"0\",\n \"discountType\": \"FIXED_PRICE\",\n \"buyXGetYInfo\": {\n \"customerBuys\": {\n \"minimumQuantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"bfe6699a-256a-47ed-b05e-ddfc0230c297\"\n ]\n }\n }\n }\n ]\n },\n \"customerGets\": {\n \"quantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"088f9822-3455-beba-8b9b-72494f6e6aa7\"\n ]\n }\n }\n }\n ]\n },\n \"limit\": 2\n }\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/discount-rules","rpcOnly":false,"triggeredEvents":[{"title":"Discount Rule Created","description":"Triggered when a discount rule is created.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"MAX_DISCOUNT_RULES_REACHED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.CreateDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.CreateDiscountRuleResponse"},"legacyExamples":[{"name":"CreateDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogItemIds\": [],\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n }\n ]\n },\n \"discountType\": \"PERCENTAGE\",\n \"percentage\": 15\n }\n ]\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"discountRule\": {\n \"id\": \"f6a7b058-62c3-44aa-a23a-e6d0898dcdc2\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-06-27T09:33:04.796Z\",\n \"updatedDate\": \"2023-06-27T09:33:04.796Z\",\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n}\n~~~"}},{"name":"CreateDiscountRule","type":"METHOD","order":2,"content":{"title":"Create Buy X Get Y Discount Rule","description":"If the customer purchases a shirt from the shirts category, they'll get a hat from the hats category for free. Discount can be applied up to 2 times (buy 2 hats, get 2 hats).","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/create' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"active\": true,\n \"name\": \"Buy one Shirt, Get a Hat Free!\",\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"BUY_X_GET_Y\",\n \"fixedPrice\": \"0\",\n \"discountType\": \"FIXED_PRICE\",\n \"buyXGetYInfo\": {\n \"customerBuys\": {\n \"minimumQuantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"bfe6699a-256a-47ed-b05e-ddfc0230c297\"\n ]\n }\n }\n }\n ]\n },\n \"customerGets\": {\n \"quantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"088f9822-3455-beba-8b9b-72494f6e6aa7\"\n ]\n }\n }\n }\n ]\n },\n \"limit\": 2\n }\n }\n ]\n }\n }\n }'","response":"{\n \"discountRule\": {\n \"id\": \"f6a7b058-62c3-44aa-a23a-e6d0898dcdc2\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-06-27T09:33:04.796Z\",\n \"updatedDate\": \"2023-06-27T09:33:04.796Z\",\n \"active\": true,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"BUY_X_GET_Y\",\n \"fixedPrice\": \"0\",\n \"discountType\": \"FIXED_PRICE\",\n \"buyXGetYInfo\": {\n \"customerBuys\": {\n \"minimumQuantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"bfe6699a-256a-47ed-b05e-ddfc0230c297\"\n ]\n }\n }\n }\n ]\n },\n \"customerGets\": {\n \"quantity\": 1,\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"088f9822-3455-beba-8b9b-72494f6e6aa7\"\n ]\n }\n }\n }\n ]\n },\n \"limit\": 2\n }\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Discount Rule","slugifiedName":"create-discount-rule"}},{"summary":"Get Discount Rule","description":"Retrieves a discount rule.","operationId":"com.wix.ecom.discounts.DiscountRuleService.GetDiscountRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"discountRuleId","description":"ID of the discount rule to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.discounts.GetDiscountRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/discount-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/discount-rules","destinationPath":"/v1/discount-rules","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.GetDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.GetDiscountRuleResponse"},"legacyExamples":[{"name":"GetDiscountRule","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/ecom/v1/discount-rules/15bac455-10d0-4478-8358-e06f697f6180' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"id\": \"15bac455-10d0-4478-8358-e06f697f6180\",\n \"revision\": \"8\",\n \"createdDate\": \"2022-08-07T08:12:22.347Z\",\n \"updatedDate\": \"2022-08-09T07:45:44.044Z\",\n \"active\": true,\n \"name\": \"My Amazing 10% Discount\",\n \"trigger\": {\n \"and\": {\n \"triggers\": [\n {\n \"subtotalRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": \"100\",\n \"to\": null\n },\n \"triggerType\": \"SUBTOTAL_RANGE\"\n },\n {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n ]\n },\n \"triggerType\": \"AND\"\n },\n \"activeTimeInfo\": {\n \"start\": \"2022-08-07T08:11:00Z\",\n \"end\": \"2022-08-11T07:43:00Z\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ]\n },\n \"percentage\": 10,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 6\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/discount-rules/{discountRuleId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.GetDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.GetDiscountRuleResponse"},"legacyExamples":[{"name":"GetDiscountRule","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/ecom/v1/discount-rules/15bac455-10d0-4478-8358-e06f697f6180' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"id\": \"15bac455-10d0-4478-8358-e06f697f6180\",\n \"revision\": \"8\",\n \"createdDate\": \"2022-08-07T08:12:22.347Z\",\n \"updatedDate\": \"2022-08-09T07:45:44.044Z\",\n \"active\": true,\n \"name\": \"My Amazing 10% Discount\",\n \"trigger\": {\n \"and\": {\n \"triggers\": [\n {\n \"subtotalRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": \"100\",\n \"to\": null\n },\n \"triggerType\": \"SUBTOTAL_RANGE\"\n },\n {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n ]\n },\n \"triggerType\": \"AND\"\n },\n \"activeTimeInfo\": {\n \"start\": \"2022-08-07T08:11:00Z\",\n \"end\": \"2022-08-11T07:43:00Z\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ]\n },\n \"percentage\": 10,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 6\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Discount Rule","slugifiedName":"get-discount-rule"}},{"summary":"Delete Discount Rule","description":"Deletes a discount rule.","operationId":"com.wix.ecom.discounts.DiscountRuleService.DeleteDiscountRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"discountRuleId","description":"ID of the discount rule to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.discounts.DeleteDiscountRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/discount-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/discount-rules","destinationPath":"/v1/discount-rules","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Discount Rule Deleted","description":"Triggered when a discount rule is deleted.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.DeleteDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.DeleteDiscountRuleResponse"},"legacyExamples":[{"name":"DeleteDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/delete/c31f8d152077bab24065f01c0e3152b746c54ce0' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/discount-rules/{discountRuleId}","rpcOnly":false,"triggeredEvents":[{"title":"Discount Rule Deleted","description":"Triggered when a discount rule is deleted.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.DeleteDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.DeleteDiscountRuleResponse"},"legacyExamples":[{"name":"DeleteDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/delete/c31f8d152077bab24065f01c0e3152b746c54ce0' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Discount Rule","slugifiedName":"delete-discount-rule"}},{"summary":"Update Discount Rule","description":"Updates a discount rule.\n\nEach time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule.\nThis ensures you're working with the latest discount rule information, and it prevents unintended overwrites.","operationId":"com.wix.ecom.discounts.DiscountRuleService.UpdateDiscountRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"discountRule.id","description":"Discount rule ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.discounts.UpdateDiscountRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/discount-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/discount-rules","destinationPath":"/v1/discount-rules","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateDiscountRuleRequest","description":"","properties":{"discountRule":{"description":"Discount rule info.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["discountRule","discountRule.id","discountRule.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Discount Rule Updated","description":"Triggered when a discount rule is updated.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.UpdateDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.UpdateDiscountRuleResponse"},"legacyExamples":[{"name":"UpdateDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/update/35120105-1327-4624-8f7f-2720dcbab4d6' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"name\": \"discount new name\",\n \"revision\": \"5\"\n }\n }'\n~~~","response":"~~~json\n{\n \"discountRule\": {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"revision\": \"6\",\n \"createdDate\": \"2022-08-08T07:46:16.487Z\",\n \"updatedDate\": \"2022-08-08T07:46:16.487Z\",\n \"active\": true,\n \"name\": \"discount new name\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\",\n \"activeTimeInfo\": null,\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/discount-rules/{discountRule.id}","rpcOnly":false,"triggeredEvents":[{"title":"Discount Rule Updated","description":"Triggered when a discount rule is updated.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.discounts.v1.discount_rule_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.UpdateDiscountRuleRequest","responseMessage":"com.wix.ecom.discounts.UpdateDiscountRuleResponse"},"legacyExamples":[{"name":"UpdateDiscountRule","type":"METHOD","order":1,"content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/update/35120105-1327-4624-8f7f-2720dcbab4d6' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"discountRule\": {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"name\": \"discount new name\",\n \"revision\": \"5\"\n }\n }'\n~~~","response":"~~~json\n{\n \"discountRule\": {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"revision\": \"6\",\n \"createdDate\": \"2022-08-08T07:46:16.487Z\",\n \"updatedDate\": \"2022-08-08T07:46:16.487Z\",\n \"active\": true,\n \"name\": \"discount new name\",\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\",\n \"activeTimeInfo\": null,\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 0\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Discount Rule","slugifiedName":"update-discount-rule"}},{"summary":"Query Discount Rules","description":"Query discount rules using [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).\nTotal entries (`pagingMetadata.total`) will be returned only for the first page.\n\n> **Note:** `discountRule.status` can't be used for querying.","operationId":"com.wix.ecom.discounts.DiscountRuleService.QueryDiscountRules","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.discounts.QueryDiscountRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/discount-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/discount-rules","destinationPath":"/v1/discount-rules","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryDiscountRulesRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.QueryDiscountRulesRequest","responseMessage":"com.wix.ecom.discounts.QueryDiscountRulesResponse"},"legacyExamples":[{"name":"QueryDiscountRules","type":"METHOD","order":1,"content":{"title":"Query Discount Rules","description":"Query Discount rules by active and start date fields, sorted by name","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"name\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"active\": true,\n \"activeTimeInfo.start\": {\n \"$gt\": \"2021-08-01T00:00:00Z\"\n }\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n }'","response":"{\n \"discountRules\": [\n {\n \"id\": \"15bac455-10d0-4478-8358-e06f697f6180\",\n \"revision\": \"8\",\n \"createdDate\": \"2022-08-07T08:12:22.347Z\",\n \"updatedDate\": \"2022-08-09T07:45:44.044Z\",\n \"active\": true,\n \"name\": \"10% discount when buying over 100$ and 5 items\",\n \"trigger\": {\n \"and\": {\n \"triggers\": [\n {\n \"subtotalRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": \"100\",\n \"to\": null\n },\n \"triggerType\": \"SUBTOTAL_RANGE\"\n },\n {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n ]\n },\n \"triggerType\": \"AND\"\n },\n \"activeTimeInfo\": {\n \"start\": \"2022-08-07T08:11:00Z\",\n \"end\": \"2022-08-11T07:43:00Z\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ]\n },\n \"percentage\": 10,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 1\n },\n {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"revision\": \"40\",\n \"createdDate\": \"2023-02-28T11:56:05.996Z\",\n \"updatedDate\": \"2023-04-02T08:34:37.998Z\",\n \"active\": false,\n \"name\": \"10$ off Duffle Bags\",\n \"trigger\": null,\n \"activeTimeInfo\": {\n \"start\": \"2023-02-28T11:55:00Z\",\n \"end\": null\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"c31f8d152077bab24065f01c0e3152b746c54ce0\"\n ]\n }\n }\n }\n ]\n },\n \"fixedAmount\": \"10\",\n \"discountType\": \"FIXED_AMOUNT\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 6\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 8,\n \"cursors\": {\n \"next\": \"c21acd2f5eb388517dd9c781a9ba42b9e51ca540.ElAqTgo-ChRhY3RpdmVUaW1lSW5mby5zdGFydBImKiQKIgoDJGd0EhsqGQoXCgokdGltZXN0YW1wEgkRAAAAKvCvd0IKDAoGYWN0aXZlEgIgACIkMzUxMjAxMDUtMTMyNy00NjI0LThmN2YtMjcyMGRjYmFiNGQ2\",\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/discount-rules/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.discounts.DiscountRuleService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.DISCOUNT_RULES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"protoArtifactId":"com.wixpress.ecom.discounts:discount-rules-service","serviceArtifactId":"com.wixpress.ecom.discounts.discount-rules-service","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.discounts.QueryDiscountRulesRequest","responseMessage":"com.wix.ecom.discounts.QueryDiscountRulesResponse"},"legacyExamples":[{"name":"QueryDiscountRules","type":"METHOD","order":1,"content":{"title":"Query Discount Rules","description":"Query Discount rules by active and start date fields, sorted by name","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/discount-rules/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"name\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"active\": true,\n \"activeTimeInfo.start\": {\n \"$gt\": \"2021-08-01T00:00:00Z\"\n }\n },\n \"cursorPaging\": {\n \"limit\": 2\n }\n }\n }'","response":"{\n \"discountRules\": [\n {\n \"id\": \"15bac455-10d0-4478-8358-e06f697f6180\",\n \"revision\": \"8\",\n \"createdDate\": \"2022-08-07T08:12:22.347Z\",\n \"updatedDate\": \"2022-08-09T07:45:44.044Z\",\n \"active\": true,\n \"name\": \"10% discount when buying over 100$ and 5 items\",\n \"trigger\": {\n \"and\": {\n \"triggers\": [\n {\n \"subtotalRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": \"100\",\n \"to\": null\n },\n \"triggerType\": \"SUBTOTAL_RANGE\"\n },\n {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ],\n \"from\": 5,\n \"to\": null\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n ]\n },\n \"triggerType\": \"AND\"\n },\n \"activeTimeInfo\": {\n \"start\": \"2022-08-07T08:11:00Z\",\n \"end\": \"2022-08-11T07:43:00Z\"\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"specific_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": [\n \"f150b16a-79ef-ef81-50f9-22e2df631822\",\n \"187a07f6-b670-0650-c891-d60aeb797ee0\"\n ]\n }\n }\n ]\n },\n \"percentage\": 10,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 1\n },\n {\n \"id\": \"35120105-1327-4624-8f7f-2720dcbab4d6\",\n \"revision\": \"40\",\n \"createdDate\": \"2023-02-28T11:56:05.996Z\",\n \"updatedDate\": \"2023-04-02T08:34:37.998Z\",\n \"active\": false,\n \"name\": \"10$ off Duffle Bags\",\n \"trigger\": null,\n \"activeTimeInfo\": {\n \"start\": \"2023-02-28T11:55:00Z\",\n \"end\": null\n },\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"collections_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CUSTOM_FILTER\",\n \"customFilter\": {\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"params\": {\n \"collectionIds\": [\n \"c31f8d152077bab24065f01c0e3152b746c54ce0\"\n ]\n }\n }\n }\n ]\n },\n \"fixedAmount\": \"10\",\n \"discountType\": \"FIXED_AMOUNT\"\n }\n ]\n },\n \"status\": \"LIVE\",\n \"usageCount\": 6\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 8,\n \"cursors\": {\n \"next\": \"c21acd2f5eb388517dd9c781a9ba42b9e51ca540.ElAqTgo-ChRhY3RpdmVUaW1lSW5mby5zdGFydBImKiQKIgoDJGd0EhsqGQoXCgokdGltZXN0YW1wEgkRAAAAKvCvd0IKDAoGYWN0aXZlEgIgACIkMzUxMjAxMDUtMTMyNy00NjI0LThmN2YtMjcyMGRjYmFiNGQ2\",\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Discount Rules","slugifiedName":"query-discount-rules"}}],"webhooks":[{"summary":"Discount Rule Created","title":"Discount Rule Created","description":"Triggered when a discount rule is created.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.discounts.v1.discount_rule_created","legacyExamples":[{"name":"DiscountRuleCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"18b3a857-131e-47b1-8748-3c4d362511f3\",\n \"entityEventSequence\": \"1\",\n \"slug\": \"created\",\n \"id\": \"44a04c22-73cb-457c-96fd-ef4438e84490\",\n \"createdEvent\": {\n \"entity\": {\n \"usageCount\": 0,\n \"name\": \"15% on all products when buying more than 5 items\",\n \"revision\": \"1\",\n \"id\": \"18b3a857-131e-47b1-8748-3c4d362511f3\",\n \"status\": \"LIVE\",\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"offer\": \"15% off\\nAll products\",\n \"updatedDate\": \"2023-06-28T12:43:22.739Z\",\n \"createdDate\": \"2023-06-28T12:43:22.739Z\",\n \"active\": true,\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n }\n },\n \"entityFqdn\": \"wix.ecom.discounts.v1.discount_rule\",\n \"eventTime\": \"2023-06-28T12:43:22.747473Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","contentLink":{"displayName":"Discount Rule Created","slugifiedName":"discount-rule-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Discount Rule Updated","title":"Discount Rule Updated","description":"Triggered when a discount rule is updated.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.discounts.v1.discount_rule_updated","legacyExamples":[{"name":"DiscountRuleUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"18b3a857-131e-47b1-8748-3c4d362511f3\",\n \"entityEventSequence\": \"2\",\n \"slug\": \"updated\",\n \"id\": \"656ddf67-99fc-44ab-b3b1-6f99623328fd\",\n \"entityFqdn\": \"wix.ecom.discounts.v1.discount_rule\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"usageCount\": 0,\n \"name\": \"New discount name\",\n \"revision\": \"2\",\n \"id\": \"18b3a857-131e-47b1-8748-3c4d362511f3\",\n \"status\": \"LIVE\",\n \"discounts\": {\n \"values\": [\n {\n \"targetType\": \"SPECIFIC_ITEMS\",\n \"specificItemsInfo\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ]\n },\n \"percentage\": 15,\n \"discountType\": \"PERCENTAGE\"\n }\n ]\n },\n \"offer\": \"15% off\\nAll products\",\n \"updatedDate\": \"2023-06-28T12:51:41.482Z\",\n \"createdDate\": \"2023-06-28T12:43:22.739Z\",\n \"active\": true,\n \"trigger\": {\n \"itemQuantityRange\": {\n \"scopes\": [\n {\n \"id\": \"all_215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"type\": \"CATALOG_ITEM\",\n \"catalogItemFilter\": {\n \"catalogAppId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n \"catalogItemIds\": []\n }\n }\n ],\n \"from\": 5\n },\n \"triggerType\": \"ITEM_QUANTITY_RANGE\"\n }\n }\n },\n \"eventTime\": \"2023-06-28T12:51:41.489714Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","contentLink":{"displayName":"Discount Rule Updated","slugifiedName":"discount-rule-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Discount Rule Deleted","title":"Discount Rule Deleted","description":"Triggered when a discount rule is deleted.","permissions":["ECOM.DISCOUNT_RULES_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.ecom.discounts.v1.discount_rule","serviceName":"com.wix.ecom.discounts.DiscountRuleService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"}],"eventType":"wix.ecom.discounts.v1.discount_rule_deleted","legacyExamples":[{"name":"DiscountRuleDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"18b3a857-131e-47b1-8748-3c4d362511f3\",\n \"slug\": \"deleted\",\n \"id\": \"14129e3b-30e9-496f-ab3f-90d1ca82899e\",\n \"entityFqdn\": \"wix.ecom.discounts.v1.discount_rule\",\n \"deletedEvent\": {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2023-06-28T12:53:01.736091Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","contentLink":{"displayName":"Discount Rule Deleted","slugifiedName":"discount-rule-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Discount Rules API\n\nThe Wix eCommerce Discount Rules API allows you to create and manage discount rules.\nDiscount rules are sets of triggers and scopes that together define the necessary conditions for a discount to apply to items in the cart/checkout.\n\nWith the Discount Rules API, you can:\n\n+ [Create](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/create-discount-rule), [update](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/update-discount-rule), and [delete](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/delete-discount-rule) discount rules.\n+ [Get](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/get-discount-rule) and [query](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/query-discount-rules) discount rules.\n\n## Before you begin\n\n+ Currently only item-level discounts are supported. Discounts for an entire cart/checkout are not yet supported.\n+ Up to 5 triggers can be chained together.\n\n## Terminology\n\n- **Discount rule:** A set of conditions (scope and trigger) that dictate whether an item qualifies for a specified discount.\n\n- **Discount:** The change applied to an item's price when conditions are met. Discounts can reduce an item's price by percentage or a specified amount, and also by setting an item to a fixed price.\n - Discounts must have a defined scope/s\n\n\n- **Scope:** A group of catalog items that qualify for a discount.\n - Every catalog has up to 2 scopes \"out of the box\". For example, Wix Stores has `Specific Products` and `All Products` scopes.\n - Scopes are required in default triggers and discount objects.\n - Triggers and discounts can have multiple scopes.\n\n\n- **Trigger**: A set of conditions that must be met for a discount to become applicable. Triggers can be chained so that more than 1 condition must be met.\n - **Default triggers:** These built-in triggers fire when a specified minimum/maximum item quantity (for example, \"at least 5 items\") or cart subtotal (\"no more than $100\") is reached. For this trigger to fire, the items must also be part of a defined scope.\n - **Custom triggers:** Using the [Custom Trigger Integration service plugin](fallback::https://dev.wix.com/api/rest/wix-ecommerce/custom-discount-triggers-integration-spi) you can provide any set of conditions you want. For example, a trigger that only fires for grey items, or only between 8pm-10pm on Mondays and Thursdays.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"proto/appendices/docs/intro.md"}],"components":{"schemas":{"com.wix.ecom.discounts.DiscountRule":{"type":"object","properties":{"id":{"description":"Discount rule ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the discount rule is updated.\nTo prevent conflicting changes, the current `revision` must be passed when updating the discount rule.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the discount rule was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the discount rule was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"active":{"description":"Whether the discount rule is active.\n\nDefault: `true`","title":"active","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Discount rule name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trigger":{"description":"Discount rule trigger.\nA set of conditions that must be met for the `discounts` to be applied.\nNot passing a trigger will cause the discount to always apply.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger","summary":"trigger","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activeTimeInfo":{"description":"Time frame in which the discount rule is active.","$ref":"#/components/schemas/com.wix.ecom.discounts.ActiveTimeInfo","summary":"activeTimeInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discounts":{"description":"List of discounts that are applied when one or more triggers are met.\n\n> **Notes:**\n>\n> + Currently, only 1 discount can be defined per discount rule.\n> + A discount rule can be applied on multiple items per cart.\n> + A discount rule can only be applied once per item.","$ref":"#/components/schemas/com.wix.ecom.discounts.Discounts","summary":"discounts","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Discount rule status.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"usageCount":{"description":"Number of times the discount rule was used.","readOnly":true,"title":"usageCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountRule","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","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":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wix.ecom.discounts.DiscountTrigger":{"type":"object","properties":{"triggerType":{"description":"Trigger type.\n\n+ `AND`: Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported.\n+ `SUBTOTAL_RANGE`: Subtotal must be within the specified `subtotalRange` values.\n+ `ITEM_QUANTITY_RANGE`: Quantity of items in scope must be within specified `itemQuantityRange` values.\n+ `CUSTOM`: Custom trigger type defined in `customTrigger` object.","title":"triggerType","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.TriggerType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountTrigger","description":"DiscountTrigger - description of a set of conditions, that if met, will trigger the associated rule actions","oneOf":[{"description":"","summary":"trigger","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.trigger"}]},"com.wix.ecom.discounts.DiscountTrigger.trigger":{"type":"object","title":"trigger","properties":{"and":{"description":"Chain multiple triggers with the `and` operator.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.And","summary":"and","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"or":{"description":"Chain multiple triggers with the `or` operator.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.Or","summary":"or","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customTrigger":{"description":"Custom trigger.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.Custom","summary":"customTrigger","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subtotalRange":{"description":"Subtotal trigger range.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.SubtotalRange","summary":"subtotalRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemQuantityRange":{"description":"Item quantity trigger range.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger.ItemQuantityRange","summary":"itemQuantityRange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wix.ecom.discounts.Scope":{"type":"object","properties":{"id":{"description":"Scope ID.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Scope type.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.ScopeType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Scope","description":"This object represents a scope of catalog items. Examples:\n1. All catalog items of a specific app - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id`\n2. Specific catalog item - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id` + `catalog_item_ids`\n3. External catalog filter - type = CUSTOM_FILTER, CustomFilter with 'app_id' + 'params'","oneOf":[{"description":"","summary":"ScopeItems","$ref":"#/components/schemas/com.wix.ecom.discounts.Scope.ScopeItems"}]},"com.wix.ecom.discounts.Scope.ScopeItems":{"type":"object","title":"ScopeItems","properties":{"catalogItemFilter":{"description":"Catalog item filter. Must be passed with `type.\"CATALOG_ITEM\"`.","$ref":"#/components/schemas/com.wix.ecom.discounts.CatalogItemFilter","summary":"catalogItemFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customFilter":{"description":"Custom filter. Must be passed with `type.\"CATALOG_ITEM\"`.","$ref":"#/components/schemas/com.wix.ecom.discounts.CustomFilter","summary":"customFilter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.discounts.ScopeType":{"type":"string","description":"","title":"ScopeType","enum":["UNDEFINED_SCOPE","CATALOG_ITEM","CUSTOM_FILTER"]},"com.wix.ecom.discounts.CatalogItemFilter":{"type":"object","properties":{"catalogAppId":{"description":"Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`.","format":"GUID","title":"catalogAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"catalogItemIds":{"description":"ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores.","minLength":1,"maxLength":36,"minItems":0,"maxItems":50,"title":"catalogItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CatalogItemFilter","description":""},"com.wix.ecom.discounts.CustomFilter":{"type":"object","properties":{"appId":{"description":"Custom filter app ID, when relevant.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"params":{"description":"Custom filter in `{ \"key\": \"value\" }` form.\nFor example, an array of `collectionIDs`:\n`{ [\"collectionId\": \"12345\"], [\"collectionId\": \"67890\"] }`.","title":"params","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomFilter","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wix.ecom.discounts.DiscountTrigger.And":{"type":"object","properties":{"triggers":{"description":"List of triggers.\nMax: 5 triggers.","minItems":2,"maxItems":5,"title":"triggers","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"And","description":""},"com.wix.ecom.discounts.DiscountTrigger.Or":{"type":"object","properties":{"triggers":{"description":"","minItems":2,"maxItems":5,"title":"triggers","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTrigger"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Or","description":""},"com.wix.ecom.discounts.DiscountTrigger.Custom":{"type":"object","properties":{"id":{"description":"Trigger ID.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that created the trigger.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Custom","description":""},"com.wix.ecom.discounts.DiscountTrigger.SubtotalRange":{"type":"object","properties":{"scopes":{"description":"Relevant scopes for `SPECIFIC_ITEMS` target type.","maxItems":50,"title":"scopes","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"from":{"description":"Minimum subtotal price (inclusive).","title":"from","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"to":{"description":"Maximum subtotal price (inclusive).","title":"to","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}}},"title":"SubtotalRange","description":""},"com.wix.ecom.discounts.DiscountTrigger.ItemQuantityRange":{"type":"object","properties":{"scopes":{"description":"Relevant scopes for `SPECIFIC_ITEMS` target type.","maxItems":50,"title":"scopes","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"from":{"description":"Minimum item quantity (inclusive).","minimum":1,"title":"from","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Maximum item quantity (inclusive).","minimum":1,"title":"to","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemQuantityRange","description":""},"com.wix.ecom.discounts.DiscountTrigger.TriggerType":{"type":"string","description":"","title":"TriggerType","enum":["UNDEFINED","AND","SUBTOTAL_RANGE","ITEM_QUANTITY_RANGE","CUSTOM","OR"]},"com.wix.ecom.discounts.ActiveTimeInfo":{"type":"object","properties":{"start":{"description":"Date and time the discount rule is active **from**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.","title":"start","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"end":{"description":"Date and time the discount rule is active **till**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.","title":"end","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActiveTimeInfo","description":""},"com.wix.ecom.discounts.Discounts":{"type":"object","properties":{"values":{"description":"Discounts.","minItems":1,"maxItems":1,"title":"values","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Discount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Discounts","description":""},"com.wix.ecom.discounts.Discount":{"type":"object","properties":{"targetType":{"description":"Discount target.\n\n+ `SPECIFIC_ITEMS`: Discount applies to a specific set of items.","title":"targetType","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTarget.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"specificItemsInfo":{"description":"Data related to `SPECIFIC_ITEMS` target type.","$ref":"#/components/schemas/com.wix.ecom.discounts.SpecificItemsInfo","summary":"specificItemsInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountType":{"description":"Discount type.\n\n+ `PERCENTAGE`: Price is reduced by percentage value.\n+ `FIXED_AMOUNT`: Price is reduced by fixed amount.\n+ `FIXED_PRICE`: Price will be set to fixed amount.","title":"discountType","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.Discount.DiscountType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Discount","description":"","oneOf":[{"description":"","summary":"discount","$ref":"#/components/schemas/com.wix.ecom.discounts.Discount.discount"}]},"com.wix.ecom.discounts.Discount.discount":{"type":"object","title":"discount","properties":{"percentage":{"description":"Percentage to discount from original price.","minimum":0.1,"maximum":100,"title":"percentage","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fixedAmount":{"description":"Amount to discount from original price.","title":"fixedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","lte":"1000000000000000"}}},"fixedPrice":{"description":"Fixed price. Line item will be fixed to this price.","title":"fixedPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}}}},"com.wix.ecom.discounts.DiscountTarget.Type":{"type":"string","description":"","title":"Type","enum":["UNDEFINED","SPECIFIC_ITEMS","BUY_X_GET_Y"]},"com.wix.ecom.discounts.SpecificItemsInfo":{"type":"object","properties":{"scopes":{"description":"All associated scopes for `SPECIFIC_ITEMS` target type.","minItems":1,"maxItems":50,"title":"scopes","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpecificItemsInfo","description":""},"com.wix.ecom.discounts.Discount.DiscountType":{"type":"string","description":"","title":"DiscountType","enum":["UNDEFINED","PERCENTAGE","FIXED_AMOUNT","FIXED_PRICE"]},"com.wix.ecom.discounts.BuyXGetYInfo":{"type":"object","properties":{"customerBuys":{"description":"Information about which items must be in the cart (buy X) for the discount to apply (get Y).","$ref":"#/components/schemas/com.wix.ecom.discounts.CustomerBuy","summary":"customerBuys","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customerGets":{"description":"Information about which items will be discounted (get Y).","$ref":"#/components/schemas/com.wix.ecom.discounts.CustomerGet","summary":"customerGets","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"The maximum number of times the 'buy X get Y' discount can be applied.\nFor example, when the value of `limit` is `2`, with a \"2+1\" sale on all items, the following logic applies:\n+ Buy 2 get 1, buy 3 get 1.\n+ Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on.","minimum":1,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BuyXGetYInfo","description":""},"com.wix.ecom.discounts.CustomerBuy":{"type":"object","properties":{"scopes":{"description":"Scopes of the items that must be added to the cart to enable the discount.","minItems":1,"maxItems":50,"title":"scopes","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomerBuy","description":"","oneOf":[{"description":"","summary":"condition","$ref":"#/components/schemas/com.wix.ecom.discounts.CustomerBuy.condition"}]},"com.wix.ecom.discounts.CustomerBuy.condition":{"type":"object","title":"condition","properties":{"minimumQuantity":{"description":"Minimum number of items the customer must add to the cart to be eligible for a discount.","minimum":1,"title":"minimumQuantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minimumSpend":{"description":"Minimum price the customer must add to the cart to be eligible for a discount.","title":"minimumSpend","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}}}},"com.wix.ecom.discounts.CustomerGet":{"type":"object","properties":{"quantity":{"description":"Exact number of items in the cart that will be discounted.\nIf the cart contains fewer items than the value of quantity, the discount will not apply.","minimum":1,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scopes":{"description":"Scopes of the items that will be discounted.","minItems":1,"maxItems":50,"title":"scopes","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.Scope"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomerGet","description":""},"com.wix.ecom.discounts.DiscountRule.Status":{"type":"string","description":"","title":"Status","enum":["UNDEFINED","LIVE","EXPIRED","PENDING"]},"com.wix.ecom.discounts.DiscountSettings":{"type":"object","properties":{"appliesTo":{"description":"Discount applies to either `ALL_ITEMS`, or to the `LOWEST_PRICED_ITEM`.","title":"appliesTo","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountSettings.AppliedSubjectType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeSubscription":{"description":"Whether the discount will apply to subscriptions.\n\nDefault: `false`","title":"includeSubscription","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"usageLimit":{"description":"Maximum total number of uses allowed for the discount rule.","minimum":1,"maximum":2147483646,"title":"usageLimit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"usageLimitPerUser":{"description":"The usage limit per user per discount.\nWhen not provided, this setting will not apply.","minimum":1,"maximum":2147483646,"title":"usageLimitPerUser","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountSettings","description":"The discount settings"},"com.wix.ecom.discounts.DiscountSettings.AppliedSubjectType":{"type":"string","description":"TODO: check if can be removed","title":"AppliedSubjectType","enum":["UNDEFINED","ALL_ITEMS","LOWEST_PRICED_ITEM"]},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"com.wix.ecom.discounts.CreateDiscountRuleRequest":{"type":"object","properties":{"discountRule":{"description":"Discount rule info.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDiscountRuleRequest","description":""},"com.wix.ecom.discounts.CreateDiscountRuleResponse":{"type":"object","properties":{"discountRule":{"description":"Discount rule.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDiscountRuleResponse","description":""},"com.wix.ecom.discounts.GetDiscountRuleRequest":{"type":"object","properties":{"discountRuleId":{"description":"ID of the discount rule to retrieve.","format":"GUID","title":"discountRuleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDiscountRuleRequest","description":""},"com.wix.ecom.discounts.GetDiscountRuleResponse":{"type":"object","properties":{"discountRule":{"description":"The requested discount rule.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDiscountRuleResponse","description":""},"com.wix.ecom.discounts.UpdateDiscountRuleRequest":{"type":"object","properties":{"discountRule":{"description":"Discount rule info.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDiscountRuleRequest","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":""},"com.wix.ecom.discounts.UpdateDiscountRuleResponse":{"type":"object","properties":{"discountRule":{"description":"Updated discount rule.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"discountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDiscountRuleResponse","description":""},"com.wix.ecom.discounts.DeleteDiscountRuleRequest":{"type":"object","properties":{"discountRuleId":{"description":"ID of the discount rule to delete.","format":"GUID","title":"discountRuleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteDiscountRuleRequest","description":""},"com.wix.ecom.discounts.DeleteDiscountRuleResponse":{"type":"object","properties":{},"title":"DeleteDiscountRuleResponse","description":""},"com.wix.ecom.discounts.QueryDiscountRulesRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDiscountRulesRequest","description":""},"com.wix.ecommerce.commons.api.PlatformQuery":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`.","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformQuery.pagingMethod"}]},"com.wix.ecommerce.commons.api.PlatformQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Pointer to page of results using offset. Cannot be used together with `cursorPaging`.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wix.ecommerce.commons.api.PlatformPaging":{"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":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformPaging","description":""},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wix.ecom.discounts.QueryDiscountRulesResponse":{"type":"object","properties":{"discountRules":{"description":"List of discount rules.","title":"discountRules","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.PlatformPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDiscountRulesResponse","description":""},"com.wix.ecommerce.commons.api.PlatformPagingMetadata":{"type":"object","properties":{"count":{"description":"The number of items returned in this response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"The offset which was requested. Returned if offset paging was used.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"The total number of items that match the query. Returned if offset paging was used.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through result pages. Returned if cursor paging was used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformPagingMetadata","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wix.ecom.discounts.GetAppliedDiscountsRequest":{"type":"object","properties":{"lineItems":{"description":"Line items for which to check for discount rules.","maxItems":1000,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.LineItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"purchaseFlowId":{"description":"","format":"GUID","title":"purchaseFlowId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAppliedDiscountsRequest","description":""},"com.wix.ecom.discounts.LineItem":{"type":"object","properties":{"id":{"description":"Line item ID.","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Line item quantity.","minimum":0,"maximum":100000,"title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"catalogReference":{"description":"Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).","$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference","summary":"catalogReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Line item price.","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0"}}}},"title":"LineItem","description":""},"com.wix.ecommerce.catalog_spi.api.v1.CatalogReference":{"type":"object","properties":{"catalogItemId":{"description":"ID of the item within the catalog it belongs to.","minLength":1,"maxLength":36,"title":"catalogItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`","minLength":1,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"options":{"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).","title":"options","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CatalogReference","description":"Used for grouping line items. Sent when an item is added to a cart, checkout, or order."},"com.wix.ecom.discounts.GetAppliedDiscountsResponse":{"type":"object","properties":{"appliedDiscounts":{"description":"All eligible discounts.","title":"appliedDiscounts","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.discounts.AppliedDiscount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAppliedDiscountsResponse","description":""},"com.wix.ecom.discounts.AppliedDiscount":{"type":"object","properties":{"discountType":{"description":"Discount type.","title":"discountType","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountTarget.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemIds":{"description":"IDs of line items the discount applies to, in GUID format.","format":"GUID","maxItems":1000,"title":"lineItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliedDiscountRule":{"description":"Applied discount rule.","$ref":"#/components/schemas/com.wix.ecom.discounts.AppliedDiscountRule","summary":"appliedDiscountRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppliedDiscount","description":""},"com.wix.ecom.discounts.AppliedDiscountRule":{"type":"object","properties":{"id":{"description":"Applied discount rule ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Discount rule name.","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRuleName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Total amount reduced from all discounted line items.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.MultiCurrencyPrice","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountRuleType":{"description":"Discount rule type.","title":"discountRuleType","type":"string","$ref":"#/components/schemas/com.wix.ecom.discounts.Discount.DiscountType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AppliedDiscountRule","description":""},"com.wix.ecom.discounts.DiscountRuleName":{"type":"object","properties":{"original":{"description":"Original discount rule name (in site's default language).","minLength":1,"maxLength":256,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Translated discount rule name according to buyer language.\n\nDefault: `original`","minLength":1,"maxLength":500,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountRuleName","description":""},"com.wix.ecommerce.platform_common.api.MultiCurrencyPrice":{"type":"object","properties":{"amount":{"description":"Amount.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"convertedAmount":{"description":"Converted amount.","readOnly":true,"title":"convertedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"formattedAmount":{"description":"Amount formatted with currency symbol.","readOnly":true,"title":"formattedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedConvertedAmount":{"description":"Converted amount formatted with currency symbol.","readOnly":true,"title":"formattedConvertedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultiCurrencyPrice","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.UndeleteInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UndeleteInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wix.ecom.discounts.DiscountRuleUsageLimitReached":{"type":"object","properties":{"rule":{"description":"Discount Rule","$ref":"#/components/schemas/com.wix.ecom.discounts.DiscountRule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountRuleUsageLimitReached","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":"Discount Rule","description":"Manage Discount Rules.","fqdn":"wix.ecom.discounts.v1.discount_rule"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Discount Rules API\n\nThe Wix eCommerce Discount Rules API allows you to create and manage discount rules.\nDiscount rules are sets of triggers and scopes that together define the necessary conditions for a discount to apply to items in the cart/checkout.\n\nWith the Discount Rules API, you can:\n\n+ [Create](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/create-discount-rule), [update](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/update-discount-rule), and [delete](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/delete-discount-rule) discount rules.\n+ [Get](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/get-discount-rule) and [query](fallback::https://dev.wix.com/api/rest/wix-ecommerce/discount-rules/query-discount-rules) discount rules.\n\n## Before you begin\n\n+ Currently only item-level discounts are supported. Discounts for an entire cart/checkout are not yet supported.\n+ Up to 5 triggers can be chained together.\n\n## Terminology\n\n- **Discount rule:** A set of conditions (scope and trigger) that dictate whether an item qualifies for a specified discount.\n\n- **Discount:** The change applied to an item's price when conditions are met. Discounts can reduce an item's price by percentage or a specified amount, and also by setting an item to a fixed price.\n - Discounts must have a defined scope/s\n\n\n- **Scope:** A group of catalog items that qualify for a discount.\n - Every catalog has up to 2 scopes \"out of the box\". For example, Wix Stores has `Specific Products` and `All Products` scopes.\n - Scopes are required in default triggers and discount objects.\n - Triggers and discounts can have multiple scopes.\n\n\n- **Trigger**: A set of conditions that must be met for a discount to become applicable. Triggers can be chained so that more than 1 condition must be met.\n - **Default triggers:** These built-in triggers fire when a specified minimum/maximum item quantity (for example, \"at least 5 items\") or cart subtotal (\"no more than $100\") is reached. For this trigger to fire, the items must also be part of a defined scope.\n - **Custom triggers:** Using the [Custom Trigger Integration service plugin](fallback::https://dev.wix.com/api/rest/wix-ecommerce/custom-discount-triggers-integration-spi) you can provide any set of conditions you want. For example, a trigger that only fires for grey items, or only between 8pm-10pm on Mondays and Thursdays.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Query Discount Rules

Permission Scopes