Developer changelog

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.

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.

Shopify is extending support for API version 2022-04 to June 30, 2023 (previously March 31, 2023). All public, custom, and private apps using API resources that are no longer supported in API version 2022-10 will stop working as intended after this date.

Action Required Existing apps must migrate to API version 2022-10 or later by June 30, 2023 to avoid any interruptions.

Below are a few important breaking changes, please make sure to review the full list:

• The following customer object properties on the REST Admin API’s order resources have been deprecated: lastorderid, lastordername, orderscount , totalspent (see details here)
• Some Fulfillment API endpoints and mutations relating to managing fulfillments via an order have been deprecated (see details here)

To see a full list of apps that may be impacted, please log into your Partner Dashboard and click on Apps > Insights > API Health.

Please note that this extended timeline for supporting API version 2022-04 does not impact deprecation timelines for any subsequent API releases. If you have any questions, reach out to your Shopify account manager or post here, in the Shopify Community.

Shopify is extending support for API version 2022-04 to June 30, 2023 (previously March 31, 2023). All public and custom apps using API resources which support end with the API verions 2022-04 and 2022-07 will stop working as intended after this date.

Action Required: Existing apps must migrate to API version 2022-10 or later by June 30, 2023 to avoid any interruptions.

Below are a few important breaking changes, please make sure to review the full list:

• The following customer object properties on the REST Admin API’s order resources have been deprecated: last_order_id, last_order_name, orders_count , total_spent(see details here)
• Some Fulfillment API endpoints and mutations relating to managing fulfillments via an order have been deprecated (see details here)

To see a full list of apps that may be impacted, please log into your Partner Dashboard and click on Apps > Insights > API Health.

Please note that this extended timeline for supporting API version 2022-04 does not impact deprecation timelines for any subsequent API releases. If you have any questions, reach out to your Shopify account manager or post in our community forums.

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 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

Starting in API version 2023-04, the PriceList.contextRule field will be removed and deprecated in previous API versions. If you have an existing app that uses the contextRule field, then you should migrate to catalogs.

Learn more about migrating to catalogs 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 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, 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.

New release: Google Analytics 4 is now available through the Google channel app on Shopify, enabling you to upgrade and take advantage of its enhanced real-time, multi-channel measurement and privacy controls.

Google Analytics 4 is replacing Universal Analytics, which will continue to process data until July 1, 2023 (July 1, 2024 for Analytics 360 properties).

Learn more about Google Analytics 4 and what this means for you here.

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.

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.

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 new enabled_on / disabled_on app block schema attributes to specify where an app block can be used. These new attributes replace the existing templates attribute and work for both templates and section groups.

• Use the enabled_on attribute to limit an app block to specific templates and section groups.
• Use the disabled_on attribute to prevent an app block from being used in specific templates and section groups.
• These new attributes work for both app blocks and app block embeds.

Please keep in mind that you can use only one of enabled_on or disabled_on.

We are deprecating Price Rule GraphQL queries & mutations. Use Discounts GraphQL queries & mutations instead.

You will need to migrate to the new endpoints by April of 2024 when we will remove access to these resources.

Certain features, such as Automatic Discounts, and Shopify Functions-backed Discounts, are not supported by these Price Rule endpoints. This migration will allow you to access all the latest features, including ones coming in the future.

Affected queries:

• priceRule
• priceRules

Affected mutations:

• priceRuleActivate
• priceRuleCreate
• priceRuleDeactivate
• priceRuleDelete
• priceRuleDiscountCodeCreate
• priceRuleDiscountCodeUpdate
• priceRuleUpdate

To get up to date, make sure you no longer use the affected queries & mutations listed above. To replace them, use the Discounts queries & mutations found on Shopify.dev below:

• Create automatic discounts
• Create code discounts
• Manage existing discounts

Over a year ago, we introduced Theme App Extensions as the recommended way for public apps to integrate into themes. The use of Theme App Extensions is a more streamlined and secure method for merchants to customize their Online Store themes, replacing the need for the Asset API.

As of today, when requesting the unstable 2023-04 release candidate, or future versions of the Admin API, the Asset API access to create, update and delete assets is no longer accessible for public apps. Refer to this guide for more details on the change, exemptions and how to migrate your apps.

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.

Update: In October 2023, the end of life date for Shopify Scripts was extended from August 13, 2024 to August 28, 2025.

Shopify Functions replace the need for Shopify Scripts, as a result Shopify Scripts will no longer be supported as of August 28, 2025. Merchants that leverage Shopify Scripts will need to migrate to Shopify Functions before this date.

You can now build unique discount, payment, and delivery customizations with Shopify Functions. Functions are deployed through apps and configured alongside native features directly in the Shopify Admin. This means that merchant end users never have to touch a line of code when modifying their customizations.

Please note that Functions and Scripts can work together, so if a use case isn't yet supported by Functions, merchants can continue to leverage their existing Shopify Scripts. Over the next year, we'll continue to release additional Functions APIs to cover existing Scripts use-cases, and more.

Help merchants migrate by building apps powered by Functions.

