Discount codes

Author: mnocon

docs/api/rest_api/rest_api_reference/input/ibexa-discounts-codes.raml

@@ -0,0 +1,56 @@
+displayName: Discount Codes
+/{cartIdentifier}/apply
+    post:
+        displayName: Apply discount to cart
+        description: Applies a discount associated with given discount code
+        headers:
+            Accept:
+                description: Specifies the expected response type. If set, the list is returned in XML or JSON format.
+                example: |
+                    application/vnd.ibexa.api.DiscountCode+json
+            Content-Type:
+                description: Specifies the input type.
+                example: |
+                    application/vnd.ibexa.api.DiscountCode+json
+        body:
+            application/vnd.ibexa.api.DiscountCode+json:
+                type: DiscountCode
+                example: !include examples/discount_codes/apply/POST/DiscountCode.json.example
+        responses:
+            200:
+                description: Action executed successfuly.
+                body:
+                    application/vnd.ibexa.api.DiscountCode+json:
+                        type: DiscountCode
+                        example: !include examples/discount_codes/apply/POST/DiscountCode.json.example
+            400:
+                description: Error - the request is invalid.
+            404:
+                description: Error - the given cart identifier was not found, or the discount code does not exist.
+            429:
+                description: Error - the request was throttled due to too many requests in a short time.
+
+/{cartIdentifier}/drop
+    post:
+        displayName: Remove discount from cart
+        description: Removes the discount associated with given discount code from the cart
+        headers:
+            Accept:
+                description: Specifies the expected response type. Only JSON is supported.
+                example: |
+                    application/vnd.ibexa.api.DiscountCode+json
+            Content-Type:
+                description: Specifies the input type. Only JSON is supported.
+                example: |
+                    application/vnd.ibexa.api.DiscountCode+json
+        body:
+            application/vnd.ibexa.api.DiscountCode+json:
+                type: DiscountCode
+                example: !include examples/discount_codes/apply/POST/DiscountCode.json.example
+        responses:
+            204:
+                description: Discount code with given discount code was removed from the cart.
+            400:
+                description: Error - the request is invalid.
+            404:
+                description: Error - the given cart identifier was not found

docs/api/rest_api/rest_api_reference/input/ibexa.raml

@@ -81,4 +81,8 @@ baseUri: ../rest_api_usage/rest_api_usage/
 
 /ai: !include ibexa-ai.raml
 
+/discounts: !include ibexa-discounts.raml
+
+/discounts_codes: !include ibexa-discounts-codes.raml
+
 types: !include ibexa-types.raml

examples/discount_codes/apply/POST/DiscountCode.json.example

@@ -0,0 +1,5 @@
+{
+    "DiscountCode": {
+        "code": "summer10"
+    }
+}