[Discounts] REST API

docs/api/rest_api/rest_api_reference/input/examples/discount_codes/apply/POST/DiscountCode.json.example

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

docs/api/rest_api/rest_api_reference/input/examples/discount_codes/apply/POST/DiscountCodeResponse.json.example

@@ -0,0 +1,12 @@
+{
+    "DiscountCode": {
+        "_media-type": "application\/vnd.ibexa.api.DiscountCode+json",
+        "id": 1,
+        "code": "summer10",
+        "created_at": {
+            "date": "2025-06-10 14:14:06.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        }
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/Discount.json.example

@@ -0,0 +1,45 @@
+{
+    "Discount": {
+        "_media-type": "application/vnd.ibexa.api.Discount+json",
+        "id": 1,
+        "identifier": "summersale2025",
+        "name": "SummerSale2025",
+        "type": "catalog",
+        "label": "Summer Sale 2025",
+        "labelDescription": "Summer Sale 2025",
+        "priority": 1,
+        "isEnabled": true,
+        "createdAt": "2025-06-10T09:43:42+00:00",
+        "updatedAt": "2025-06-10T09:48:23+00:00",
+        "startDate": "2025-07-01T09:34:19+00:00",
+        "endDate": "2025-07-31T12:00:00+00:00",
+        "DiscountExpressionAware": {
+            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+            "expressionValues": {
+                "discount_amount": "10"
+            }
+        },
+        "DiscountConditions": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                "expressionValues": {
+                    "currency_code": "USD"
+                }
+            }
+        ],
+        "DiscountTranslations": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
+                "languageCode": {},
+                "name": "SummerSale2025",
+                "description": null,
+                "label": "Summer Sale 2025",
+                "labelDescription": "Summer Sale 2025"
+            }
+        ]
+    },
+    "isDiscountCodeAware": {
+        "_media-type": "application/vnd.ibexa.api.isDiscountCodeAware+json",
+        "isDiscountCodeAware": false
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/DiscountList.json.example

@@ -0,0 +1,102 @@
+{
+    "DiscountList": {
+        "_media-type": "application/vnd.ibexa.api.DiscountList+json",
+        "Discount": [
+            {
+                "_media-type": "application/vnd.ibexa.api.Discount+json",
+                "id": 1,
+                "identifier": "summersale2025",
+                "name": "SummerSale2025",
+                "type": "catalog",
+                "label": "Summer Sale 2025",
+                "labelDescription": "Summer Sale 2025",
+                "priority": 1,
+                "isEnabled": true,
+                "createdAt": "2025-06-10T09:43:42+00:00",
+                "updatedAt": "2025-06-10T09:48:23+00:00",
+                "startDate": "2025-07-01T09:34:19+00:00",
+                "endDate": "2025-07-31T12:00:00+00:00",
+                "DiscountExpressionAware": {
+                    "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                    "expressionValues": {
+                        "discount_amount": "10"
+                    }
+                },
+                "DiscountConditions": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                        "expressionValues": {
+                            "currency_code": "USD"
+                        }
+                    }
+                ],
+                "DiscountTranslations": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
+                        "languageCode": {},
+                        "name": "SummerSale2025",
+                        "description": null,
+                        "label": "Summer Sale 2025",
+                        "labelDescription": "Summer Sale 2025"
+                    }
+                ]
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.isDiscountCodeAware+json",
+                "isDiscountCodeAware": false
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.Discount+json",
+                "id": 2,
+                "identifier": "my_discount",
+                "name": "Another discount",
+                "type": "cart",
+                "label": "another",
+                "labelDescription": "another label description",
+                "priority": 10,
+                "isEnabled": false,
+                "createdAt": "2025-06-10T11:03:37+00:00",
+                "updatedAt": "2025-06-10T14:14:06+00:00",
+                "startDate": "2025-04-01T12:12:12+00:00",
+                "DiscountExpressionAware": {
+                    "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                    "expressionValues": {
+                        "discount_percentage": "10"
+                    }
+                },
+                "DiscountConditions": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                        "expressionValues": {
+                            "discount_code": "my_secret_code",
+                            "usage_count": 1
+                        }
+                    },
+                    {
+                        "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                        "expressionValues": {
+                            "categories": [
+                                1,
+                                3
+                            ]
+                        }
+                    }
+                ],
+                "DiscountTranslations": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
+                        "languageCode": {},
+                        "name": "Another discount",
+                        "description": "another great discount",
+                        "label": "another",
+                        "labelDescription": "another label description"
+                    }
+                ]
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.isDiscountCodeAware+json",
+                "isDiscountCodeAware": true
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/POST/DiscountCreate.json.example