Shopify Plus merchants can now customize their in-checkout pages, which include their Information, Shipping, and Payment Pages, using checkout extensibility. Checkout extensibility is a faster way to customize Shopify Checkout in a way that’s app-based, upgrade-safe, higher-converting, and integrated with Shop Pay. It has the power and flexibility for merchants to build the experiences they want.

Checkout extensibility replaces checkout.liquid. As a result, checkout.liquid will no longer work for in-checkout pages on August 13, 2024. Any merchants that currently customize their in-checkout pages with checkout.liquid need to upgrade to checkout extensibility before this date.

Shopify Plus merchants can continue customizing their post-checkout pages, which includes their Thank You Page and Order Status Page, with checkout.liquid. However, we’ll soon support customization on these pages with checkout extensibility as well.

Click here to learn more.

We are introducing Mock.Shop, a free prototyping tool to build a proof-of-concept storefront without having to set up a shop or run any server-side code. Use Mock Shop API to query live commerce data such as sample products, variants, and carts to help you quickly prototype commerce storefronts.

Mock.Shop is publicly available - no server, or access tokens required.

Visit Mock.Shop to learn more and build a proof-of-concept.

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.

New Checkout UI Extensions APIs

With this new API release, checkout UI extensions can access the storefront API without needing to be a sales channel. They can also read and edit discount codes and gift cards, and generate a signed token to be verified on an app server. Extensions can also verify that they are rendering in the checkout editor.

• Buyer journey and order hooks - Extensions can use the buyer journey API to render different extensions on the order status page based on the intended step in the customer journey (e.g. on checkout completion, or order fulfillment). For more details about extensions on the order status page, see here
• Storefront Direct Access API - Extensions can query the storefront API of a shop to get additional information like product tags, product recommendations, or currency conversions. Shopify handles authentication, so the extension only needs to pass in the query. This API is available to all apps and does not require the app to be a sales channel.
• Rendered in editor API - Extensions can now detect when they are being rendered inside the checkout editor. Extensions that only conditionally render to buyers should always use this to render content for merchants configuring the extension.
• Discount Code API - Extensions can now read discount allocations and discount codes in checkout, and add or remove the discount code(s).
• Gift Card API - Extensions can now read the gift card code applied to a checkout along with the amount. They can also add or remove gift card codes.
• Session Token API - Shopify provides a token signed with the app’s secret to the extension. This token can be passed via external call to an app server, and the app can trust that the contents of the token were created by Shopify

New UI Components

With the following new components, checkout UI extensions can progressively disclose information that buyers can opt in to. Using the overlay activation pattern on interactive components, extensions can show buyers information on customer trust like terms and conditions, trust badges, or warranties. Additional conditional styles offer more props to build performant UI.

• Pressable - Extensions can now use this generic interactive component without the styling that comes with a button or link.
• Component Overlays - Extensions have access to a set of accessible UI component overlays that provide additional information on interaction from Button, Link or Pressable components.
• Conditional style additions to Button, GridItem and Image
• Text has access to a visibility prop that allows visually-hidden content
• GridItem has added styling props on background, BlockSize and InlineSize

Checkout UI extensions on the order status page are now available in the Checkout Extensibility developer preview. Add app-powered extensions or content to post-checkout pages such as surveys, social shares or referral links so merchants can install and configure apps without code. Learn more

The Cart Transform API is now available in a developer preview. You can use this new Shopify Functions API to create unique product bundle offerings that display directly in the checkout.

There are two key parts building a product bundle. First, you can determine which specific products can be merged into a bundle. Second, the Cart Transform API can also expand a bundle product into its individual components, making it easier to complete tasks on the backend—like calculating taxes, shipping weights, decrement inventory, and more.

Learn more about how to use the Cart Transform Function API to build product bundles here

The Shopify Functions APIs for delivery and payment customizations are now generally available. These Functions APIs allow you to hide, reorder, or rename delivery and payment options directly in the checkout.

One of the most popular delivery customizations include the ability to surface unique shipping options to specific buyers — like bike shipping options, that only display to customers that live within certain ZIP or postal codes.

With regards to payment customizations, one of the most popular use cases is to hide certain payment options based on a dollar threshold.

• Start building with the Delivery Customization API
• Start building with the Payment Customization API

The Shopify Functions API for cart and checkout validations is now available in the Checkout Extensibility developer preview.

This API allows you to apply validation rules that run in both the cart and checkout, ensuring that purchases meet certain criteria before checking out, or completing the order.

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

The Order Routing Location Rule API is now available in a developer preview. You can use this new Shopify Functions API to write custom order routing rules that determine how to best fulfill and ship orders, based on the needs of the merchant.

For example, keeping orders within the country, balancing inventory levels to prioritize locations with more items in stock, or shipping directly from stores, just to name a few.

Learn more about the Order Routing Location Rule Function API here

We released new checkout branding API properties to make it possible to customize more of checkout’s look and feel. These consist of API-only capabilities that can style interactive elements like buttons and form inputs, as well as more typography controls on heading styles and font styles.

These customizations are automatically inherited by checkout UI extensions and include:

