Developer changelog

As of 2025-01 the metafieldDelete Admin API method is being removed. The metafieldsDelete method should be used instead. The former relies on the Metafield GID, while the latter takes an array of Metafield Identifiers composed of ownerId, namspace, and key. Note that the Metafield GID is not an option in metafieldsDelete.

As of the latest Shopify’s Standard Product Taxonomy version 2024-10, you can now find additional categories, attributes and values across product areas such as Apparel & Accessories, Home & Garden, Sporting Goods, and more. The taxonomy is an evolving library that’s informed by user feedback and market insights, with each release aiming to help you more accurately classify your products.

More details about this update can be found in the release notes.

The handling of GraphQL requests via HTTP will evolve slightly as of 2025-01 API versions in accordance with the GraphQL over HTTP spec. These changes refine how a request's Content-Type and Accept headers work, and offer additional granularity in response status codes.

New response format

A new application/graphql-response+json response format is available. Requests may select this format using the Accept header, for example:

Accept: application/graphql-response+json, application/json

The above favors receiving a application/graphql-response+json response by listing it first. This new format is the same as JSON aside from its status codes:

200 OK

• For application/graphql-response+json, this status indicates that the JSON payload was valid and that the submitted GraphQL document attempted execution on the server. Note that the response payload may still contain errors encountered during execution along with partial data.
• For application/json, this status only indicates that the JSON payload was valid.

400 Bad Request

• For application/graphql-response+json, this status indicates that the JSON payload was invalid, or that the submitted GraphQL parameters failed static validation and were not executed.
• For application/json, this status only indicates that the JSON payload was invalid.

Usage summary

For requests to 2025-01 versions and after:

