Developer changelog

As of GraphQL Admin API version 2024-01 , you can use the ID field to identify an InventoryQuantity object. This object now implements Node interface.

We’ve unlocked the ability for partners to add unique and powerful functionality to the customer account experience by building extensions directly into new customer accounts.

Starting today, customer accounts extensibility is now available in developer preview, allowing partners to build extensions on new customer account pages (such as the order index, order status and customer profile pages), add highly visible order actions and create full-page extensions tailored to specific merchant needs.

Join us in creating better buying experiences, where customers navigate seamlessly across apps, with one single login.

Start building today

Get started by reading our developer documentation and join us on Discord December 14, 2023 and January 11, 2023 at 1pm EST.

Partners must now obtain a unique code to initiate a collaborator request and access a merchant’s store.

Collaborator request codes, previously optional, are now enabled by default for all merchants. This change gives merchants more control over who can access their store as collaborators, by ensuring that only those with the unique code can send a collaborator request.

Learn more about collaborator requests in the Shopify Help Center.

As of release candidate API version 2024-01, the schema for the Customer Account API has evolved significantly resulting in breaking changes. This update is necessary to ensure a more streamlined developer experience. Support has also been added to redirect buyers to a specific URI after logout with the post_logout_redirect_uri query parameter, providing a solution for custom storefronts with multiple domains. Additionally, mutations for modifying marketing subscriptions have been added with customerEmailMarketingSubscribe and customerEmailMarketingUnsubscribe. The Customer Account API is available in Developer Preview and accessible via the Hydrogen and Headless channels. We encourage developers to provide feedback to help shape future iterations of this API.

Learn more about the schema updates and the new features in the developer documentation.

We’ve introduced dedicated webhook topics that will be sent out whenever a discount has been created, updated or deleted, enabling developers to keep their discount apps in sync.

Learn more here

As of GraphQL Admin API version 2024-01, we are excited to introduce the Customer Data Erasure API. This API allows merchants to handle customer data erasure requests in compliance with GDPR, CCPA, and other data protection regulations. The API includes two new mutations:

• customerRequestDataErasure enqueues a request to erase customer's data.
• customerCancelDataErasure cancels a pending erasure of a customer's data.

To learn more about how data erasure is processed and the impact on customer data, please refer to the Shopify Help Center.

All Shopify Functions executions are now visible for production stores in your Partner Dashboard.

Run details are only available for failed runs that have been shared by users.

More information can be found on Shopify.dev:

• Testing and debugging practices for Shopify Functions
• Shopify Functions error handling

As of 2023-11-07, Checkout Extensibility on the Thank you and Order status pages is available to plus merchants. Merchants can now make code-free, app-based, upgrade-safe customizations throughout the buying journey to create holistic and consistent experiences.

Checkout Extensibility replaces checkout.liquid, apps with script tags and additional scripts on the Thank you and Order status pages.

Script tags, additional scripts and checkout.liquid on the Thank you and Order status pages are now deprecated. Merchants have been notified of the following turn off dates: * August 13, 2024 - the removal date of checkout.liquid for in-checkout pages * August 28, 2025 - the removal date of checkout.liquid, apps with script tags and additional scripts on the thank you and order status page

Shops that aren't upgraded during these dates will be upgraded to an un-customized out-of-the-box Shopify Checkout.

The Storefront API Cart now returns a new key param appended to CheckoutUrl that is required to render buyer information in checkout. This behavior is applied retroactively to all versions of the Storefront API.

The param is validated and removed as the buyer is navigated into checkout. This change is transparent to the buyer and does not affect what they see in the browser or their ability to copy and share checkout URLs. When a checkout is loaded without the valid key, the cart is cloned, and buyer information is removed.

Example Format: https://example-shop.com/cart/c/c1-09av29f248bb6420de3842b051f6a1a3?key=824bdj25mhg1242bdb385

Action Required: If your app is manually constructing checkout URLs from cart IDs, you need to switch and use cart.checkoutUrl. If you’re augmenting the cart.checkoutUrl with additional parameters, update and validate that your code does not override the parameter and returns a valid destination URL.

We’ve added visibility into the theme install event itself as part of our existing integration with Google Analytics.

In addition to having full visibility into the theme install event, you can also now tie the theme install event to a Shop ID, enabling richer insights on the type of merchants that are installing your theme.

Learn more on our blog and shopify.dev.

We've added a new cleanup process for Subscription Contracts.

This process involves automatically canceling any Subscription Contracts owned by the subscription app that have not been terminated. These contracts may be in the active, paused, or failed status. The cancellation will occur 48 hours after a user uninstalls the app.

This is aligned with our purchase options cleanup process.

Previously, the Cart Transform API enabled functions to expand a single cart line item to form a bundle of components or add-on products, or merge multiple cart lines into a single line that represents a bundle.

With this release, update operations will also allow you to override the price, title, and/or image of a given line item. This gives you more more flexibility to make additional customizations to items in the cart.

More information can be found in the Cart Transform API developer preview documentation.

Hydrogen v2023.10 is now available. This release includes a number of new features and breaking changes.

Remix 2.0 (breaking change)

• Hydrogen 2023.10 now uses Remix 2.
• Remix has also been made a peer dependency, so you can keep your Remix package updated independently of Hydrogen.

Other breaking changes

• Hydrogen's default caching strategy has been updated to have a longer stale-while-revalidate period.
• A dependency bump for @graphql-codegen/typescript to v4 will require updates to Scalar types if you import them directly from Hydrogen or Hydrogen React.

Other changes

• All packages and examples now query v2023-10 API versions.
• Hydrogen now includes an API client for the Customer Account API.
• Custom cart methods are now stable.
• The GraphiQL client available through the local development server now includes the GraphiQL Explorer plugin, which makes it easier to browse GraphQL resources.
• Props and parameters that were deprecated in v2023-07 have been removed.
• Additional dependency bumps, patches, and fixes.

As of GraphQL Admin API version 2024-01, we're deprecating the images field from the ProductInput input object and replacing it with a media argument in the productCreate and productUpdate mutations.

Learn more about the usage of the media field on Shopify.dev

As of 2023-10-24, the order status page is getting a new look with updated visual treatment that is consistent with new customer accounts. This change will be rolling out progressively to all developer shops on checkout extensibility developer preview to ensure a smooth transition.

To view this change in developer shops on the checkout extensibility developer preview, navigate to Settings > Checkout > Customize and select Order Status from the page dropdown.

No action is required and there should be no changes to any UI extensions in development.

Learn more about UI extensions on the thank you and order status pages on Shopify.dev.

We've added the available_languages, continent and popular? properties on the country object in Liquid.

You can now access the languages that have been added to the market that a country belongs to, the country's translated continent name, and whether the country is a popular one amongst those that the shop sells to.

These properties provide flexibility when building a localization switcher, allowing customers to switch country and language simultaneously and allowing for grouping or sorting countries in a theme's country selector

Learn more about these new fields in the dev docs.

Shopify’s Mobile Checkout SDKs enables you to provide the world’s highest converting, customizable, one-page checkout directly within a mobile app. The presented experience is a fully-featured checkout that preserves all of the store customizations: Checkout UI extensions, Scripts, Functions, Web Pixels, and more. It also provides platform idiomatic defaults such as support for light and dark mode, and convenient APIs to embed, customize, and follow the lifecycle of the checkout experience.

Today we are launching Developer Preview of the Checkout SDK for iOS, with our Android SDK coming very soon. The SDKs are open-source and ready for you start building. During this developer preview, the APIs are subject to change as we adapt to feedback.

More information can be found in our blog post as well as in the Github repository and all feedback is welcome here.