• Font properties for all font surfaces like case and kerning
• Form controls such as corner radius, border presence, label position and label typography
• Button styles such as padding, corner radius and button typography

For more information, view the checkout branding API reference.

Shop Minis are a new way for Shopify App developers to bring their experiences into Shop and in front of 100 million buyers.

Our React Native SDK is designed to get you started with just one command, and it comes with all the components you’ll need, like search, product pages, and cart, to make an incredible shopping experience faster than ever before.

Learn more about early access.

Shopify increased Admin API rate limits for Shopify Plus by 10x over standard limits. Apps installed on Shopify Plus stores will now get 500 points/second on the GraphQL Admin API and 20 requests/second on the REST Admin API. In addition, merchants on Commerce Components by Shopify now have unlimited API calls.

Read more about API rate limits.

As of the latest unstable GraphQL API version, 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.

Now, you can populate your store with test data in a single click, so you can start developing your app or theme faster.

The generated test data set includes the most common commerce primitives and configurations that you need to test an app, theme, or custom storefront, including some Shopify Plus exclusive features.

Read the developer documentation for more information and try it in your Partner Dashboard today.

EFFECTIVE FEBRUARY 06, 2023 ACTION REQUIRED

We've made changes to our Partner Program Agreement and API License and Terms of Use. These updates include terms that clarify a partner's responsibility to promptly take certain actions, including as necessary to resolve failed requirements and/or violations to our terms, as well as other important updates.

These changes come into effect as of today, February 06, 2023.

We encourage all developers on our platform to review and be familiar with the API License and Terms and the Partner Program Agreement, so that you understand how to build, run, and grow your app and development business on our platform.

For more information and frequently asked questions, please visit the Shopify Help Center.

The following requirements must be met for embedded apps to load in admin.shopify.com:

• The content security policy includes admin.shopify.com.
• The app is on App Bridge 2.0.5 or higher, and has correctly implemented the host parameter. App Bridge 3.0 is recommended.

When merchants try and access apps which have not been updated, they will be redirected to the old admin domain in a new tab. They will also be shown a banner letting them know that they've been redirected in the original tab.

If you have recently updated your app, or if you are unsure if your app has ever loaded correctly within the new admin domain, you are encouraged to test the app on any partner owned dev store. If you are redirected, ensure that your app has loaded correctly under the banner on admin.shopify.com. We will record the successful load, and within 3 hours our data pipeline will update. Once the pipeline has updated, the banner/redirect will no longer occur.

As of version 2023-04 of the Admin REST API, requests for Transaction will now return total_unsettled_set. This represents the remaining amount to be captured on the transaction. total_unsettled_set is returned in both shop and presentment money objects with currency.

If you are leveraging manual capture and the authorized amount from Transaction, you should switch to referencing total_unsettled_set. The authorized amount can differ from the total amount to capture due to adjustments during order finalization such as tax adjustments.

As of January 23, 2023, a new resource type for query suggestions has been added to the Predictive Search API.

Notably, several other improvements have been made to the Predictive Search API:

• Resources[type] is now optional with a default set to queries, products, collections and pages
• Performance improvements when requesting multiple resource types
• New parameter: limit_scope to decide whether the limit parameter applies to the total number of returned results, or the total that each resource type returns.

Learn more about query suggestions on Shopify.dev.

We've added intelligent code completion features in Theme Check so that you can speedup writing Liquid code.

You can easily explore Liquid attributes as you type and benefit from type inferences, smart filters and scope awareness. With in-line documentation, you can check the most updated version of our documentation for objects, attributes, filters, and tags.

To start using, install Theme Check

Shopify Functions now support the use of variables in input queries, so that you can use merchant input for GraphQL field arguments.

Learn more about input query variables on Shopify.dev.

In order to make the Cart SFAPI experience more seamless, we're rolling out changes to Cart Update mutations so they return a new, valid Cart even if the provided token is no longer valid. If a Cart is found for the provided token, the mutations will work the way they always have. That way you get back a a valid, updated Cart in your response, no matter what.

These mutations will return a new, empty cart:

• cartLinesRemove
• cartLinesUpdate
• cartSelectedDeliveryOptionsUpdate

The following mutations will update the new cart with the requested input:

• cartAttributesUpdate
• cartBuyerIdentityUpdate
• cartDiscountCodesUpdate
• cartLinesAdd
• cartNoteUpdate

To take advantage of this, use the new Cart ID from the returned Cart when you receive the FailedToRetrieveCart error code in your response. Please note that the new cart is not a copy of the cart whose token was invalid.

Empower your merchants to easily customize their online store with intuitive new color scheme settings. Online store color schemes are now available in developer preview.

You can define the structure of a color scheme in settings_schema.json and set values for each color scheme in settings_data.json. You can then reference the color schemes in the settings of a given section or block.

ColorSchemesDrop provides access to the colors schemes and color values in each scheme. You can define your CSS by iterating over the new drop. This way, merchants no longer need to edit their CSS or liquid file to add or remove color schemes.

Learn more about color scheme and color schemes settings.

As of Admin Graphql API version 2023-04, you can now get inventoryItemId on the FulfillmentOrderLineItem resource.