[Discounts] REST API #2780

mnocon · 2025-06-10T15:40:38Z

Added description of Discount REST API.

Previews:

github-actions · 2025-06-10T15:47:33Z

Preview of modified files: no change to preview.

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

* [PHP API REF] Added Discount packages * Generated PHP API for Discounts

* [Discounts] Added migration doc * Added files * Update docs/content_management/data_migration/importing_data.md

Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>

* [Discounts] Search overview * Fixes before review * Reworded Type sort clause * Update docs/search/discounts_search_reference/discounts_sort_clauses.md Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com> --------- Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>

* [Discounts] Added event reference * Fixed links * Fixes before review * Removed column

* Mentioned discounts in pricing and customer groups * Before review fixes * Added mention to the PIM guide

* Permissions * Build fixes * Fixed links * Fixed last links * Removed link * Apply suggestions from code review Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com> --------- Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>

* Added update instructions * Fixed link

adriendupuis

Some error responses are missing but this isn't really important.

JSON object type description is incomplete as the wrapped XML part isn't accessible.

adriendupuis · 2025-06-13T08:07:27Z

...est_api_reference/input/examples/discount_codes/apply/POST/DiscountCodeResponse.json.example

+    "DiscountCode": {
+        "_media-type": "application\/vnd.ibexa.api.DiscountCode+json",
+        "id": 1,
+        "code": "my_secret_code",


It doesn't look like the response to the payload example. Shouldn't it be summer10?

Suggested change

"code": "my_secret_code",

"code": "summer10",

adriendupuis · 2025-06-13T09:55:44Z

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

+
+/{id}:
+    get:
+        displayName: Get discount


Optionally this change, see next comment.

Suggested change

displayName: Get discount

displayName: Get discount by ID

adriendupuis · 2025-06-13T09:57:34Z

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

+
+/{identifier}:
+    get:
+        displayName: Get discount


This one can't be reach through the ToC as it has the same name (and therefore anchor) than the previous entry.

Suggested change

displayName: Get discount

displayName: Get discount by identifier

adriendupuis · 2025-06-13T11:09:21Z

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

+    responses:
+        200:
+            body:
+                application/vnd.ibexa.api.Discount+json:
+                    type: DiscountWrapper
+                    example: !include examples/discounts/POST/DiscountCreateResponse.json.example


There is likely some error responses as well. Probably 403 if user haven't the rights to create a discount and 500 if the payload is malformed.
It might not worth spending too much time into completing this in 4.6 RAML. It will be more important in 5.0 OpenAPI.
Remember https://redocly.com/docs/cli/rules/oas/operation-4xx-response 😉

adriendupuis · 2025-06-13T11:34:05Z

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

+DiscountListWrapper:
+    type: object
+    description: 'Wrapper object for DiscountList.'
+    properties:
+        DiscountList:
+            type: DiscountList
+            description: 'Object containing a list of discounts.'
+
+DiscountList:
+    type: object
+    description: 'Object containing a list of discounts.'
+    properties:
+        Discount:
+            type: array
+            items:
+                type: object
+                properties:
+                    identifier:
+                        type: string
+                        description: "Discount identifier."
+                    type:
+                        type: string
+                        description: "Discount type: cart or catalog."
+                    priority:
+                        type: integer
+                        description: "Discount priority."
+                    isEnabled:
+                        type: boolean
+                        description: "Indicates whether the discount is enabled."
+                    userId:
+                        type: integer
+                        description: "User ID of discount creator."
+                    rule:
+                        type: object
+                        description: "Describes how the discount is calculated: percentage or fixed."
+                        properties:
+                            type:
+                                type: string
+                                description: "Discount type."
+                            amount:
+                                type: integer
+                                description: "Discount amount."
+                    startDate:
+                        type: datetime
+                        description: "Defines when the discount starts."
+                    endDate:
+                        type: datetime
+                        description: "Defines when the discount starts."
+                    translations:
+                        type: array
+                        description: "Translations of discount data."
+                        items:
+                            type: object
+                            properties:
+                                languageCode:
+                                    type: string
+                                name:
+                                    type: string
+                                description:
+                                    type: string
+                                label:
+                                    type: string
+                                labelDescription:
+                                    type: string
+                    conditions:
+                        type: array
+                        description: "List of discount conditions."
+                        items:
+                            type: DiscountCondition


As only JSON is used, DiscountList can't be displayed.

When there is both, this no big deal that the Wrapper description is short, just close the JSON Wrapper type description and open the XML type description.

But here, there is no such possibility.

I would move DiscountList under its wrapper.

Suggested change

DiscountListWrapper:

type: object

description: 'Wrapper object for DiscountList.'

properties:

DiscountList:

type: DiscountList

description: 'Object containing a list of discounts.'

DiscountList:

type: object

description: 'Object containing a list of discounts.'

properties:

Discount:

type: array

items:

type: object

properties:

identifier:

type: string

description: "Discount identifier."

type:

type: string

description: "Discount type: cart or catalog."

priority:

type: integer

description: "Discount priority."

isEnabled:

type: boolean

description: "Indicates whether the discount is enabled."

userId:

type: integer

description: "User ID of discount creator."

rule:

type: object

description: "Describes how the discount is calculated: percentage or fixed."

properties:

type:

type: string

description: "Discount type."

amount:

type: integer

description: "Discount amount."

startDate:

type: datetime

description: "Defines when the discount starts."

endDate:

type: datetime

description: "Defines when the discount starts."

translations:

type: array

description: "Translations of discount data."

items:

type: object

properties:

languageCode:

type: string

name:

type: string

description:

type: string

label:

type: string

labelDescription:

type: string

conditions:

type: array

description: "List of discount conditions."

items:

type: DiscountCondition

DiscountListWrapper:

type: object

description: 'Wrapper object for DiscountList.'

properties:

DiscountList:

type: object

description: 'Object containing a list of discounts.'

properties:

Discount:

type: array

items:

type: object

properties:

identifier:

type: string

description: "Discount identifier."

type:

type: string

description: "Discount type: cart or catalog."

priority:

type: integer

description: "Discount priority."

isEnabled:

type: boolean

description: "Indicates whether the discount is enabled."

userId:

type: integer

description: "User ID of discount creator."

rule:

type: object

description: "Describes how the discount is calculated: percentage or fixed."

properties:

type:

type: string

description: "Discount type."

amount:

type: integer

description: "Discount amount."

startDate:

type: datetime

description: "Defines when the discount starts."

endDate:

type: datetime

description: "Defines when the discount starts."

translations:

type: array

description: "Translations of discount data."

items:

type: object

properties:

languageCode:

type: string

name:

type: string

description:

type: string

label:

type: string

labelDescription:

type: string

conditions:

type: array

description: "List of discount conditions."

items:

type: DiscountCondition

Same for every JSON-only object types below…

adriendupuis

#2780 (review)

mnocon force-pushed the discounts-rest branch 2 times, most recently from 35978c8 to 636c53c Compare June 10, 2025 22:12

mnocon marked this pull request as ready for review June 11, 2025 06:37

mnocon added the Needs DEV review label Jun 11, 2025

mnocon requested review from Steveb-p, pawlakadrian and konradoboza June 11, 2025 06:39

mnocon commented Jun 11, 2025

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ibexa-discounts.raml Outdated Show resolved Hide resolved

konradoboza approved these changes Jun 11, 2025

View reviewed changes

mnocon added Needs DOC review and removed Needs DEV review labels Jun 11, 2025

mnocon requested a review from a team June 11, 2025 07:25

ezrobot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team June 11, 2025 07:26

mnocon force-pushed the discounts-rest branch from 7583a7d to eed2aed Compare June 11, 2025 07:53

mnocon added 9 commits June 11, 2025 13:02

[PHP API] Discounts (#2763)

4a7ede4

* [PHP API REF] Added Discount packages * Generated PHP API for Discounts

Discount product guide

874c51f

Fixed links and navigation

71a691a

Removed nav

a347f04

Fixed links

5291573

Fixed typo

b1f437e

Fixed badges

32ed031

Removed whitespace

093336d

Fixes before review

e37ffdc

mnocon and others added 9 commits June 11, 2025 13:03

After review fixes

6ad81e4

Currency remark

89bfa6d

Discount migrations (#2768)

80fbf92

* [Discounts] Added migration doc * Added files * Update docs/content_management/data_migration/importing_data.md

Applied suggestions from code review (#2767)

2194538

Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>

[Discounts] Event reference (#2776)

c83a365

* [Discounts] Added event reference * Fixed links * Fixes before review * Removed column

[Discounts] Mentioned discounts in pricing and customer groups (#2775)

df345d6

* Mentioned discounts in pricing and customer groups * Before review fixes * Added mention to the PIM guide

Discounts update (#2774)

478faec

* Added update instructions * Fixed link

mnocon force-pushed the discounts branch from ab5b707 to 478faec Compare June 11, 2025 11:04

mnocon added 5 commits June 11, 2025 13:06

Discount codes

ec4df5b

[Discounts] REST API Reference

23e31e3

Selfreview

bed2686

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

dbe237f

Regenerated

01e4593

mnocon force-pushed the discounts-rest branch from eed2aed to 01e4593 Compare June 11, 2025 11:09

Base automatically changed from discounts to 4.6 June 11, 2025 13:51

Merge remote-tracking branch 'origin/4.6' into discounts-rest

5378b3b

adriendupuis mentioned this pull request Jun 13, 2025

[Discounts] Described Discounts API #2783

Open

adriendupuis reviewed Jun 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Discounts] REST API #2780

[Discounts] REST API #2780

mnocon commented Jun 10, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

adriendupuis left a comment

Uh oh!

adriendupuis Jun 13, 2025

Uh oh!

adriendupuis Jun 13, 2025 •

edited

Loading

Uh oh!

adriendupuis Jun 13, 2025 •

edited

Loading

Uh oh!

adriendupuis Jun 13, 2025

Uh oh!

adriendupuis Jun 13, 2025

Uh oh!

adriendupuis left a comment

Uh oh!

Uh oh!

	displayName: Get discount
	displayName: Get discount by identifier

[Discounts] REST API #2780

Are you sure you want to change the base?

[Discounts] REST API #2780

Conversation

mnocon commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

adriendupuis left a comment

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

adriendupuis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mnocon commented Jun 10, 2025 •

edited

Loading

github-actions bot commented Jun 10, 2025 •

edited

Loading

adriendupuis Jun 13, 2025 •

edited

Loading

adriendupuis Jun 13, 2025 •

edited

Loading