Skip to content

Updates to flex discounts and discounts #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lijumjose merged 3 commits into from
May 14, 2026
Merged

Updates to flex discounts and discounts #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38e9ee3
Updates to recommendations and flex discounts
May 14, 2026
2e1b923
Merge branch 'main' of https://github.com/lijumjose/VIPMP
May 14, 2026
6e94464
Syntax issue fix
May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pages/docs/flex-discounts/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Sample Request URL: `GET <ENV>/v3/flex-discounts?market-segment=COM&country=US`
| flex-discount-id | String | No | Retrieve a flexible discount by its unique ID. This endpoint returns a single, unique flexible discount object. \<br /\> If flex-discount-id query parameter is provided in the request, other non-mandatory params cannot be provided in the same request. | Max: 40 characters |
| flex-discount-code | String | No | Filter promotions by code. Examples: "DIWALI", "BLACK_FRIDAY". | |
| include-eligible-reusable-discounts | Boolean | No | Include discounts that are not active, but the discount lock end date is still valid. | |
| start-date | String (date) | No | Filter flexible discounts that were available on or after the specified date and time. This date can be without timestamp or with timestamp, for example, “2025-05-02" or "2025-05-02T22:49:54Z. Dates with timestamps are only accepted in ISO-8601 format with "Zulu" (UTC) time zone. This is the same format that all dates and times are in Adobe Commerce Partner API (CPAI) responses. | |
| start-date | String (date) | No | Filter flexible discounts that were available on or after the specified date and time. This date can be without timestamp or with timestamp, for example, “2025-05-02" or "2025-05-02T22:49:54Z. Dates with timestamps are only accepted in ISO-8601 format with "Zulu" (UTC) time zone. This is the same format that all dates and times are in Adobe Commerce Partner API (CPAI) responses. \<br /\> Pass `start-date=<today>` to scope results to currently-live discounts only. | |
| end-date | String (date) | No | Filter flexible discounts that were available on or before this moment in time. This date can be without timestamp or with timestamp, for example, “2025-05-02" or "2025-05-02T22:49:54Z. Dates with timestamps are only accepted in ISO-8601 format with "Zulu" (UTC) time zone. This is the same format that all dates and times are in Adobe Commerce Partner API (CPAI) responses. | |
| limit | Integer | No | Specify the number of items to be returned in the response. Default: 20, Max: 50. | |
| offset | Integer | No | Set the start offset for the result items. Default: 0 | |
Expand Down Expand Up @@ -189,7 +189,7 @@ None.
| endDate | String (Date) | The final date when the flexible discount can be used. Dates with timestamps are only accepted in ISO-8601 format with "Zulu" (UTC) time zone. This is the same format that all dates and times are in Adobe Commerce Partner API (CPAI) responses. |
| startDate | String (Date) | The date from which the flexible discount can be used. Dates with timestamps are only accepted in ISO-8601 format with "Zulu" (UTC) time zone. This is the same format that all dates and times are in Adobe Commerce Partner API (CPAI) responses. |
| discountLockEndDate | String (Date and Time) | The date through which a flexible discount may continue to be applied beyond its initial offering period (start/end date). Reusable discounts are identified by the presence of the `discountLockEndDate` field in the response. |
| status | String Enum | Status of flexible discount. Possible values: ACTIVE, EXPIRED, REUSABLE |
| status | String Enum | Status of flexible discount. Possible values: ACTIVE, EXPIRED, REUSABLE \<br /\> **Note:** Flexible discounts with ACTIVE also includes both currently-running and future-dated discounts. The status field alone is no longer sufficient to determine whether a discount is live. Partners must compare `startDate` against the current date to know if a discount is usable right now. |
| qualification | Object | |
| qualification.baseOfferIds | Array of strings | List of Base Offer IDs of products eligible for flexible discount. Example: ["Offer ID 1", "Offer ID 2"] \<br /\>**Note**: The list of base Offer IDs will be empty if the flexible discount applies to all products. |
| outcomes[] | Array of objects | |
Expand Down
1 change: 1 addition & 0 deletions src/pages/docs/flex-discounts/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Key advantages of flexible discounts include:
- **Quick flexible discount launches for seasonal sales:**

- Allows partners to activate discounts within days for timely seasonal discounts like Black Friday.
- Allows partners to discover upcoming discounts through the API ahead of their start date, enabling advance preparation of marketing and storefront workflows.

- **Reusable discounts to automatic discount continuity across renewals**

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/mid-term/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can use the [GET Offer Switch Paths](apis.md#1-retrieve-upgrade-paths) API t
You can either switch the entire quantity or a certain number of the original subscription quantity.

**Example:** Out of 100 seats, only 40 are switched to Acrobat Standard Enterprise, and the remaining 60 stay on the original product.
If the upgrade path is marked `PARTIALLY_ALLOWED`, the partner can perform either a partial or full upgrade.
If the upgrade path is marked `PARTIAL_ALLOWED`, the partner can perform either a partial or full upgrade.

**Note:** After a full switch, only the new product renews. After a partial switch, both products renew. The subscription's anniversary date remains unchanged.

Expand Down
34 changes: 33 additions & 1 deletion src/pages/docs/recommendations/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,30 @@ The following response header, added to all responses, provides data to understa
},
},
],
},
}
"overlayRecommendations": {
"new": [
{
"createdAt": "2026-01-27T08:15:35Z",
"expiresAt": "2026-02-27T08:15:35Z",
"status": "OPEN",
"items": [
{ "offerId": "30006208CA01A12", "quantity": 25 },
{ "offerId": "65318386CA02012", "quantity": 1 }
]
}
],
"renew": [
{
"createdAt": "2026-01-28T09:20:10Z",
"expiresAt": "2026-02-28T09:20:10Z",
"status": "OPEN",
"items": [
{ "offerId": "30006208CA01A12", "quantity": 15 }
]
}
]
}
}
```

Expand All @@ -146,6 +169,15 @@ The following response header, added to all responses, provides data to understa
| source | Object | Indicates the source of the recommendation. |
| sourceType | String | Specifies the type of the source entity. Currently only `OFFER` is supported. |
| offerIds | String Array | List of offer IDs that contributed to this recommendation. |
| overlayRecommendations | Object | Contains overlay recommendation leads created by Adobe agents during overlay interactions. Present only when leads exist for the customer. For more information, see [Overlay recommendations](./index.md#overlay-recommendations). |
| new | Array of Leads | List of leads representing new purchase intent identified during overlay interactions. |
| renew | Array of Leads | List of leads representing renewal intent identified during overlay interactions. |
| createdAt | String (ISO-8601) | Timestamp when the lead was created. |
| expiresAt | String (ISO-8601) | Timestamp when the lead expires if not acted upon. |
| status | String | Lead lifecycle state. Possible values: `OPEN` and `EXPIRED`. |
| items | Array of Items | List of products and quantities in the lead. |
| offerId | String | Offer identifier (Part Number) for the lead item. |
| quantity | Integer | Number of units of the product in the lead. |

### HTTP Status Codes

Expand Down
Loading
Loading