• Use the /graphql endpoint. Using /graphql.json will automatically respond with application/json as it does now.
• The request body must contain a spec JSON encoding.
• The Content-Type header must specify application/json. The legacy application/graphql request format is no longer supported. Requests with no supported content type will receive a 415 Unsupported Media Type response.
• The Accept header now supports application/graphql-response+json and/or application/json response formats. Requests with no supported accept types will receive a 406 Not Acceptable response.
• Accepting */* will default to a application/graphql-response+json response.

These changes do NOT affect unstable versions at this time, or Storefront API. A breaking change announcement with migration timeline will be announced prior to any unstable transition.

The Content-Type: application/graphql request format is deprecated and will no longer be accepted as of 2025-01 schema versions. As of 2025-01 schemas, all requests must specify Content-Type: application/json and post a spec encoded body. See GraphQL Over HTTP update for more details.

As of the 2025-01 release of the Admin GraphQL API, the deprecated multiLocation field on ShopFeatures will be removed.

Use the locationsCount query to determine how many locations a shop has.

As of Oct 31, 2024, merchants can now manage their apps using the new Apps tab, which includes app extension collections.

Note: If your app contains customer account UI extensions, these extensions won't be shown to merchants until customer account UI extensions is released in December.

Learn more about the Apps tab in the Shopify Help Center.

We've added two new theme setting types: metaobject and metaobject_list so theme and app developers can write sections and blocks that consume metaobjects of a specified type.

For theme store themes, developers must only use standard metaobject definitions since custom metaobject definitions are unique to a store.

Learn more about the new metaobject and metaobject_list theme settings on Shopify.dev.

Hydrogen v2024.10.0 is out today. The October 2024 Hydrogen release supports the 2024-10 Storefront API and contains several optimizations and bug fixes, including:

• Cart warnings support (#2572)
• Product option updates (#2538)
• Hydrogen supports worker compatibility date (#2380)
• Shopify cookie banner no longer is the default set up in skeleton (#2588)
• Update createWithCache (#2546)
• Release stable sitemaps utility functions (#2589)
• Decode product variant encoding functions (#2425)
• Route warnings (#2613)
• Analytics fixes (#2538)
• Optimistic cart banner (#2502)
• Aside improvements (#2503)
• Use datalist for query suggestions (#2506)
• Remove unstable re-exports from remix-oxygen package (#2551)
• Update MiniOxygen to latest workerd version (#2567)
• <Image/> local asset fix (#2573)
• Update <ProductPrice> to remove deprecated code usage for priceV2 and compareAtPriceV2. Remove export for getCustomerprivacy (#2601)
• Remove deprecated --worker Shopify CLI flag (#2603)
• Allow generated codegen files to be placed anywhere in the directory (#2600)
• Add optional headers param for customer logout redirect (#2602)

Check out our full Hydrogen October 2024 release blog post for more details. And please drop your comments, feedback, and suggestions in GitHub Discussions!

Effectively immediately, metafields without a type value will return "string" instead of blank. For example, this check will no longer be true

{% if metafield.type == blank %}
  This will no longer render.
{% endif %}

Instead, a value of string will be returned:

{% if metafield.type == 'string' %}
  This metafield is of type `string`.
{% endif %}

Action Required: Developers currently using the BOOMR variables for theme identification and customization should begin transitioning to window.Shopify.theme properties. The BOOMR variables will be removed on 31/01/2025, after which window.Shopify.theme.schema_name and window.Shopify.theme.schema_version should be used exclusively.

Deprecation of BOOMR Script: The BOOMR (Boomerang) JavaScript library was used for collecting Web Performance data on storefronts and it’s now been replaced with a leaner and more conformant library. Some theme and app developers had been relying on a few variables set by BOOMR. These variables include: - BOOMR.themeName - BOOMR.themeVersion

These variables will continue to be available until 31st Janurary 2025, allowing developers to transition to the new method of accessing theme information.

Introduction of Enhanced Theme Information on window.Shopify.theme: In response to developer feedback, we are enhancing the window.Shopify.theme object. Starting today, it will include two new properties: - schema_name: Reflects the name attribute from the theme's settings_schema.json. - schema_version: Reflects the version attribute from the theme's settings_schema.json.

These additions aim to provide a standardized and reliable method for accessing theme information directly from the Shopify global object.

We’re rolling out new standard events to web pixels that enable you to better understand the issues that buyers encounter in checkout. Merchants can now capture specific alerts seen by buyers, such as inline field validations and page-level alerts, and errors from Checkout UI Extensions. Any pixels subscribing to all standard events will automatically receive these new types.

Learn more about the new events here.

From the week commencing 28th October 2024, the following changes to CAPTCHA protection will occur:

Classic Customer Accounts: Removal of the /challenge page for Login, Create Account and Reset Password flows

If hCaptcha is enabled in Admin for these forms, they will now require a valid hCaptcha token as part of the form submission, otherwise a 400 error response will be returned.

Form submissions that fail the hCaptcha assessment will also return a 400 error response.

The vast majority of form submissions already comply with this requirement, due to hCaptcha being automatically wired up to forms with the correct markup. More information is available in the dev docs

Full deprecation of reCAPTCHA on Storefront forms

The recent migration to hCaptcha on all Storefront forms is now complete. Applications or themes that have bespoke code that submits a reCAPTCHA v3 token (site key 6LeHG2ApAAAAAO4rPaDW-qVpPKPOBfjbCpzJB9ey) will need to update to use hCaptcha. All form submissions containing a recaptcha-v3-token field will result in a 400 error response.

Again, the vast majority of form submissions already comply with this requirement. If you application or theme invokes the reCAPTCHA api directly, ie via methods on window.grecaptcha then you will need to make changes. More information on wiring forms with hCaptcha using methods supported by Shopify is available in the dev docs

As of the 2025-01 API version, the heldBy string field on the fulfillmentHold GraphQL object will be replaced by the newly introduced heldByApp object field.

This new field provides access to all attributes of the App object, unlike the deprecated heldBy field, which only indicated the app's title.

If you currently query fulfillmentHold.heldBy, you should transition to querying fulfillmentHold.heldByApp.title.

A full-page extension target (customer-account.page.render or customer-account.order.page.render) can no longer coexist with any other targets in the same extension. This change improves performance and provides a better merchant experience in the checkout and accounts editor. If your full-page extension is best used with other extensions in your app, create an editor extension collection to encourage merchants to add all the extensions in the collection.

This change will only impact the deployment of new extensions or new versions of existing extensions. Existing extensions will not be affected until a new version is deployed.

The grace period for the following criteria have been extended to 60 days from the current 30:

• Minimizes impact on store speed
  
• Minimizes impact on checkout speed
  
• Admin performance: meets 75th percentile Web Vitals targets
  
• Minimum number of installs
  
• Minimum number of reviews
• Minimum app rating
  

The grace period for Fulfillment services and Carrier services criteria will also be set to 60 days when enforcement begins.

As of version 2025-01 of the GraphQL Storefront API, Cart now supports removing Gift Cards by Id.

After a cart has been created and a Gift Card applied - perform the cartGiftCardCodesRemove mutation to remove one or more gift cards.

Starting October 15th, 2025, all Shopify App Store apps that appear in the Shopify admin must use the latest Shopify App Bridge by adding the app-bridge.js script tag to the <head> of each document of your app.

As of API version 2025-01, you can access StringConnection.nodes field shorthand to retrieve an array of strings directly instead of via edges. This connection type is now consistent with other connection types in the schema.

Learn more about StringConnection on GraphQL Admin API and Storefront API.

You can now deep link to editor extension collections in the checkout and accounts editor. This is only available on development stores.

When editor extension collections are released to merchants, you can start deep linking to editor extension collections from your app onboarding to streamline the merchant experience.

Learn more on Shopify.dev

As of October 11, 2024, checkout UI extensions targeting the purchase.checkout.reductions.render-before and purchase.checkout.reductions.render-after extension targets will now render in the order summary at the top of the page for one page mobile checkouts. Previously, extensions in these targets would only appear in the order summary at the bottom of the page. This will apply to checkout UI extensions on all API versions.

For more details, please follow up in the github issue in our public repo

As of GraphQL Admin API version 2024-10, ShopifyPaymentsPayoutSummary now surfaces ADVANCE_FEES and ADVANCE_GROSS fields.

Learn more about ShopifyPaymentsPayoutSummary on Shopify.dev.

Certain Shopify Function resource limits now scale proportionally to the number of line items in the cart. Starting at 200 line items, your Shopify Function runs will be able to use more resources than before.

This change applies to all Shopify Function runs that include cart lines in their input query.

Learn more about dynamic resource limits and how they're calculated for Shopify Functions on Shopify.dev.

The merchant export in Partners now provides an "Attribution" column that specifies installs that are attributable to Shopify App Store ad clicks. For more information on the Partners merchant export, see here

The 2025 versions of the admin performance and carrier services criteria are now displayed in the Partner Dashboard distribution page along with the rest of the Built for Shopify automated criteria. Carrier services criteria will only be visible to those using the related API.

As of today, you can use the lineItem on FulfillmentOrderLineItem without planning for deprecation. This applies to all API versions.

Learn more about FulfillmentOrderLineItem.lineItem on Shopify.dev.

As of Admin GraphQL API 2025-01 version, CalculateExchangeLineItemInput.variantId and CalculatedExchangeLineItem.variant fields are nullable at schema level.

This is in preparation of future feature changes. In the current state CalculateExchangeLineItemInput.variantId will still be validated via a returned error if not present.

Learn more about CalculateExchangeLineItemInput and CalculatedExchangeLineItem.

As of GraphQL Admin API version 2025-01, the accountOpenerName field will be added to shopifyPaymentsAccount

As of version 2025-01, the Admin API bulk query operation userErrors GraphQL type will change to BulkOperationUserError. The new type includes the same fields as the old type, with the addition of a code field.

As of GraphQL Admin API version 2024-10, ShopifyPaymentsTransactionType now includes ADVANCE and ADVANCE_FUNDING type.

Learn more about ShopifyPaymentsTransactionType on Shopify.dev.

As of GraphQL Admin API version 2024-10, Business Entity attributes will be available for use as a GraphQL object and across relevant types.

You will now be able to query for properties related to the Business Entities that are enabled on your shop and request for these fields on objects that can be associated to a Business Entity.

Business Entity identifiers will also be available on the Order REST Admin API version 2024-10 as well as on webhook payloads.

As of GraphQL Admin API version 2024-10, querying for all disputes for a given shop will be available for use as a GraphQL connection.

Learn more about ShopifyPaymentsDispute on Shopify.dev

In the version 2024-10 release of the Admin GraphQL API, the productOptionsCreate mutation will include a variantStrategy parameter, enhancing control over variant management when adding new product options. This new parameter allows for two strategies:

• LEAVE_AS_IS: Maintains existing variants, updating them to include new option values without creating new variants as necessary.
• CREATE: Generates new variants for all possible combinations of option values. This enhancement allows for more precise control over product variant configuration and inventory management.

For more detailed information and examples, visit our productOptionsCreate documentation on Shopify.dev.

As of the 2024-10 version of the GraphQL Admin API, the requiresComponents field available in ProductVariantInput has been added to ProductVariantsBulkInput.

This field allows variants to be marked as bundles that require components in order to be sold.

Learn more about requiresComponents and ProductVariantsBulkInput on Shopify.dev.

As of 2024-10 version, we are adding CollectionsCount query to the Admin GraphQL API.

Learn more about CollectionsCount on Shopify.dev.

As of GraphQL Admin API Version 2024-10, you can subscribe to MetafieldDefinition changes under the webhook topics metafield_definitions/create, metafield_definitions/update, and metafield_definitions/delete

GraphQL is now the primary API to interact with the Shopify admin. REST Admin API will be marked as legacy, and new feature development and improvements will be focused on GraphQL.

April 1 2025: All new apps will default to GraphQL

• Organizations created after this date will only be permitted to use GraphQL for their custom apps
• All new public apps submitted to the App Store after this date must only use GraphQL

Migration timelines for existing apps (outside of the required migration to the new GraphQL product APIs that have already been announced), will be announced in 2025. We will make sure ample time is provided for a smooth transition.

Learn more about Shopify’s API strategy and direction into GraphQL.

As of October 1st, 2024 we have update the Theme Store algorithm. This new ranking system will refine how themes are discovered, prioritizing factors like recency, quality, and trust signals to help merchants find themes more effectively.

As of GraphQL Admin API version 2025-01, we're cleaning up the shopifyPaymentsBankAccount endpoint and removing several unused fields.

Merchants using the Storefront API can now offer Combined Listings with Shopify. The Shopify Combined Listings app is available to merchants on Plus plans, helping merchants better merchandise products that come in multiple variations such as colors, materials or lengths, all from the same product listing.

Learn more about the Shopify Combined Listings app in the Shopify Help Center.

As of 2024-10, you can use the recurring_cycle_limit and applies_on_subscription field on the DiscountAutomaticApp object type so that subscriptions can use function based discounts for a specified number of occurrences

Learn more about DiscountAutomaticApp on Shopify.dev.

As of 2024-10, the product create and update webhook payloads contain information indicating if the product has a variant that is a product bundle.

The new boolean field, has_variants_that_requires_components, mirrors what is already available on the Product GraphQL response.

To receive has_variants_that_requires_components in the webhook payload, specify 2024-10 or greater as the webhook API version in your App Partner Dashboard.

Learn more about Product Bundles.

The 2024-10 version of the GraphQL Admin API brings improvements to the StaffMember object:

• New accountType field.
• You can retrieve the staff member making the API request with the currentStaffMember query.
• You can list all staff members with the staffMembers connection query.
• Shop.staffMembers was deprecated in favor of the staffMembers query.

This allows apps using the User REST Admin API resource to migrate to GraphQL's StaffMember object.

As of 2024-10, you can no longer use the deprecated shippingMethods field on the fulfillmentService query or include it as an argument in the fulfillmentOrderSubmitFulfillmentRequest mutation.

The shipping method associated with the fulfillment service provider applied only to Fulfill By Amazon fulfillment service. The Fulfillment by Amazon feature is not supported as of March 30, 2023. To continue using Amazon fulfillment, merchants need to set up a Multi-Channel Fulfillment solution recommended by Amazon.

To learn more see https://help.shopify.com/manual/shipping/fulfillment-services/amazon#activate-fulfillment-by-amazon

As of GraphQL Admin API 2024-10 version, you can make use of a new mutation to create an order.

Learn more about orderCreate on Shopify.dev.

As of October 1, we added the following updates to POS UI Extensions:

• Added support for iOS debugging with the Safari dev tools.
• Added support for the pos.product-details.block.render target.
• Added support for the pos.purchase.post.block.render target.
• Added support for the pos.order-details.block.render target.
• Added support for the pos.customer-details.block.render target.
• Introduced a POSBlock component. It's the required parent component for block extension targets.
• Introduced a POSBlockRow component. It's the required child component for POSBlock, and can be used to wrap other components.
• Deprecated the ActionItem component. Please use the Button component instead.
• Added support for windowed modals.

All of the changes are available for POS UI extensions version 2024-10 and POS app version 9.19.0. See the version log for all version details.

You can now associate a Fulfillment Constraint function with one or multiple delivery method types. The function will only run within the context of those specific delivery methods.

As of Admin GraphQL API version 2024-10 and unstable, you can

• Use the FulfillmentConstraintRuleCreate mutation to register your new Fulfillment Constraint function and associate it with one or multiple delivery methods. A new required input field delivery_method_types will be added.
• Use the FulfillmentConstraintRuleUpdate mutation to update delivery method(s) for an existing registered function.

Existing fulfillment constraint functions will continue to run for SHIPPING, LOCAL and PICKUP_POINT.

As of Admin GraphQL API version 2024-10 and unstable, you can setup your Fulfillment Constraint function to run for Local Pickup delivery method.

Use the FulfillmentConstraintRuleCreate mutation to register your new Fulfillment Constraint function with the PICK_UP delivery method.

Or, use the FulfillmentConstraintRuleUpdate mutation to update your existing registered function to include PICK_UP.

Breaking Changes

As of the Admin API version 2024-10 and unstable release, fulfillmentOrder.destination will return a FulfillmentOrderDestination object instead of null for fulfillment orders lacking an associated shipping address. In such cases, the address related fields within the FulfillmentOrderDestination object will be set to null.

Non Breaking Changes

As of GQL Admin API version 2024-10 and unstable release, you can use new field fulfillmentOrder.destination.location to retrieve the pickup location for the fulfillment order.

You can learn more about fulfillmentOrder.destination here and fulfillmentOrderDestination here

As of 2024-10, we've added a CompanyLocationStaffMemberAssignment to the CompanyLocation object for viewing the staff members assigned to the company location.

You can assign and remove staff members for a company location using the CompanyLocationAssignStaffMembers and CompanyLocationRemoveStaffMembers mutations.

As of Payments Apps API version 2024-10, the StartPaymentSession payload for all payment extension types will have one new field: session_id.

This identifier is shared across payment sessions that belong to the same payment group, buyer session, and share payment details. It can be used to power auth rate calculations.