Previously, the Cart Transform API allowed percentage based adjustments to the cost of a bundle when using expand operations. The (weight price algorithm) (http://shopify.dev/docs/api/functions/reference/cart-transform/developer-preview#/weight- price-algorithm) would then allocate the bundle price to its component lines based on the weight of each component line (unit price * quantity).

With this release, expand operations will also allow you to set fixed prices on each component of the bundle, resulting in a bundle price that is the sum of each component. Additionally, the expand operation will now allow you to define a custom title and image for each parent line item.

This gives you more control over bundle pricing and enables bundles to be used for add-on products.

More information can be found in the Cart Transform API developer preview documentation.

Starting October 11, 2023, Shopify's App Store and Theme Store will display the partner's geographical address and contact information in order to be in compliance with Business Imprint legal requirements. All partners should ensure their information is up to date.

Learn more about Business Imprint in the Shopify Help Center.

Now every English-language primary app listing is automatically translated into the 8 languages listed below, unless the partner provides their own translated listings for any of those languages.

• Brazilian Portuguese
• Danish
• Dutch
• French
• German
• Simplified Chinese
• Spanish
• Swedish

This will improve the experience of our international merchants, and significantly boost app installs in non-English speaking markets (by as much as 20%). To maximize the effect, complement translated listings with translating your app’s UI.

Learn more about automated listing translation on Shopify.dev.

With this update, the dev command is now supported for Flow extensions, you can use more complex data in your triggers, and Flow in the CLI is generally available.

Flow in the CLI

Flow in the Shopify CLI is now generally available. We still welcome feedback at flow-connectors-dev@shopify.com

Previously, Flow actions and triggers were defined in the partner dashboard. As Shopify CLI adoption has expanded, this meant that you needed to manage and deploy your Flow extensions separately from the rest of your app.

Going forward, you will now create your Flow tasks and actions through the CLI. You follow these guides for how to create both triggers and actions through the CLI. In addition, you can migrate your existing tasks to be CLI-managed, unifying your code. For more details on what is possible, you can also consult Flow’s reference guide for triggers and actions.

Dev command

You can now also use the dev command to preview Flow tasks in your development store. See our docs for triggers and actions.

Complex data in triggers

Finally, like actions, Flow triggers now support more complex data structures, like lists and objects, making it easier than ever to build your triggers in Flow.

Requirements

To create Flow extensions using the CLI, version 3.48 or higher is required. To use dev version 3.49 or higher is required.

As of API version 2023-10 and Shopify CLI 3.49.5, Shopify Functions configuration now uses targets to identify backend extensibility points in Shopify, so that configuring a function is now more like configuring other app extensions.

All Shopify Function APIs now support [targeting] configuration, with an extension target mapping to a specific WebAssembly export.

[[extensions.targeting]]
target = "purchase.validation.run"
input_query = "src/run.graphql"
export = "run"

Existing functions without targeting specified will continue to execute and deploy without any changes required. Use of targeting requires upgrading Shopify CLI to 3.49.4 or higher.

For more information, you can reference:

• Configuring app extensions
• Function configuration
• Function API references

As of API version 2023-10, Shopify Functions APIs now include the following values in their input query GraphQL schema, so that you can do more with Functions!

• A shop field is now available on the input root (example), which includes:
  • A localTime field, which provides the current date and allows testing the current time and date relative to provided arguments. (example)
  • A metafield field, which provides access to shop-level metafields.
• All Function APIs now include localization as part of their input root. (example)
• All Function APIs now include presentmentCurrencyRate as part of their input root. (example)

For more information, refer to the Shopify Function API references.

Shopify Functions now supports localization of the function name and description. Function names and descriptions which are displayed in admin, such as the names of function discount types, can now be translated into the user’s native language.

Use of this localization requires upgrading Shopify CLI to 3.49.5 or higher.

Learn more about localization of functions on Shopify.dev.

As of 2023-10, you can now query the productvariantid field of the LineItemGroup to identify which variant was used to model the bundle after it was purchased.

In addition, apps can now render custom UI for the bundles card on the product details page by claiming bundle ownership of the product.

Learn more about the product configuration extension for bundles.

As of API version 2023-10, a new webhook topic PUBLICATIONS_DELETE is added. This webhook occurs whenever a publication is deleted and requires the read_publications scope.

As of 2023-10, we have added STAFF to the OrderCancelReason GraphQL type to serve as a reason for canceling orders due to staff errors.

Learn more about OrderCancelReason on Shopify.dev.

As of version 2023-10 of the GrapqhQL Admin API, we've added the compareAtPriceRange field to Product which will return the minimum and maximum compare-at prices across a product's variants.

As of API version 2023-10, we've made changes to the ordering of line items in the cart. In the past, newly added items were placed at the end of the cart without explicit sorting. Now, line items will be sorted in reverse order by the time they were added to the cart, meaning the most recently added items will be positioned at the top.

Developers, be aware that this change could affect the ordering of cart items in your applications. If your app or store's functionality relies on the order of line items or an item's position in the cart, this update is especially relevant to you.

As of the 2023-10 version of the Admin GraphQL API, you can view the quantityPriceBreaks for a product variant on priceListPrice and productVariantContextualPricing. Additionally, you will be able to use the quantityPricingByVariantUpdate mutation to manage quantity price breaks, quantity rules, and fixed prices for multiple variants.

As of 2023-10, we've added a new field cancellation to Order graphQL object.

This field can provide additional details about the order cancellation, such as staff provided notes on why the order was cancelled. This data is currently available for some orders cancelled on Point of Sale app.

Learn more about Order on Shopify.dev.

We've added a subscription options for automatic discounts so that you can create automatic discounts for all your products. See the subscription discounts page for more details.

One important observation is that starting from API versions prior to 2024-01, the DiscountType will classify any automatic discount as "MANUAL". However, from 2024-01 onwards, it will accurately represent automatic discounts as "AUTOMATIC_DISCOUNT".

As of { 2023-10 }, we've added the following fields to the FulfillmentOrder graphQL object: orderId, orderName, orderProcessedAt, channelId.

With this change, order information required to fulfill an order is accessible on the fulfillmentOrder object with any of the fulfillmentorders access scopes. The same data is available via fulfillmentOrder.order, but this requires readorders access scope.

Learn more about FulfillmentOrder on Shopify.dev.

As of the { 2023-10 } API version, you can use { DeliveryMethod } to get the value of the { serviceCode } chosen for the related { FulfillmentOrder} . The { DeliveryMethod } object is now accessible through any of the fulfillment order scopes.

Learn more about { DeliveryMethod } on Shopify.dev.

As of GraphQL Admin API version 2023-10, you can grant READ or READ_WRITE access to your metafields to explicitly specified apps, by using the new grants property of the access object in your metafieldDefinitionCreate and metafieldDefinitionUpdate mutations. You can pass a list of up to 16 grants per definition, specifying the grantee and the level of access to grant.

This could be useful if you need fine-grained control over access to your metafields, for example you could keep the admin access setting PRIVATE but explicitly grant access to other app ids.

Learn more about metafield access controls on shopify.dev.

Note that the introduction of explicit grants required a breaking change to the metafieldDefinitionUpdate mutation - see Breaking change to metafieldDefinitionUpdate mutation: access input type changed for details.

As of 2023-09-15, we've made updates to the color settings available in the Checkout Branding API, moving to the 2023-10 stable release.

These changes will give merchants more control over colors in checkout including defining and applying color schemes with more controls over borders, icons, form fields and button colors

Note: please reference the new CheckoutBrandingColorsInput element and avoid the deprecated CheckoutBrandingColorPaletteInput when making changes to checkout branding via the API. Any previous API calls that set a colorPalette have been automatically updated to the new color system. Future API calls must use the new system in order for changes to be reflected.

Learn more about our color settings here or review the reference documentation.

As of 2023-10, a new field payment_method_name is available in the PaymentDetails GraphQL API and the payment_details property in the Transaction resource of the Admin REST API. This field provides information about the payment method used to process an order transaction.

This update is in preparation for changes releasing in January 2024 where new Shop Pay Installment transactions will have a gateway value of shopify_payments.

Once released, relying on the gateway value to determine if an order is a Shop Pay Installments transaction will no longer be feasible. Instead, it will be necessary to utilize the payment_method_name value to identify the transaction type.

For example, you can identify Shop Pay Installments transactions by checking that payment_method_name has a value of shop_pay_installments. For historical orders prior to 2023-10, you still need to check the gateway value to identify Shop Pay Installments orders.

Learn more about the change in the PaymentDetails GraphQL API doc and Admin REST API doc for Transactions.

As of API version 2023-10, we've added the METAOBJECT_DEFINITION_CHANGED error code to the MetafieldDefinitionUpdateUserErrorCode enum. This new error code is returned if you attempt to update a metaobject_reference metafield definition so that it references a different Metaobject definition. Previously, this action would result in an INTERNAL_SERVER_ERROR.

Learn more about METAOBJECT_DEFINITION_CHANGED on https://shopify.dev/docs/api/admin-graphql/2023-07/enums/MetafieldDefinitionUpdateUserErrorCode

It’s now possible for merchants using Hydrogen or the Headless Channel in the admin to offer bundles with Shopify.

Headless merchants can choose from creating fixed bundles and multipacks with our free Shopify Bundles app, using one of these updated bundle apps for more bundle support or using our APIs (Shopify Plus and Shopify partners only) to create a custom bundle offering.

Learn more about bundles on Shopify.

As of September 27, we added the following updates to POS UI Extensions:

• Introduced a Connectivity API which gives the UI extension access to the information about the device connectivity.
• Added optional BadgeStatus prop to the Badge component
• Added optional overrideNavigateBack prop to the Screen component
• Added isDevice function to the Device API

All of the changes are available for POS UI extensions version 1.4.0 and POS app version 8.18.0. See the version log for all version details.

New quality of life updates are here for the range and select input settings! Featuring enhancements to the design and functionality of these settings, these two changes will improve the theme editing experience.

We have introduced a new input box as part of the range setting updates. Merchants now have two ways to set their range value, either by using the existing slider or by typing in a value, which offers more flexibility and precision when setting values.

The select setting can now present itself in one of two ways, either as a dropdown list, or as a new segmented control. Depending on the options passed in, the setting will apply the ideal visual treatment accordingly.

Learn more about the range setting and select setting changes in our developer documentation.

A new input setting of type text_alignment has been introduced, featuring an icon-based segmented control design.

The setting comes pre-built with default values left, center and right, which cannot be changed.

Learn more about the text_alignment setting in our development documentation.

We've added default lazy loading for the image_tag when it occurs in sections further down the page.

We've also added new section properties so you can customize this behavior as well as fix other web performance issues dependent on layout position:

• section.index - the 1-based index of a section within its location
• section.index0 - the 0-based index of a section within its location
• section.location - the location of the section (e.g., template, section group type, etc.)

You can now fix performance anti-patterns like lazy loading images above the fold and layout shifts due to async CSS loading without depending on section settings.

Learn more about the new image_tag behavior and how to use the new section properties.

As of Admin GraphQL API version 2023-10, you can query the CustomerAccountsV2 field on the Shop object to get information about the shop's customer accounts settings. CustomerAccountsV2 will let you adapt your app's behaviour to the merchant's customer accounts settings.

Learn more about CustomerAccountsV2 on Shopify.dev.

We've made updates to the Theme Store requirements, in relation to the prohibited use of externally hosted scripts, and code which interferes with native Shopify functionality. These requirements are contained within Section 7, Consistency and functionality and inform that:

• Scripts included in theme code must be hosted on Shopify's servers, with the exception of approved third-party libraries.
• Themes must not include any Javascript or code that interferes with, or augments, any native Shopify feature within the theme editor or Shopify admin.

These requirements are to ensure all themes in the Shopify Theme Store are secure, reliable, performant, and maintain a consistent user experience.

The new requirements can be viewed on Shopify.dev.

As of Storefront GraphQL API version 2023-10, we’ve added the VALIDATION_CUSTOM error type to CartErrorCode so that you can use validation errors in carts.

Learn more about cart validation errors on Shopify.dev.

Admin action extensions are now generally available and can be deployed to apps. These new extensions enable you to seamlessly integrate your app's functionality into the Shopify admin by embedding workflows and UX on core admin pages.

Once deployed, merchants can find actions in the “More actions” menus at the top of Products, Orders, and Customers pages in the admin. When a merchant launches the extension, it will appear as a modal over the current page. By giving merchants access to your app's functionality, without the need to navigate away from their current task, these extensions help increase efficiency and productivity.

Admin action extensions come with direct API access, enabling them to use the Admin GraphQL API without having to proxy the calls through their app's backend resulting in faster and more responsive apps.

Learn more about admin action extensions on Shopify.dev.

Developers can now generate more demand for your apps by showcasing them on the homepage of the Shopify App Store.

Learn more about homepage ads on our blog and shopify.dev.

We’ve added visibility into the app install event itself as part of our existing integration with Google Analytics. This addition enables developers to more easily compare the performance of your Shopify App Store Ads with your other marketing activities on and off Shopify.

In addition to having full visibility into the app install event, you can also now tie the app install event to a Shop ID, enabling richer insights on the type of merchants that are installing your app.

Learn more on our blog and shopify.dev.

With the latest version of App Bridge, you can use the Print, Scanner and Share APIs.
Both Print and Share rely on web standards. Learn more about these APIs on Shopify.dev

It is now possible to offer automatic free shipping discounts using the GraphQL Admin API using discountAutomaticFreeshippingUpdate and discountAutomaticFreeshippingCreate.

Learn more on Shopify.dev.

Liquid Console is now available, a tool that enables Liquid testing and evaluation directly in your code editor through Shopify CLI. This feature accelerates your feedback loop, simplifies debugging, and assists developers learning Liquid.

Get started by running the command shopify theme console in your terminal. This command opens up an efficient way to experiment with Liquid filters and explore Liquid object data structures.

Learn more about Liquid Console on Shopify.dev.

We’re simplifying feedback collection and reducing non-informative content. These ratings contribute to the overall score without impacting the recent review ranking updates.

You can now use the GraphQL Admin API to adjust new inventory states: safety_stock, damaged, and quality_control.

By moving inventory units to one of these states, they are tracked as part of a merchant's on_hand inventory, but are unavailable for sale. Inventory quantities in one of these states display as Unavailable to merchants that are tracking inventory in the Shopify admin.

Learn more about the the new states on Shopify.dev.

Starting Monday September 18th, languages listed under the Languages section of your App Store listing must be fully available within the app. Any language listed that is not accessible within the app must be removed until translations can be completed.

To learn more, please see the App Store Requirements on Shopify.dev.

We've added a filter for apps that have achieved Built for Shopify status, which can be used in combination with category and feature filters. Learn more on shopify.dev.

Cart and Checkout Validation Functions now run on the online store cart (they previously only ran on the storefront cart API). You can now apply custom validation logic to buyers on the online store as well as custom storefronts.

Learn more about Cart and Checkout Validation Functions on Shopify.dev.

As of August 17, 2023 4:30 pm EDT, checkout_started now triggers on every checkout visit in checkout extensibility.

The customer event, checkout_started, will now trigger for all checkout visits if you upgraded to checkout extensibility. Previously, it only triggered the first time you entered the checkout.

Additional event data will provide additional insights into the customer journey. The customer event reference can be found here.

As of August 16, we added the following components to POS UI extensions:

DatePicker

TimePicker

DateField

TimeField

EmailField

NumberField

TextField

TextArea

The Tile component's props have been updated:

enabled is now optional

onPress is now optional

badgeValue added

All of the changes are available for POS UI extensions version 1.3.0 and POS app version 8.15.0. See the version log for all version details.

As of 2023-10 we're introducing new metaobject capabilities to enable SEO attributes and make entries renderable in the Online Store. These capabilities make it possible to render landing pages from metaobject entries.

The renderable capability enables setting SEO metadata attributes on your metaobjects. These attributes are accessible in Liquid and via the Storefront API.

The Online Store capability makes your metaobjects render as web pages in the Online Store by assigning a theme template and defining a URL.

Both capabilities can be enabled and configured independently when creating and updating a metaobject definition.

Learn more about the renderable and onlineStore capabilities on Shopify.dev

For Server Pixels, we've added order_id to the checkout_completed event payload so that you can track it server-side.

We’ve shipped refinements to our app review ranking system and will continue to further invest in it. If you have any feedback, please submit it to this form.

Soon, you'll be able to release all your extensions at the same time, directly from Shopify CLI. New app-level extension versioning will help you to keep better track of your app's iterations, and allow you to easily revert to previous versions, if needed. You’ll also be able to preview Functions using the dev command, and delete any extension.

This functionality will be included in a future release of Shopify CLI. You'll be able to opt in for each app that you develop.

Learn more about simplified deployment.

Flow in the Shopify CLI is available in developer preview. We welcome feedback at flow-connectors-dev@shopify.com

Previously, Flow actions and triggers were defined in the partner dashboard. As Shopify CLI adoption has expanded, this meant that you needed to manage and deploy your Flow extensions separately from the rest of your app.

Going forward, you will now create your Flow tasks and actions through the CLI. You can follow these guides for how to create both triggers and actions through the CLI. In addition, you can migrate your existing tasks to be CLI-managed, unifying your code. For more details on what is possible, you can also consult Flow’s reference guide for triggers and actions.

To create Flow extensions using the CLI, version 3.48 or higher is required. Please note that Flow does not currently support the app dev command.

Your Flow actions can now return data into the Flow environment, allowing your merchants to build new types of automations making use of your app and data.

Several Flow actions make use of return data, allowing merchants to use data from other services. For example the OpenAI connector returns AI-generated text from OpenAI's completion API. Flow's "Get data" actions, including Get order data, return a list of objects that can be used in the workflow.

To use return data, your action must be defined through the Shopify CLI. You must use CLI version 3.48 or higher.

Starting today partner accounts can distribute a single custom app to all stores within a Shopify Plus organization. As a result, it's now much simpler to manage and maintains apps for multi-store organizations.

Learn more about custom app distribution in the Shopify developer docs.

You can now create custom apps that contain only extensions without the need to build and host an external web application, or implement OAuth. Custom apps without a requirement for embedded admin pages can now be created from the CLI and installed on merchant stores.

Learn more about extensions-only apps

We have released API versioning for checkout UI extensions. As part of this release, we are also moving checkout UI extensions over to the new ui extension packages.

• For information on how to adopt API versions for existing extensions, visit our versioning page
• For more details on the what and why, see our post on github

Developers can now create and test Admin action and block extensions in their dev stores. These new extensions enable you to seamlessly integrate your app's functionality into the Shopify admin by embedding workflows and UX on core admin pages. By giving merchants access to your app's functionality, without the need to navigate away from their current task, these extensions help merchants be more efficient and productive.

Admin actions and blocks can use direct API access, enabling them to use the Admin GraphQL API without having to proxy the calls through their app's backend resulting in faster and more responsive apps.

Learn more about Admin action and block extensions on Shopify.dev.

Apps that have achieved Built for Shopify status now have special badging and promotional placements in the Shopify App Store, helping them get in front of the right businesses at the right time.

Learn more

The Shopify Functions API for cart and checkout validations is now available on production stores for custom apps.

Learn more about building cart and checkout validations in our dev docs: Cart and Checkout validations

The Developer Preview of the Customer Account API is now available for exploration and experimentation. This API can be accessed through the Hydrogen and Headless channels, providing developers with early access to its powerful features. The Customer Account API offers enhanced security, authentication, and personalization capabilities for headless storefronts. It enables passwordless single sign-on across all of the Shopify platform, from Liquid to Hydrogen and non-Hydrogen custom storefronts, all the way through to checkout. The Customer Account API also empowers effortless customer-scoped management for DTC–accounts, orders, drafts, payments, fulfillment, discounts, refunds, and metafields (shop, order, customer).

This version of the Customer Account API is marked as unstable as there will be changes and updates to refine and improve its functionality. We encourage developers to provide feedback and share their experiences to help shape the future iterations of this API.

Read the developer documentation to learn more.

We’ve added app review summaries (powered by Shopify Magic) to the Shopify App Store, helping merchants see your app’s value based on other merchants' experiences. To start, review summaries will appear for apps with at least 100 reviews and a 4.0 rating.

Merchants can leave feedback when viewing the summary. We ask that developers share feedback using this form, which will be shared with the product team.

Oxygen has now added support for log drains, which allows developers to forward their Hydrogen storefront’s application logs to third-party log management platforms, including DataDog, Splunk, and New Relic.

Log drains can be easily set up and configured through the Shopify admin, with no code required. Merchants with complex monitoring needs now have full control of log monitoring, analysis, and retention–in your observability service of choice.

This feature is available today for all merchants on the Shopify Plus plan. Read the developer documentation to learn more.

Building headless stores with Hydrogen is now even faster with our latest release.

Starting a new Hydrogen project with the Shopify CLI now gives you more options. You can scaffold a full purchase journey with standard app routes, add your favorite styling library, and configure language and currency settings, and connect your live product inventory to your Hydrogen app with a single command.

Hydrogen also features pre-built components optimized for Remix for better performance, SEO, and DX – from cart, image, product form, to pagination. And enhanced type safety support with built-in GraphQL codegen ensures your build is least error-prone.

Learn more about our latest release in detail and what’s coming next.

Storefront API now serves all legitimate requests from both private and public clients without rate limits. Headless stores will stay protected against bot activity and never hit a throttle, no matter the size of traffic they receive. All included for free in your plan.

Read the developer documentation to learn more.

We've updated the App Design Guidelines for better clarity and coverage of the trickiest parts of app design. “Mandatory” and “Unacceptable” directives are now “Must Do” and “Do Not”, to clarify that all these directives must be met to qualify for Built for Shopify status. We have also added new guidelines for Forms, Marketing, and Admin UI extensions.

All Built for Shopify applicants will be evaluated against the updated App Design Guidelines starting September 1, 2023.

See the new guidelines on Shopify.dev.

There are now more ways than ever to customize and extend Shopify, from storefront to checkout to admin.

Explore the latest updates to our suite of APIs, SDKs, and developer tools.

• Create the best checkout experience with 17 new APIs and updates for Shopify Checkout
• Build Hydrogen storefronts faster with Remix-optimized workflows and CLI improvements like enhanced type safety support, and scale effortlessly without rate limits on the Storefront API
• Develop apps faster and more easily with our new Remix app template, extension-only apps, and config as code
• Extend the Shopify admin in entirely new ways with admin UI extensions
• Stand out from the crowd—Built for Shopify badging and promotional placements are now live in the Shopify App Store
• Customize Shopify’s backend logic with new Function APIs, support for JavaScript now generally available, and faster development and iteration with the shopify app dev command

Visit the Editions website to see all the developer announcements.

You can now use the Cart Transform Function API to expand or merge cart line items. The Cart Transform API is used to build customized bundles.

For more information on the Cart Transform Function API click here.

For an overview on building a custom bundle offering click here.

The ProductVariantComponent API has recently been added to the GraphQL Admin API allowing for the implementation of fixed bundles.

To build customized bundles, use the newly launched Cart Transform Function API.

For more information on creating bundles click here.

• Shipping address write API - Extensions can use the applyShippingAddressChange API to modify address values on behalf of a buyer.
• B2B context APIs - Extensions can now read details about a purchasingCompany as well as checkout settings that apply to the current buyer
• Support for new metafield types - Extensions can now read metafields on carts, companies, or companyLocations. They can also write to cart metafields

The beta release of Polaris v12 is now available, providing developers with early access to resources for updating the look and feel of your apps to fit seamlessly within the newly redesigned Shopify admin.

Learn more about Polaris v12-beta on polaris.shopify.com.

We have released a new version of App Bridge. You can add the <script> tag to the <head> of your app pages and get the benefits immediately.

App Bridge has been written from the ground up to be more familiar to web standards.

App Bridge will keep itself up to date automatically, so you don't have to worry about version updates.

Learn more about App Bridge in the documentation

As of today, extensions are packaged and deployed at the same time, directly from Shopify CLI. New app-level extension versioning will help you to keep better track of your app's iterations, and allow you to easily revert to previous versions.

Until September 5th, you can opt in to get access to simplified deployment. Simplified deployment is available in Shopify CLI 3.48.

On September 5th, all apps will automatically be opted in to simplified deployment.

Learn more about simplified deployment.

Starting today, you can configure and manage your apps directly in your codebase without having to visit the Partner Dashboard. Using Shopify CLI, you can link your shopify.app.toml file to an app, modify the configuration, and push the configuration live.

Learn more about app configuration.

As of the latest unstable GraphQL API version, we have introduced the ability to utilize the Admin API for managing Smart Grid for Point of Sale. This enhancement enables the creation and naming of Smart Grid layouts that are not yet linked to any location. Once prepared, the API facilitates the assignment of a layout to single or multiple locations. Any subsequent modifications to this layout will be reflected across all assigned locations, eliminating the necessity for individual manual adjustments.

Just request the appropriate access scope(s) be added to your app.

Learn more about Smart Grid management on Shopify.dev.

• As of 2023-10 version of the Shopify Functions API, you can use the Fulfillment Constraints API to have a higher degree of customization when defining fulfillment and delivery strategies. With this API, checkout won’t return any shipping rates if the configured constraints can’t be met.
• For example, you can specify that certain products must be fulfilled from a specific location, based on buyer information, cart information or metafields.
• Learn more about Fulfillment Constraints on Shopify.dev.

As of today, the way cart lines are folded when a BXGY discount is applied to the cart is changing in the Storefront API. The lines will now be grouped by applied discount and discounted amount. This change ensures that the Storefront API behaviour matches the existing line folding functionality of the Online Store/Ajax API Cart.

For example, if you have a buy one get one free discount for a product variant and you add 3 of that variant to a cart. The cart lines will be; * Item with quantity of 1, no discount applied * Item with quantity of 1, BXGY discount code applied, adjusted discounted price of 0 * Item with quantity of 1, BXGY discount code applied, full price of product variant

This change reflects the existing line folding functionality of the Online Store/Ajax API Cart.

As of API version 2023-10, url field is available on the GraphQL MediaImage's originalSource field https://shopify.dev/docs/api/admin-graphql/2023-07/objects/mediaimage#field-mediaimage-originalsource.

This will be a signed URL that is valid only for a short period of time. It provides access to the originally uploaded uncompressed image.

As of the latest unstable version and upcoming 2023-10 version of the Admin GraphQL API, you can use the shopifyProtect field of Order to view the protection status of Shop Pay orders. The protection status is established asynchronous from the orders/create webhook so you can also listen to the orders/shopify_protect_eligibility_changed webhook to know when the protection status is created or updated.

By providing a clear view of an order’s protection status, we're empowering developers to make more informed decisions. For instance, fraud protection apps can avoid redundant costs for merchants when a Shop Pay order is already protected.

Learn more about Shopify Protect’s protection status on Shopify.dev.

We’ve combined the “Fit seamlessly” and “Integrates with” fields on our app listing pages into one place. Apps that are built using the Checkout and Point of Sale extensions will have them automatically noted in the “Works with” field on the app listing.

Log into your Partner Dashboard and click on Apps > Manage Listing to view the “Integrations” field for your app to ensure the content is up to date.

We’ve updated the app settings page with a new notification system to inform merchants of notable insights on their installed apps. Merchants will be able to quickly identify apps that are unsupported, incompatible, require action, on free trial, paid (including the cost), or least used.

As of July 12, we're temporarily removing the Cumulative Layout Shift (CLS) metric from our admin performance standard for Built for Shopify.

In order to meet our admin performance standard for Built for Shopify, apps will still need to meet performance targets for Largest Contentful Paint (LCP) and First Input Delay (FID).

We are making this change to improve the measurement of this metric. We expect CLS to become a part of our admin performance standard again by the end of 2023.

Learn more about admin performance on Shopify.dev

You can now use search and predictiveSearch queries in the GraphQL Storefront API to enable natural language search on your custom storefronts.

The search API returns the most releavant search results among product, page and article resource types. Merchants can use the Shopify Search & Discovery app to change the default value of the resource types and customize search results.

The predictiveSearch API helps you implement a predictive search dropdown interface where suggested results are displayed immediately as buyers type into the search bar.

Learn more about new search APIs on Shopify.dev.

As of API version 2023-07, you can use the new Subscription Contract stale status to express a contract that has been marked as stale due to inactivity.

We're deprecating the SubscriptionDraftErrorCode STALE_CONTRACT and replace it by CONCURRENT_CONTRACT_UPDATE for a better description of the error.

We're introducing the new error code CONTRACT_STALE_STATUS to SubscriptionBillingCycleErrorCode and SubscriptionDraftErrorCode to indicate whenever we attempt to update or bill a contract that hasn't been used for 1 year.

We've added trackingParameters on Product, Collection, Article, Post and SearchQuerySuggestion when it is a part of results coming from search and predictiveSearch as adding this to a page URL when it is linked from a search result allows for tracking the origin of the traffic.

Learn more about trackingParameters on Shopify.dev.

As of 2023-07 partners will be able to determine whether fulfillment has been on hold for a post-purchase with the reason ONLINE_STORE_POST_PURCHASE_CROSS_SELL.

Learn more about this new feature here

The DeliveryMethod object now has a brandedPromise field that can be used to determine if an order was branded with "Shop Promise" at checkout.

Additionally, the MailingAddress object now includes the timeZone field, which can be used with the DeliveryMethod's maxDeliveryDateTime field, to determine the date and time according to the time zone of the destination address.

The new field on the GraphQL DeliveryMethod object is:

• brandedPromise

Learn more about this new field in the GraphQL reference docs.

The new field on the GraphQL MailingAddress object is:

• timeZone

Learn more about this new field in the GraphQL reference docs.

Learn more about Shop Promise eligibility.

As of API version 2023-07, a new error code item_not_stocked_at_location will be added to the the inventorySetOnHandQuantities, inventoryAdjustQuantities, and inventoryMoveQuantities mutations. This error code is returned when you attempt to change inventory quantities for an item that is not stocked at the specified location.

Learn more about managing inventory quantities on Shopify.dev.

As of the 2023-07 Admin API release, you can now apply a PUBLIC_READ access setting to your metafield definitions. If your metafield definition is PUBLIC_READ, this means:

• The merchant can read the metafields on the definition.
• All installed applications with proper access scopes can read the metafields on the definition.
• Only the owner of the definition can write metafields.

This new setting builds upon the PRIVATE, MERCHANT_READ, and MERCHANT_READ_WRITE access settings released in January 2023.

Note that the access field can only be set when the definition is in your own reserved namespace.

Learn more about access controls.

As of the Admin API 2023-07 Release, we are providing additional webhook notifications for changes to the major entities within the B2B Customers product. These hooks are provided to enable better integration with Flow. The following webhooks are provided:

• company_contact_roles/assign
• company_contact_roles/revoke

Learn more about these webhooks on Shopify.dev

As of API version 2023-07 partners will be able to split and merge fulfillment orders. Patners can split a single fulfillment order into multiple fulfillment order dividing the line line items across multiple fulfillment orders. Partners can also merge fulfillment orders together into a single fulfillment order

Learn more about fulfillmentOrderSplit here and fulfillmentOrderMerge here

As of API version 2023-07 new error codes FILENAME_ALREADY_EXISTS and INVALID_FILENAME will be added to the fileUpdate mutation. These error codes are returned when you attempt to update the filename (URL Handle) and the input either matches an existing filename (URL Handle) or it is invalid.

As of 2023-07, you can use total_count on CustomerSegmentMemberConnection endpoint, which will provide you with the total count of your specified customer segment. Also, as of 2023-07, we're removing total_count field on SegmentStatistics. Using the total_count functionality will make it easier to know the count of members of your specified segment.

As of API version 2023-07 we have added a new field called filename to the fileUpdate mutation. This new field allows you to update the filename of both generic files and images.

To learn more about the fileUpdate mutation, visit the GraphQL reference in our developer documentation.

As of API version 2023-07 , you can now specify a custom filename when using the fileCreate mutation to create files that will appear in the Admin.

To learn more about the fileCreate mutation, visit our developer documentation.

As of 2023-07, you can use the new field type on TranslatableContent to get the type of the translatable content.

The new type field gives more information about the underlying translatable content which enables the ability to conditionally render UI elements such as input fields.

Learn more about the LocalizableContentType object on Shopify.dev

As of Admin API version 2023-07, all partners have access to Contextual Product Feeds. Partners will be able to receive contextual product data for any contexts they want that are supported by the merchant. To get started, the partner will need to create product feeds and subscribe to productfeeds/incrementalsync and productfeeds/fullsync webhooks.

For more information on how to query for product feeds, visit our developer documentation.

The 2023-07 API version of the Checkout Admin REST API will expose the discount_class attribute in the line_items[n].applied_discounts and line_items[n].discount_allocations.

The discount_class identifies the type of discount applied to a line_item:

PRODUCT - denotes a Product class discount that applies to specific products only. ORDER - denotes an Order class discount that applies across all line items.

The following example shows the "discount_class": "ORDER" present for the line item when an order class discount was applied to a checkout.

"line_items": [
    {
        "id": "a93dfd7540730e5d9812a92fac5a640e",
        "key": "a93dfd7540730e5d9812a92fac5a640e",
        "product_id": 6,
        "variant_id": 10,
        "sku": "jeans1",
        "vendor": "",
        "title": "Jeans",
        "variant_title": "Black",
        "image_url": "",
        "taxable": true,
        "requires_shipping": true,
        "gift_card": false,
        "price": "50.00",
        "compare_at_price": "30.00",
        "line_price": "50.00",
        "properties": {},
        "quantity": 1,
        "grams": 0,
        "fulfillment_service": "manual",
        "applied_discounts": [],
        "discount_allocations": [
            {
                "id": null,
                "amount": "20.00",
                "description": "ORDER$20",
                "created_at": null,
                "application_type": "discount_code",
                "discount_class": "ORDER"
            }
        ],
        "tax_lines": []
    }
],

As of 2023-07, you can now create region-specific subfolders on country-code top-level domains (ccTLDs), such as shop.ca or shop.fr. Previously, subfolders could only be created on generic top-level domains (gTLDs).

As of GraphQL Admin API version 2023-07, the CustomerSegmentMember object now has the attributes and connections to access the metafields associated to the customer.

Learn more about the CustomerSegmentMember object on Shopify.dev.

As of GraphQL Admin API version 2023-07, the SegmentEventFilterParameter object now has the attribute acceptsMultipleValues to denote if the parameter can handle multiple values. For example, the id parameter for the products_purchased function can accept multiple values: products_purchased(id: (2012162031638, 1012132033639) = false.

Learn more about the Segment query language on Shopify.dev.

As of the 2023-07 release, you can use the companyContactRemoveFromCompany mutation in GraphQL to remove a company contact from a company even if they have placed orders on behalf of the company.

For more information on this new mutation, visit our developer documentation

As of 2023-07, you can use the new field isMarketplace on ChannelDefinition to check if a channel definition represents a marketplace such as Shops on Facebook and Instagram or Buy on Google.

The new isMarketplace field gives the ability to know if any object that references ChannelDefinition is related to a marketplace channel. For example, you can know if an order was placed on a channel that is a marketplace or if the store has available channels that are marketplaces.

Learn more about the isMarketplace field on Shopify.dev.

As of GraphQL Admin API 2023-07, we've added the taxExempt field to the Order object. You can use this field to determine whether or not an order was exempt from taxes.

Orders can be exempt from taxes if the "Charge taxes" option was disabled during the creation of a Draft Order, or if the order was created for a customer with the "Collect tax" option disabled.

Note that any products that are tax exempt in an order are not considered when calculating the taxExempt field .

Learn more about the taxExempt field on Shopify.dev.

In the Admin API 2023-07 Release, we are deprecating the productDuplicateAsync mutation and introducing the productDuplicateAsyncV2 mutation and the productDuplicateJob query.

The new mutation brings several improvements over productDuplicateAsync, enhancing the overall user experience and performance of the endpoint.

• productDuplicateAsync has been deprecated.
• productDuplicateAsyncV2 has been introduced.
• productDuplicateJob query has been introduced to fetch the status of an existing product duplication job.

Learn more about these changes at productDuplicateAsyncV2 and productDuplicateJob.

As of Admin API 2023-07 release we've added TOTAL_ITEM_QUANTITY to OrderSortKeys so that you can sort orders by the total quantity of items.

For more information on all of the other order sort keys that are available, visit our developer documentation.

New fields have been added to all Shopify Functions APIs.

• The sellingPlanAllocation field is now available on CartLine.
• The title field is now available on Product, CustomProduct, and ProductVariant.
• The inCollections field on Product allows for checking membership in individual product collections.
• The hasTags field on Product and Customer allows for checking the presence of individual tags.
• The isAuthenticated field on BuyerIdentity identifies whether the customer is logged in.

For details on these fields, see the API Reference documentation for Shopify Functions.

As of Admin API version 2023-07, selected partners can use the new customerPaymentMethodGetDuplicationData and customerPaymentMethodCreateFromDuplicationData to migrate subscription contracts and its vaulted payment method between shops within the same organization.

This is currently limited to specific partners, and to subscriptions checked out through Shop Pay.

No action is needed from developers at this moment.

As of version 2023-07 of the Storefront GraphQL API, you can now use the StoreAvailability.quantityAvailable field to determine the inventory available for a product variant at a particular local pickup location.

As of REST Admin API 2023-07, we've added the tax_exempt field to the Order resource. You can use this field to determine whether or not an order was exempt from taxes.

Orders can be exempt from taxes if the "Charge taxes" option was disabled during the creation of a Draft Order, or if the order was created for a customer with the "Collect tax" option disabled.

Note that any products that are tax exempt in an order are not considered when calculating the tax_exempt field .

Learn more about the tax_exempt field on Shopify.dev.

We’ve added the taxAppConfigure mutation, which now enables selected tax partners to configure the state of an existing integrated tax service. This extended control provides partners with more flexibility and adaptability in managing tax services, ensuring a smoother, more efficient operation for their application.

For more information, visit shopify.dev

As of 2023-07, we are introducing sales type UnknownSale with line type UNKNOWN that represents new types of sales that may be added in the future and do not exist on older versions.

This is a complimentatry object type for the SalesLineType UNKNOWN and implements the Sale interface.

As of the Admin API 2023-07 Release the tax_partners/update webhook will be available.

The tax_partners/update webhook will be called whenever a tax partner is added or updated. Partners can use this webhook to determine when a merchant has made changes to the partner's tax app.

Learn more about these webhooks on Shopify.dev

Sales records can now be of type AdditonalFeeSale as of 2023-07, which represents a sale associated with an additional fee charge.

For more information on this new type implementation, visit the documentation for the sale interface.

As of API version 2023-07 we have added a new field called poNumber to the Order and DraftOrder object.

The OrderInput and DraftOrderInput input objects now accept a poNumber. This will set the purchase order number during an orderUpdate , draftOrderUpdate and draftOrderCreate mutation.

As of the 2023-07 version of the Admin GraphQL API, you can use the quantityRulesAdd and quantityRulesDelete mutations to manage product variant minimums, maximums and increments for B2B customers. Use the quantityRules field on ProductVariantContextualPricing to view the quantity rules applied for the companyLocationId input.

Learn more about the Quantity Rules API on Shopify.dev.

As of June 26, we added a PinPad component, a Product Search API and a Device API.

POS UI extensions Navigator component now supports a new prop called initialScreenName. It can be used to set the name of the Screen to initialize to. The List component was updated to support badge property for leftSide image, and toggleSwitch property for rightSide.

We also made the amount field in the applyCartDiscount function of the Cart API optional to allow for code discounts.

All of the changes are available for POS UI extensions version 1.2.0 and POS app version 8.12.0.

As of GraphQL Admin API version 2023-07, you can filter orders by their confirmation number.

The confirmation_number filter is available on the orders connection. This number corresponds to the order confirmation number that customers see after checkout.

Developers can now customize and preview one page checkout from the checkout editor. With this new developer preview, one page checkout is automatically compatible with existing checkout extensions and customizations. Preview and prepare for one page checkout today.

Learn more about one page support in the checkout editor in the Shopify developer docs.

We heard you love extensions. We heard you want more per app. So we shipped 10x the goodness so apps now have a limit of 50 extensions.

We’ve made it easier than ever to build checkout UI extensions on the order status page! More specifically, we’ve added new getting started tutorials to help you build extensions that target all, or specific pages in the customer journey. We’ve also launched a new testing experience in the checkout editor, so you can preview what merchants will see when customizing their post-checkout extensions. Learn more.

Using the TranslationsRegister GraphQL API, you can now register translations for resource handles in order to create localized online store urls for merchants. For example, merchants may want their product URLs to be example.com/products/en-us/red-shoes for English-speaking customers and example.com/products/es-us/zapatos-rojos for Spanish-speaking customers.

The resource types that support translatable url handles are Products, Collections, Articles, Blogs, and Pages. This change is supported across all api versions.

On June 22nd we introduced a new ranking system for app reviews that factors in the quality of a review to determine which reviews are surfaced first. Reviews with helpful, meaningful content that were submitted recently by merchants who have used the app for an extended period will appear first.

All reviews are continuously monitored by Shopify and non-compliant reviews will be automatically removed.

As of the Admin API 2023-07 release for GraphQL, we're providing additional webhook subscription topics for customer tags:

• CUSTOMER_TAGS_ADDED
• CUSTOMER_TAGS_REMOVED

Learn more about these webhooks on Shopify.dev.

As of 2023-07, you can use the abandonmentUpdateActivitiesDeliveryStatuses to update the delivery status of marketing activities created via Flow action extension. We are deprecating the abandonmentEmailStateUpdate mutation since it's being replaced by the new API.

As of GraphQL Admin API version 2023-07, we're deprecating a set of fields used for associating images with products and variants. Please, have a look at the list of upcoming changes:

• On ProductInput: we're deprecating the images field. Use the newly introduced media field instead.
• On ProductVariantInput: we're deprecating imageId and imageSrc fields. Use mediaId and mediaSrc instead.
• On ProductVariantsBulkInput: we're deprecating the imageSrc field. Use mediaSrc instead.

Learn more about ProductInput, ProductVariantInput and ProductVariantsBulkInput on Shopify.dev

Shopify increased Admin API rate limits for the Advanced plan by 2x over standard limits. Apps installed on Advanced plan stores will now get 100 points/second on the GraphQL Admin API and 4 requests/second on the REST Admin API.

Read more about API rate limits.

On June 5 we released a new filter for App Store search results pages that will allow merchants to easily identify apps with extensions for Shopify Checkout and Shopify Point of Sale.

Apps no longer need to be a channel in order to access the Storefront APIs. Just request the appropriate unauthenticated access scope(s) to your app.

Take advantage of the Storefront API’s powerful contextualization features to build rich customer-facing experiences for your merchants.

Learn more about authenticating with the Storefront API on Shopify.dev

As of Admin API version 2023-07, we are deprecating creating application credits through the Admin API. Both the REST resource, and the GraphQL mutation will have their ability to create application credits deprecated. Going forward, create application credits using our new appCreditCreate mutation in the Partner API.

This change will allow us to implement new features for application credit creation, such as allowing Partners to issue credits to Shops that have uninstalled their app.

Theme developers can now add color schemes to themes. This update adds clarity and flexibility to the theme editing experience by allowing theme-defined and merchant-defined color schemes, adding a visual preview that enables merchants to more easily and predictably update theme colors, and allowing merchants to implement theme changes at the global, section, and block level within their theme.

A solution which will enable theme developers to specify how to migrate merchants’ theme data during the update process when introducing architecture changes (ex: changing scope of settings, modifying schema structure in other ways etc.) will be available later this summer.

Learn more about color schemes in the dev docs

As of 2023-07, you can use the new duplicateResolutionMode on the fileCreate mutation to control how duplicate filenames are handled.

Learn more about duplicateResolutionMode on Shopify.dev.

As of 2023-07, you can use the metafieldsSet mutation to set metafields on images via MediaImage GIDs.

Learn more about metafieldsSet on Shopify.dev.

As of May 15, camera and hardware scanning is supported for POS UI Extensions. Available for POS UI Extensions version 1.1.2 and POS app version 8.9.0.

CameraScanner This new component utilizes the device's camera for scanning. The CameraScanner provides a live feed with guidance markers to help users align the camera with barcodes.

Scanner API This new API allows UI extensions to access scanner data and available scanning sources. The API also introduces support for hardware scanners that have external or embeddeed scanning capabilities.

Shopify’s GitHub app now requests read and write permissions for Dependabot secrets. This update supports improvements to the developer experience for Hydrogen headless storefronts hosted on Oxygen.

Currently, deployments to Oxygen are triggered by pushes or merges to a GitHub repo. However, Dependabot, GitHub’s dependency management service, doesn’t have access to the API tokens required to create a deployment. By adding these new permissions, Dependabot will be able to trigger preview deployments on Oxygen when creating pull requests that bump package versions. This change will let developers more quickly validate that automated updates can be safely merged.

Learn more about Shopify’s GitHub integration.

As of today, you can prevent Liquid errors and improve the quality of your themes with theme check in the code editor. This new feature identifies and warns you about potential issues in your code, so you can fix them before they affect the performance of your store.

Learn more about the code editor on Shopify.dev.

Based on your feedback, we've updated the number of dynamic sources you can add within an online store template. You can now add up to 100 dynamic sources per template, and 50 per static section.

Specifically, we now support:

• 100 Dynamic sources in a JSON template
  
• 100 Dynamic sources in general theme settings
• 100 Dynamic sources in a section group
  
• 50 Dynamic sources in a single setting
  
• 50 Dynamic sources in a static section
  

Updated values and more info can be found in Shopify dev docs

As of May 8, you can access metafield values up to 10,000 bytes in Shopify Functions input queries, so that you can store more merchant configuration for your function.

The overall input JSON size for Shopify Functions is constrained to 64,000 bytes.

Learn more about execution limitations for Shopify Functions on Shopify.dev.

New POS UI extensions available to app developers

POS UI extensions are available for developers to start building apps for Shopify POS. Improve the efficiency of a current extension or build custom functionality in the POS smart grid. POS UI extensions provide developers with access to numerous components and API's required to develop extensions that feel native to Shopify POS with faster performance. This technology will transform POS extensions for an improved merchant experience.

Extension Points Two extension points are available that allow for the rendering of different components. The Tile which can customize the functionality of the app's smart grid tile and the Modal a full-screen modal that presents on top of the smart grid.

Components Build extensions using the UI Extensions library that utilize interface elements and behaviors that mirror the look at feel of the POS experience. These elements are rendered natively, providing the performance and accessibility inherent to a native app.

To learn more about building apps for POS, please review our developer documentation.

As of this week, we've brought product media together with the broader file management system. You can access the file management system from Shopify admin by going to Content>Files

This means that product media is now available within the files section within content in admin. As part of the new update, we’re introducing a reference feature that enables merchants to trace the usage of files in their storefronts. This feature also allows merchants to use references as search parameters, for example a search that only lists files used in product media. Additionally, we’re also launching a new file selector in the online store editor that allows merchants to save views, filter within the selector, and toggle between different types of media as required, all through a new modal design.

Learn more about product media at Shopify.dev. You can also learn more about the Files API at Shopify.dev

As of May 3, 2023, merchants will be required to contact partners directly if they want to discuss or request a refund for an app. When a merchant contacts Shopify to request a refund for an app charge, Shopify Support will no longer reach out to partners on behalf of the merchant to facilitate their request.

This change will streamline the refund process, as refunds are at the partners’ discretion and partners have the ability to issue most refunds themselves. The exception is still reversals to pending charges. In this case, Shopify highly encourages partners to issue application credits, which Shopify Support can then apply to the invoice.

What’s not changing?

• Other types of facilitated third party requests
• Processing of reversals for pending charges once approved by the partner
• Follow-ups on unresolved inquires from merchants
• Assistance with bulk refunds, refunds over $1,000, and refunds older than 12 months

Please contact partner support with any questions about these changes.

As of 2023-07, you can use the fileUpdateInput to provide an originalSource which will be used to update the bytes of a file. Passing originalSource when updating is supported media images and generic files.

Using this functionality makes it easy to do an in-place update of an existing file.

New Checkout UI Components

DatePicker will help you build customizations to select specific delivery dates in checkout.

Disclosure will help with UX patterns that progressively disclose information, like the long list of line items in a bundle.

Checkout Branding Update

Checkout branding now supports custom fonts. Checkout, accounts, and UI extensions inherit these fonts making experiences consistent across surfaces.

As of April 26, Shopify App Store’s search algorithm folds in even more data on how merchants interact with results after they search.

In other words, apps that merchants find most relevant, given what they’re searching for, will rank higher overall. While term matching will still inform results, this update will reduce the impact of keyword stuffing.

Learn more about search on our blog.

As of API version 2023-07, you can now subscribe to the orders/updated webhook to be notified of any sale attribution edits to an order. When a staff attribution edit is made on POS, the orders/updated webhook will fire. The payload will include a new attributed_staffs field under line_items. This new field will reflect the new attributions on the order after the edit.

"lineitems": [ { "id":111, "attributedstaffs": [ { "id": "gid://shopify/StaffMember/123", "quantity": 1 } ] } ]

A user can edit the staff attributions on multiple line items at once on POS. In this case, the webhook payload could include multiple updated line items with different attributions applied to them.

Note that the payload in the orders/create webhook will also be updated to include attributed_staffs.

Learn more about webhook on Shopify.dev.

As of April 18, we're temporarily suspending Speed tested as an app listing highlight. We will still measure an app’s impact on store speed once it has applied for Built for Shopify status.

We are making this change while we invest in better tooling and will keep app developers posted on plans to resume incentives in this area, as impact on store speed remains incredibly important to merchants.

Learn more about storefront performance on Shopify.dev

As of April 14, we have enabled deep linking to theme app blocks so that merchants can easily preview app functionality in their theme.

Learn more about deep links to app blocks.

We've added new commerce primitives such as gift cards, selling plans, and metafields to development stores populated with test data.

To speed up the development and testing process, you can create a development store that's populated with test data generated by Shopify.

Review all of the objects, configurations, and relationships that are included in the development store test data set on Shopify.dev

Shopify Functions written in JavaScript can now be deployed in production. Going forward Rust and JavaScript will be our first-class languages for Shopify Functions. However, you can still write Shopify Functions in any WebAssembly-supported language that meets our requirements.

Learn more about JavaScript Shopify Functions here

As of GraphQL Storefront API version 2023-04, the Order object has a new field: billingAddress. This field returns a mailingAddress object for the address associated with the payment method.

Learn more about the Order object on Shopify.dev.

As of 2023-04, select partners can use Server Pixels to consume customer events on the server-side. These new mutations are available to those partners:

• serverPixelCreate
• eventBridgeServerPixelUpdate
• pubSubServerPixelUpdate
• serverPixelDelete

As of GraphQL Admin API Version 2023-04 you can use the mutations locationAdd and locationEdit to set Metafield values for locations.

As of Storefront API Version 2023-04, you can query metafields belonging to a location using the Location query object.

You can use Metafields to store aditional information for Locations.

Learn more about { Metafields } on Shopify.dev.

As of the 2023-04 release of the GraphQL Admin API, you can create a subscription contract in a single operation with the subscriptionContractAtomicCreate mutation.

You can also replace a retired product by a new one, or update the price of a product in a subscription contract in one GraphQL call to the subscriptonContractProductUpdate mutation.

More information on Bulk Operations can be found here

As of the 2023-04 API version of the Storefront API, the ProductRecommendations query will accept an optional intent argument. Additionally, a new ProductRecommendationIntent will be introduced as a GraphQL Enum Type, defining the supported product recommendation intents. By default, the API will return RELATED recommendations for backward compatibility.

We've added the error codes INVALID_DELIVERY_GROUP and INVALID_DELIVERY_OPTION for cartSelectedDeliveryOptionsUpdate mutation , allowing you to get descriptive error codes when GraphQL returns invalid delivery group id or invalid delivery options input.

As of version 2023-04, payments apps will have support for onsite credit card payments through new types introduced to the GraphQL Payments Apps API. Changes to support on-site credit card processing are as follows:

• New rejection codes are now available in the paymentSessionReject GraphQL mutation for credit card payments apps
• A new error code is introduced in the paymentSessionPending GraphQL mutation

As of GraphQL Admin API version 2023-04, you can now use the Customer Merge API to combine two separate customer profiles with certain non-blocking criteria. You can use the new mutations and queries to:

• Preview a customer merge
• Merge two customers
• Follow the status of an ongoing merge

Additionally, you can check whether a customer can be merged with another customer using the new Customer.mergeable field. This field is also available on the CustomerSegmentMember API CustomerSegmentMember. mergeable.

You can learn more about merging customer profiles on Shopify Help Center.

As of version 2023-04, we're deprecating the requirement of writeproductslistings access scope for the mutations publishableUnpublishToCurrentChannel and publishablePublishToCurrentChannel. Use the access scope writepublications instead.

You can provide this new access scope to your third party app or any stuff member through the admin as it is regularly being done for any other access scope. This change will provide a more restricted access to call these mutations.

You can now filter orders by their return status.

The return_status filter is available on the orders connection. This status corresponds to the return status merchants see in the orders page.

Learn more about the order's return status on Shopify.dev.

Learn more about return statuses on the help center.

As of API version 2023-04, FulfillmentOrdersMove webhook payload is extended source_location field.

The assignedLocation of the original_fulfillment_order may be changed by the move operation. Therefore, if you need to determine the originally assigned location, you should refer to the source_location field.

Learn more about fulfillment order move in the FulfillmentOrdersMove webhook, FulfillmentOrdersMove GraphQL mutation and Moves a fulfillment order to a new location REST endpoint documentation pages.

In the Admin GraphQL API version 2023-04, the productVariantsBulkUpdate mutation will return product and productVariants data even when errors are present. Previously, the mutation would always return null for the product and productVariants data.

Learn more about the mutation here.

As of API version 2023-04, you can use the Catalogs API to create a set of rules that determine the available products and their prices in different customer contexts. The Catalogs API lets you link Shopify Markets and B2B primitives to Publications and PriceLists to customize product offerings for different audiences. The same APIs also allow you to manage product publishing for sales channels.

To learn more about Catalogs API, read B2B Catalogs and Catalogs for Markets.

As of 2023-04, you can now use comparedTo on comparison columns from ShopifyqlResponse to indicate the column to compare to.

Learn more about COMPARE TO ShopifyQL queries on Shopify.dev

As of 2023-04, parse error codes enum has been updated to remove stale codes as well as add new ones.

Added

• ParseErrorCode.INVALID_DATE_RANGE
• ParseErrorCode.EXCESS_BACKFILL_DIMENSIONS
• ParseErrorCode.BACKFILL_DATE_RANGE_NOT_FOUND
• ParseErrorCode.COMPARE_TO_MISSING_PERIOD
• ParseErrorCode.EXCESS_DIMENSIONS
• ParseErrorCode.SYNTAX_FAILED_PREDICATE

Removed

• ParseErrorCode.VISUALIZE_TYPE_NOT_FOUND
• ParseErrorCode.FUNCTION_MODIFIER_INVALID
• ParseErrorCode.VISUALIZE_BY_OR_OVER_NOT_FOUND
• ParseErrorCode.VISUALIZE_CONTAINS_BY_AND_OVER
• ParseErrorCode.BINARY_EXPRESSION_INCOMPATIBLE_TYPES
• ParseErrorCode.VISUALIZE_EXCESS_PROJECTIONS_ALPHA
• ParseErrorCode.EXCESS_GROUP_BY_ALL
• ParseErrorCode.GROUP_BY_ALL_DATE_RANGE_NOT_FOUND
• ParseErrorCode.COMPARE_TO_WITHOUT_DURING
• ParseErrorCode.GROUP_BY_EXCESS_PROJECTIONS

See the full list of parse error codes on Shopify.dev

As of API version 2023-04, you can retrieve a subset of fulfillment orders which are assigned to locations owned by the app performing the request but have not been requested for fulfillment so far.

The assignment_status query parameter in the [/assignedfulfillmentorders.json]((https://shopify.dev/docs/api/admin-rest/latest/resources/assignedfulfillmentorder#get-assigned-fulfillment-orders) endpoint can now accept a value of fulfillment_unsubmitted for filtering in addition to the existing fulfillment_requested, fulfillment_accepted, and cancellation_requested filter values.

Learn more about retrieving assigned fulfillment orders as a fulfillment service on shopify.dev.

As of GraphQL Admin API Version 2023-04 you can use the field MetafieldDefintionInput.validations to change the validations of a metafield definition.

Also, as of GraphQL Admin API Version 2023-04, you can query the field MetafieldDefinitionUpdatePayload.validationJob to get the details of the job running to validate existing metafields for the metafield definition.

Learn more about { Metafields } on Shopify.dev.

In the Admin API version 2023-04, you can now query your web pixels installed on an online store without having to provide a Web Pixel ID.

API: https://shopify.dev/docs/api/admin-graphql/2023-04/queries/webPixel

Learn more about web pixels.

As of 2023-04, you can pass Customer address id as an input for CartBuyerIdentity.deliveryAddressPreferences when creating or updating carts for authenticated customers.

You can learn more about the Cart API references in here.

As of GraphQL Storefront API Version 2023-04 you can use Metafields with Carts! Metafields can be added during Cart creation, they can be queried, updated, and deleted.

Learn more: * Create Cart Metafields * Query Cart Metafields * Update Cart Metafields * Delete Cart Metafields

As of the 2023-04 release of the GraphQL Admin API, the Billing API will allow creating app charges using currencies that match the merchant's local billing currency.

Previously, app charges could only be created using USD and were converted to the merchant's local currency using the exchange rate at the time the invoice is issued. By creating app charges in the merchant's billing currency, app developers will allow merchants to better budget their app spend without being exposed to currency exchange rate fluctuations.

You can use the shopBillingPreferences query to retrieve the merchant's local billing currency, then pass in the currency value as input to the existing GraphQL Billing APIs.

As of 2023-07 version, you can use the Order APIs exchangeV2 field to get a better exchange (an exchangeV2 object value).

This will help ERP partners to properly integrate optimal exchange values.

Learn more about it on this doc

Google is sunsetting Universal Analytics in July 2023, and replacing it with Google Analytics 4 (GA4) which is Google's next-generation measurement solution. Universal Analytics will continue to collect data until its sunset in July 2023, and data will remain accessible for at least 6 months afterwards.

Visit Shopify.dev for next steps to migrate your app listing tracking from Universal Analytics to the new Google Analytics 4 or to set up tracking for the first time.

You can now use dynamic sources on blogs and articles. This means that merchants can now connect theme files to their metafields and metaobjects when working with the blog and article resources. Previously, this was only possible when working with product, collection, and page resources.

Learn more about datasources on Shopify.dev

The Order object now has fields representing additional fees as of API version 2023-04. Additional fees are extra costs associated with an international package that aren't duties or taxes.

The new fields on the GraphQL Order object are:

• additionalFees
• currentTotalAdditionalFeesSet
• originalTotalAdditionalFeesSet

The new fields on the REST Order resource are:

• currenttotaladditionalfeesset
• originaltotaladditionalfeesset

Learn more about these new fields in the GraphQL reference docs or REST reference docs.

We’re continuously improving our systems to effectively and efficiently identify and remove fake reviews to ensure a safe, fair, and useful ecosystem for both merchants and developers.

As part of these efforts, you may receive an email notifying you that a review for your app has been removed because it doesn’t comply with our policies.

Learn more about our policies for leaving a review in the Shopify App Store in the Shopify Help Center.

As of 2023-04, we're introducing the ability to access the Focal Point setting value for Media Presentation in the asJson field using the Storefront API.

Focal Points can be set from the shop admin when editing your image files.

Learn more about Focal Points on Shopify Help

As of 2023-04 we're introducing the ability to read presentation attributes for 3D models in the storefront api.

When a 3D model is customized via the no code 3D viewer configuration the properties associated with lighting, zoom, camera angle and background color are available in the Storefront API.

Learn more about this feature on Shopify Help

As of March 15, you can geotarget Shopify App Store advertising campaigns, giving greater control over how you market your apps and grow your business. Create effective and relevant regional campaigns with country-specific attribution, metrics, and even recommended bids.

Learn more about creating geotargeted ads on Shopify.dev.

As of March 15, the templates schema attribute is no longer supported in the apps.liquid section.

• The templates schema attribute cannot be specified in the apps.liquid section.
• The enabled_on/disabled_on schema attribute cannot contain templates attribute in the apps.liquid section.

As of the Admin API 2023-04 Release, we are providing webhook notifications for changes to the major entities within the B2B Customers product. The following webhooks are provided:

• companies/create
• companies/update
• companies/delete
• company_locations/create
• company_locations/update
• company_locations/delete
• company_contacts/create
• company_contacts/update
• company_contacts/delete

Learn more about these webhooks on Shopify.dev

As of 2023-04, SVGs are treated as MediaImages by the Admin API.

This makes it easier to use SVGs in your online storefront.

As of 2023-04, we're no longer filtering out null values on certain fields of the Order object. Previously, some keys with null values would not be present on the REST API and webhook payloads.

This change removes unecessary and inconsistent handling of null.

As part of the GraphQL Storefront API 2023-04 API release, we are adding wallet_preferences to the Cart object. The wallet preferences from the cart will allow to pass through a buyer's wallet preference to the checkout.

Learn more about the Cart object on Shopify.dev.

The JavaScript support developer preview enables you to write functions in JavaScript or TypeScript, compile them to WebAssembly with Shopify CLI, deploy them to Shopify, and execute them on development stores.

Learn more about the developer preview on Shopify.dev.

In the Admin GraphQL API version 2023-04, appUsageRecordCreate now supports an optional parameter idempotencyKey which ensures the merchant will not be charged twice. When idempotencyKey is provided, the mutation will return the same response as any previous appUsageRecordCreate mutations with identical idempotencyKey for the intended shop and requesting app, rather than creating a new record and charging the merchant again.

This means that an idempotencyKey could be reused by an app to create appUsageRecords on different shops to charge the merchant. Different apps can also use the same idempotencyKey on the same shop and still charge the shop. But we recommend a UUID.

The appUsageRecordCreate will behave like past API versions when idempotencyKey is not provided and create a new record on every mutation.

As of 2023-04 we're introducing a new capability to translate metaobjects.

Similar to the publishable capability, the translatable capability can be enabled when creating and updating a metaobject definition. When enabled all metaobjects belonging to the definition will be eligible for translations through the Translations API as well as the Translate and Adapt app.

Learn more about the Translatable Capability on Shopify.dev

We've added headings as well as ordered lists to the rich text setting within online store editor. This means that themes can now take advantage of this new semantic styling within the editor to allow merchants to configure multiple headings of different semantic sizing and craft lists (now both ordered and unordered) right in the theme.

Learn more about the rich text input setting on Shopify.dev.

In the Admin GraphQL API version 2023-04, you can use the productVariantsBulkUpdate mutation to update valid variants even if some variants are invalid. The new allowPartialUpdates parameter is optional and defaults to false for backwards compatibility, but by enabling it, the mutation will modify valid variants, instead of not updating any variants due to invalid variants.

Learn more about the mutation here.

As of February 27, Shopify App Store’s search algorithm folds in more data on how merchants interact with results after they search.

In other words, apps that merchants find most relevant, given what they’re searching for, will rank higher overall. While term matching will still inform results, this update will reduce the impact of keyword stuffing.

Learn more about search on our blog.

You can now use the $app: metafield namespace prefix in Shopify Functions input queries to ensure your app's ownership of metafields used in your function.

We recommend use of reserved prefixes by default for all functions, so that you can control access to metafields used by your function. By default, they will be private to your app.

Learn more about metafield ownership and using metafields with input queries on Shopify.dev.

The CompanyAddress is no longer supporting the use of firstName/lastName fields, preferring instead to use a single recipient field. English-based UI elements may call this new field Attention. This is due to requests from merchants who are not dispatching orders to named individuals, but rather to locations, departments, or roles.

The field recipient has been added to the liquid API for CompanyAddress to display this field. However, there are a large number of existing templates that use the firstName/lastName fields. In order to minimize the impact on these templates, we populate the lastName field with the recipient, and leave the firstName field blank (specifically, it is null).

The previous paragraph is true for those CompanyAddresses where the recipient field has been populated. Where the address is still using firstName/lastName, the firstName/lastName fields will be populated as before, with the recipient field being the concatenation of these fields in a locale aware manner (in the same way as the name field). We are in the process of porting all CompanyAddresses to use the recipient field only.

Shopify will be making changes to the certificate used to secure subdomains of myshopify.com (eg: https://test.myshopify.com/) effective February 13, 2023. The current certificate which is being used is issued by Cloudflare via DigiCert. We will be adding in additional certificates signed by Lets Encrypt and Google Trust Services.

Note: This will not affect the certificate used for mTLS connections.

For more information refer to the community notice.

JavaScript support for Shopify Functions is now available in a local developer preview. This means you can try Shopify Functions with JavaScript locally, on your own development machine, but you can't deploy functions to production yet. We are releasing this preview now to get your feedback on our JavaScript development experience.

Learn more about JavaScript support for functions on Shopify.dev.