Skip to content

Project-7525: [DO NOT MERGE] Feature branch for the new returns flow - #2667

Open
bc-vivekaggarwal wants to merge 74 commits into
masterfrom
feature/PROJECT-7525-new-returns-flow
Open

Project-7525: [DO NOT MERGE] Feature branch for the new returns flow#2667
bc-vivekaggarwal wants to merge 74 commits into
masterfrom
feature/PROJECT-7525-new-returns-flow

Conversation

@bc-vivekaggarwal

@bc-vivekaggarwal bc-vivekaggarwal commented May 27, 2026

Copy link
Copy Markdown

What?

This PR is for a feature branch to park all reviewed changes related to the new returns flow PROJECT-7525

Requirements

  • CHANGELOG.md entry added (required for code changes only)

Tickets / Documentation

PROJECT-7525

Screenshots (if appropriate)

Not applicable: They are part of individual PRs

Testing

TBD


Note

High Risk
Introduces new order-return GraphQL mutations and multi-page account/guest flows that merchants inherit; regressions affect real shoppers and return submission/cancellation behavior.

Overview
Adds the returns v2 shopper experience when settings.returns_v2_enabled is on: new create return, guest return portal, and return detail pages with matching theme JS (Storefront GraphQL for create, guest session start, and cancel), SCSS, and navigation/orders entry points gated alongside legacy returns_enabled.

The account returns list switches to a v2 layout (status badges, totals, cursor pagination, contextual “View details” links). Shared pieces include return-items-total, cursor-paginator, theme tokens for return status colors, and a large lang/en.json expansion.

Accessibility is woven through the new flows (landmarks, loop-safe ids, aria-labelledby for responsive labels, live regions, aria-disabled submit with hints, error/confirmation focus patterns) and documented in a new in-repo accessibility skill plus Cursor template-accessibility review rules. Smaller cross-cutting updates: alert modal dialog semantics, translatable <title> fallbacks for standalone return routes, legacy add-return table labeling, and optional “Go to return portal” on CMS pages.

Reviewed by Cursor Bugbot for commit 73581e4. Bugbot is set up for automated code reviews on this repo. Configure here.

@bc-vivekaggarwal
bc-vivekaggarwal requested a review from a team as a code owner May 27, 2026 00:42
@denis-bc
denis-bc requested a review from Copilot May 27, 2026 00:50
@BC-SEven BC-SEven changed the title Project-7525: Feature branch for the new returns flow Project-7525: [DO NOT MERGE] Feature branch for the new returns flow May 27, 2026
@denis-bc
denis-bc requested review from Copilot and removed request for Copilot May 27, 2026 03:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR parks initial Cornerstone theme changes for PROJECT-7525’s “new returns flow”, adding new templates/assets for a redesigned return-request experience and gating existing “Return” affordances on a new settings.returns_v2_enabled flag (with fallback to settings.returns_enabled).

Changes:

  • Add new return-related templates: a guest return portal page and a new account “add return” page layout.
  • Add new styling and a new page manager (AddReturnNew) plus bundle wiring for the new return-request UI.
  • Gate “Return” entry points in order details and orders list on returns settings; update CHANGELOG.md.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
templates/pages/guest-return-portal.html New guest-facing return portal page scaffold.
templates/pages/account/orders/details.html Gate “Return” button using returns_v2_enabled OR returns_enabled.
templates/pages/account/add-return-new.html New account return-request page markup for the redesigned flow.
templates/components/account/orders-list.html Gate “Return Items” link using returns_v2_enabled OR returns_enabled.
CHANGELOG.md Add draft entries for the new return pages / gating changes.
assets/scss/components/stencil/addReturn/_addReturn.scss Add styling for the new return-request page (.newReturn).
assets/js/theme/add-return-new.js New page manager that renders the new return UI (currently with placeholder data).
assets/js/app.js Wire account_new_return page type to load the new return page manager.
Comments suppressed due to low confidence (3)

assets/js/theme/add-return-new.js:96

  • Date formatting is hardcoded to the en-AU locale. This will display incorrect date formats for stores with different locales; use store locale from Stencil context (e.g. this.context.storeLocale) or omit the locale to allow the browser/store locale to drive formatting.
            // TODO ORDERS-7715: invoke createReturn Storefront GQL mutation.
        });
    }
}

assets/js/theme/add-return-new.js:142

  • Currency formatting is hardcoded to en-AU and always uses item.totalIncTax even though order.isTaxInclusive is available. This will display incorrect amounts/formatting for non-AU stores and for tax-exclusive display settings. Use a locale from context and choose totalIncTax vs totalExTax based on order.isTaxInclusive (or use server-provided formatted totals if available).
    assets/js/theme/add-return-new.js:239
  • console.log('Submitting return', ...) should not ship in theme code. Either remove it or gate it behind an explicit debug flag, and replace with the real API call / proper error handling when wiring this up.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread assets/js/app.js
Comment on lines 12 to 16
account_order: getAccount,
account_addressbook: getAccount,
shippingaddressform: getAccount,
account_new_return: getAccount,
account_new_return: getAddReturnNew,
'add-wishlist': () => import('./theme/wishlist'),
Comment on lines +3 to +6
{{> components/common/breadcrumbs breadcrumbs=breadcrumbs}}

<h1> Guest Return Portal</h1>

Comment on lines +10 to +16
</div>
<div class="newReturn-headerActions">
<a href="{{../urls.account.orders.all}}" class="newReturn-btnBack">{{lang 'account.orders.return.back_button'}}</a>
<a href="/return-policy" class="newReturn-btnPolicy">View return policy &rarr;</a>
</div>
</div>
{{#if date}}<p class="newReturn-orderDate">{{date}}</p>{{/if}}
Comment thread assets/js/theme/add-return-new.js Outdated
Comment on lines +9 to +20
this.bindSubmit($form);
}

bindOrderLineItemEvents() {
document.querySelectorAll('.newReturn-stepperBtn').forEach(button => {
button.addEventListener('click', () => {
// Derive itemId from the parent row — buttons do not carry data-item-id,
// so the [data-item-id] selector stays scoped to the row container only.
const row = button.closest('.newReturn-orderLineItem');
const itemId = row?.dataset?.itemId;
if (!itemId) return;
const action = button.getAttribute('data-action');
Comment thread CHANGELOG.md Outdated
- Fix duplicate `id="default_instrument"` on Update Payment Method page [#2661](https://github.com/bigcommerce/cornerstone/pull/2661)
- Respect `available_to_sell` on PDP so the Sold Out alert is hidden and the Add to Cart button stays enabled for backorderable products, and is disabled when quantity exceeds `available_to_sell` [#2659](https://github.com/bigcommerce/cornerstone/pull/2659)
- Updated accessibility features [2656](https://github.com/bigcommerce/cornerstone/pull/2656)
- Adds new guest-return-portal page. [2645](https://github.com/bigcommerce/cornerstone/pull/2645)
@denis-bc

Copy link
Copy Markdown

cursor review

Comment thread assets/js/app.js Outdated
Comment thread assets/js/theme/add-return-new.js Outdated
Comment thread templates/pages/account/add-return.html Outdated
Comment thread templates/pages/create-return.html Outdated
Comment thread assets/js/theme/create-return.js
Comment thread assets/js/theme/create-return.js
Comment thread assets/js/theme/create-return.js
Comment thread assets/js/theme/create-return.js
Comment thread templates/pages/create-return.html
Comment thread templates/components/account/returns-list-v2.html Outdated
Comment thread templates/components/account/returns-list-v2.html Outdated
Comment thread templates/pages/account/return-details.html
Comment thread assets/js/theme/create-return.js
@BC-SEven
BC-SEven force-pushed the feature/PROJECT-7525-new-returns-flow branch from 34bc18e to 38101ea Compare July 1, 2026 01:09
Comment thread assets/js/theme/return-details.js
Comment thread assets/js/theme/guest-return-portal.js
Comment thread assets/js/theme/create-return.js
Comment thread templates/pages/create-return.html
}

startReturnGuestSession(input) {
return fetch('/graphql', {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

GraphQL fetch omits base URL

Medium Severity

New returns flows call fetch('/graphql', …) with a root-absolute URL, unlike other theme API usage that passes secureBaseUrl, so GraphQL may miss the correct prefixed path on multi-language storefronts.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 99a9c87. Configure here.

const overlay = document.querySelector('.guest-return-portal .loadingOverlay');
if (submitBtn) submitBtn.disabled = true;
if (overlay) overlay.style.display = 'block';
const payload = this.buildRequestPayload();

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Guest error alert never cleared

Low Severity

The guest return portal shows errors via showError but never hides or clears the alert when a new submit starts. A prior failure message stays visible during and after later attempts until navigation succeeds.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 8447deb. Configure here.

throw new Error('Failed to start return guest session');
}

window.location.href = `/create-return/${payload.orderEntityId}`;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Root-absolute return URLs

Medium Severity

After a successful guest session, navigation uses a root-absolute /create-return/... URL, and the returns list links to /account.php?.... On multi-language storefronts with locale subfolders, those paths skip the active prefix while other return links use urls.*, so shoppers can land on the wrong locale or a broken page.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit de1a079. Configure here.

bc-vivekaggarwal and others added 29 commits September 3, 2026 09:39
… on returns details page (#2697)

* feat(returns): ORDERS-7900: strike requested with resolved resolution on returns details page

* feat(returns): ORDERS-7900: add translation strings for resolution request
feat(orders): ORDERS-7706 add new return page layout
feat(orders): ORDERS-7706 add new return page layout
…r accessibility and seo (#2726)

* feat(returns): ORDERS-7945 add page title to returns related pages for accessibility and seo

* feat(returns): ORDERS-7945 add page title to create returns and guest return portal pages only
@BC-SEven
BC-SEven force-pushed the feature/PROJECT-7525-new-returns-flow branch from 0bee8f0 to 73581e4 Compare September 2, 2026 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants