Skip to content

USF-3972: Order backwards incompatibilities#874

Draft
bdenham wants to merge 4 commits into
releasefrom
order-incompatibility
Draft

USF-3972: Order backwards incompatibilities#874
bdenham wants to merge 4 commits into
releasefrom
order-incompatibility

Conversation

@bdenham
Copy link
Copy Markdown
Collaborator

@bdenham bdenham commented May 9, 2026

Purpose of this pull request

Documents the backward incompatibility introduced in Order drop-in v3.3.0 (the Order Comments feature) and the Storefront Compatibility Package versions required to resolve it. The Order drop-in v3.3.0 adds a comments field to order responses; without a matching SCP update, the requestGuestOrderCancel mutation returns a 500 error and guest order cancellation stops working.

Changes add a breaking change notice and known issue entry to the April 2026 suite notes, add a missing SCP v4.8.18 changelog entry (the 2.4.8 fix shipped in v4.8.18, two releases before v4.8.19), and update the existing v4.7.12 changelog entry with a more precise root-cause description and cross-reference to the suite notes.

Associated JIRA ticket

USF-3972

Staging preview

Affected pages

Links to source code

@bdenham bdenham self-assigned this May 9, 2026
@bdenham bdenham added documentation Improvements or additions to documentation enhancement New feature or request major-update Significant original updates to existing content labels May 9, 2026
@bdenham bdenham marked this pull request as ready for review May 9, 2026 16:11

**v4.7.12**
- **Guest order cancel with comments**: Resolved an internal server error when calling `requestGuestOrderCancel` on orders that include order comments. The error was introduced when the Order drop-in added `OrderComments` support and the new `comments` field appeared in order responses; the SCP `requestGuestOrderCancel` mutation did not handle the presence of that field, causing a 500 error on cancel requests ([#275](https://github.com/magento-commerce/storefront-compatibility/pull/275)).
- **Guest order cancel with comments**: Resolved an internal server error when calling `requestGuestOrderCancel` on orders that include order comments. The cancellation flow was writing status history entries without an explicit UTC `created_at` timestamp; when the Order drop-in requested `comments { message timestamp }`, the null timestamp caused the GraphQL resolver to return a 500 error. This fix is required for a safe Order drop-in v3.3.0 upgrade on Adobe Commerce 2.4.7 deployments. See the [April 2026 suite notes](/releases/) for the full context ([#275](https://github.com/magento-commerce/storefront-compatibility/pull/275)).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bdenham There are some mismatches in the release dates, and different versions appear to be grouped together. Additionally, PR links are exposed, as shown in the shared screenshot. We already addressed this issue with the following PR:
https://github.com/commerce-docs/microsite-commerce-storefront/pull/843/changes

Image Image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will revert this change.

>
The Storefront Compatibility Package has been updated with the following changes. This release accompanies the Order drop-in v3.3.0 release; see the [April 2026 suite notes](/releases/) for the full context.

- **Guest order cancel with comments**: Resolved an internal server error when calling `requestGuestOrderCancel` on orders that include order comments. The cancellation flow was writing status history entries without an explicit UTC `created_at` timestamp; when the Order drop-in requested `comments { message timestamp }`, the null timestamp caused the GraphQL resolver to return a 500 error. Upgrading the Order drop-in to v3.3.0 without this SCP version causes guest cancellation to fail on Adobe Commerce 2.4.8 deployments ([#268](https://github.com/magento-commerce/storefront-compatibility/pull/268)).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we remove the PR link from here as well?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR links are there because management wanted to make them available, even thought they are private. I'm not sure why anymore, but for now, I'll leave them.

@bdenham bdenham marked this pull request as draft May 13, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request major-update Significant original updates to existing content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants