Skip to content
Adobe Commerce Storefront
Docs Playgrounds Videos
Setup

Storefront Compatibility Package

The Storefront Compatibility Package contains changes to the Adobe Commerce 2.4.7 codebase that enable drop-in component functionality.

Most of these changes enhance the Adobe Commerce GraphQL schema. However, miscellaneous bugfixes are also included. Cart, checkout, user account, and user authentication dropin-in components require the package. Partners can request access to the Storefront Compatibility Package by sending an email to commerce-storefront-compatibility@adobe.com.

Major features

This package defines the following queries and mutations:

  • confirmCancelOrder mutation - Cancels the specified order for a guest.

  • confirmReturn mutation - Confirms a guest or customer return request.

  • estimateTotals mutation - Estimates totals for cart based on the address.

  • generateCustomerToken mutation - Creates a new customer token.

  • recaptchaFormConfig query - Returns information about the reCaptcha configuration for the specified form type.

  • requestGuestOrderCancel mutation - Cancels the specified guest order.

  • requestGuestReturn mutation - Requests a return for a specified order on behalf of a guest.

  • resendConfirmationEmail mutation - Resends a confirmation email to the specified customer upon request.

Release information

Latest version: 4.7.0-beta24

Release date: November 11, 2024

4.7.0-beta24

  • The setShippingAddressesOnCart mutation no longer throws an error when specifying the pickup_location_code field.

  • customer queries using the items_eligible_for_return field do not return both parent and child products for configurable products.

  • Added the quantity_return_requested and eligible_for_return fields to OrderItemInterface.

  • Added the items_eligible_for_return field to the CustomerOrder type.

  • The eligible_for_return field no longer returns true on items that have been returned.

  • Updated WebAPI tests on shared catalogs.

4.7.0-beta23

  • Increased the default value for maximum query complexity to 1000.

  • Corrected an error that occurred when using the customer query to retrieve returns with the “Processed and Closed” status.

4.7.0-beta22

  • Added the confirmReturn and requestGuestReturn mutations.

  • Added multiple fields to the StoreConfig object that return configuration values related to taxes.

  • Commerce correctly returns a 401 or 403 error when an expired token is used.

4.7.0-beta21

  • Added the requestGuestOrderCancel mutation.

  • Added the id field to CartAddressInterface so that the value is available to the customerCart query.

  • Added GraphQL error handling capabilites to Cart.

  • The trademark symbol is now displayed correctly.

4.7.0-beta20

  • The updateCartItems and addProductsToCart mutations now return low quantity totals correctly.

  • Added the Customer.addressesV2 and Customer.CustomerAddresses objects, which allow you to specify pagination options.

  • Prices for downloadable products that have additional file options are now displayed correctly.

  • The updateCustomerEmail mutation allows the email to be changed when a custom attribute is not defined for the customer.

  • Added the ShippingCartAddress.same_as_billing field so that the cart and customerCart queries can determine whether the shipping addresses and billing address are the same.

Installation

You must have Adobe Commerce 2.4.7 installed. Magento Open Source is not supported.

Use this method to install the Storefront Compatibility Package using the Cloud infrastructure.

  1. On your local workstation, change to the project directory for your Adobe Commerce on cloud infrastructure project.

  2. Check out the environment branch to update using the Adobe Commerce Cloud CLI.

    Terminal window
    magento-cloud environment:checkout <environment-id>

  3. Add the Storefront Compatibility module.

    Terminal window
    composer require adobe-commerce/storefront-compatibility

  4. Update package dependencies.

    Terminal window
    composer update "adobe-commerce/storefront-compatibility"

  5. Commit and push code changes for the composer.json and composer.lock files.

  6. Add, commit, and push the code changes for the composer.json and composer.lock files to the cloud environment

    Terminal window
    git add -A
    git commit -m "Add module"
    git push origin <branch-name>

    Pushing the updates to the cloud environment initiates the Commerce cloud deployment process to apply the changes. Check the deployment status from the deploy log.

Update the package

Use the following procedure to update patch versions of the Storefront Compatibility Package.

  1. Run the following command to update the package:

    Terminal window
    composer update adobe-commerce/storefront-compatibility

  2. Run the following commands to upgrade Adobe Commerce and clear the cache.

    Terminal window
    bin/magento setup:upgrade && bin/magento cache:clean