@@ -0,0 +1,29 @@
+{
+    "DiscountCreate": {
+        "identifier": "my_discount",
+        "type": "cart",
+        "priority": 10,
+        "isEnabled": true,
+        "userId": 14,
+        "rule": {
+            "type": "percentage",
+            "amount": 10
+        },
+        "startDate": "2025-04-01 12:12:12",
+        "translations": [
+            {
+                "languageCode": "eng-GB",
+                "name": "Another discount",
+                "description": "another great discount",
+                "label": "another",
+                "labelDescription": "another label description"
+            }
+        ],
+        "conditions": [
+            {
+                "class": "Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCategory",
+                "parameters": [["1", "2"]]
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/POST/DiscountCreateResponse.json.example

@@ -0,0 +1,47 @@
+{
+    "Discount": {
+        "_media-type": "application/vnd.ibexa.api.Discount+json",
+        "id": 2,
+        "identifier": "my_discount",
+        "name": "Another discount",
+        "type": "cart",
+        "label": "another",
+        "labelDescription": "another label description",
+        "priority": 10,
+        "isEnabled": true,
+        "createdAt": "2025-06-10T11:03:37+00:00",
+        "updatedAt": "2025-06-10T11:03:37+00:00",
+        "startDate": "2025-04-01T12:12:12+00:00",
+        "DiscountExpressionAware": {
+            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+            "expressionValues": {
+                "discount_percentage": "10"
+            }
+        },
+        "DiscountConditions": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                "expressionValues": {
+                    "categories": [
+                        "1",
+                        "2"
+                    ]
+                }
+            }
+        ],
+        "DiscountTranslations": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
+                "languageCode": {},
+                "name": "Another discount",
+                "description": "another great discount",
+                "label": "another",
+                "labelDescription": "another label description"
+            }
+        ]
+    },
+    "isDiscountCodeAware": {
+        "_media-type": "application/vnd.ibexa.api.isDiscountCodeAware+json",
+        "isDiscountCodeAware": false
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/identifier/PATCH/DiscountUpdate.json.example

@@ -0,0 +1,11 @@
+{
+    "DiscountUpdate": {
+        "identifier": "my_discount",
+        "conditions": [
+            {
+                "class": "Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCategory",
+                "parameters": [["1", "3"]]
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/discounts/identifier/PATCH/DiscountUpdateResponse.json.example

@@ -0,0 +1,47 @@
+{
+    "Discount": {
+        "_media-type": "application/vnd.ibexa.api.Discount+json",
+        "id": 2,
+        "identifier": "my_discount",
+        "name": "Another discount",
+        "type": "cart",
+        "label": "another",
+        "labelDescription": "another label description",
+        "priority": 10,
+        "isEnabled": false,
+        "createdAt": "2025-06-10T11:03:37+00:00",
+        "updatedAt": "2025-06-10T13:05:56+00:00",
+        "startDate": "2025-04-01T12:12:12+00:00",
+        "DiscountExpressionAware": {
+            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+            "expressionValues": {
+                "discount_percentage": "10"
+            }
+        },
+        "DiscountConditions": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
+                "expressionValues": {
+                    "categories": [
+                        "1",
+                        "3"
+                    ]
+                }
+            }
+        ],
+        "DiscountTranslations": [
+            {
+                "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json",
+                "languageCode": {},
+                "name": "Another discount",
+                "description": "another great discount",
+                "label": "another",
+                "labelDescription": "another label description"
+            }
+        ]
+    },
+    "isDiscountCodeAware": {
+        "_media-type": "application/vnd.ibexa.api.isDiscountCodeAware+json",
+        "isDiscountCodeAware": false
+    }
+}

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

@@ -0,0 +1,57 @@
+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. Only JSON is supported.
+                    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: DiscountCodeWrapper
+                    example: !include examples/discount_codes/apply/POST/DiscountCode.json.example
+            responses:
+                200:
+                    description: Discount applied successfully
+                    body:
+                        application/vnd.ibexa.api.DiscountCode+json:
+                            type: DiscountCodeWrapper
+                            example: !include examples/discount_codes/apply/POST/DiscountCodeResponse.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.
+
+    /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: DiscountCodeWrapper
+                    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