Developer changelog

As of Shopify CLI version 3.13.0, you can now preview theme app extensions by running the dev command. Shopify CLI supports hot reloading for theme app extensions, so you can avoid refreshing the browser after making changes.

Learn more about previewing theme app extensions.

As of September 19, 2022, you can use a new set of endpoints in the GraphQL Admin API 2022-10 version to surface custom content to buyers in a specific market that is not language based.

The newly introduced endpoints are marketLocalizableResource, marketLocalizableResources and marketLocalizableResourcesByIds queries, as well as marketLocalizationsRegister and marketLocalizationsRemove mutations.

An example of market localizable content that is not language based is the newly introduced money content type metafield

You can now use authenticated access to make Storefront API requests from a server (for example, from a Hydrogen server).

Using authenticated access enables more throughput for your server than using a public token, and enables Shopify's bot protection features to work more effectively.

App categories are getting simplified for better merchant discovery. Starting in November, you’ll be able to categorize your own app. For more information, click here

As of 2022-10 the marketWebPresenceUpdate endpoint now supports adding unpublished locales as alternateLocales.

Learn more about marketWebPresenceUpdate.

As of ** 2023-01 ** version on the Admin GraphQL schema, you can use the DelegateAccessTokenDestroy mutation to delete the delegate tokens created by the API client.

For app architectures that use delegate tokens from multiple subsystems, this makes it easy to remove those delegate tokens that are unused or leaked for better application security.

As of the 2022-10 release of the Storefront API, you can now query a shop's brand settings and assets via the new Shop.brand field.

For more information on configuring your shop's brand settings, click here.

Icons added to your app using the Partner Dashvoard App setup page now must be 1200 px by 1200 px in size. This change makes icon sizes consistent across the Partner Dashboard, the Shopify App Store, and other development surfaces.

As of 2022-10, the Money scalar is being removed from the Storefront API. It was previously used for monetary fields that do not have a V2 suffix (<name>: Money). As a result, the following changes are being made: * Non-V2 fields will now use MoneyV2 objects for their type (<name>: MoneyV2). * Monetary fields that do have the V2 suffix (<name>V2: MoneyV2) are being deprecated in favor of the <name>: MoneyV2 equivalent. These fields will be removed in subsequent releases.

These changes will help improve consistency of the API and avoid confusion when using these fields.

Shopify now supports automatically optimizing storefront images using the AV1 Image File Format (AVIF) format, which improves performance by reducing delivered bytes. Optimization occurs on a per image basis, where Shopify will examine the request and determine the best compatible file format (e.g. AVIF, WebP or JPEG) based on image quality and compressed bytes.

You can learn more by visiting https://cdn.shopify.com/

With GraphQL Storefront API version 2022-10, you can use ContentEntry queries to display custom content that's associated with resources like products, customers, and orders. Metaobjects created with the CONTENT category with an Active status are available through ContentEntry queries.

This change is related to the GraphQL Admin API's support for content management and metaobjects.

Hey all! Coming back at you with improvements to creating an app from the Partner Dashboard! We’re removing the need for you to enter in any kind of URL when you’re manually creating an app from the UI. Instead, we’ll generate placeholders for you in the App setup area. You can update these URLs when you're ready to test or distribute your app.

We’ve also added a new Insights section to the app navigation, so you can discover everything from app history to API health without having to hunt around!

SellingPlanGroup and SellingPlan fields will be supported by the Translations API as translatable resources. The following fields will be available in the unstable API until the 2022-10 API release:

• SellingPlanGroup.name - Public-Facing Name of the Selling Plan Group
• SellingPlan.description - Optional, more verbose description of the Selling Plan
• SeillingPlan.option1 - Delivery frequency
• SellingPlan.option2- Delivery frequency (optional)
• SellingPlan.option3 - Delivery frequency (optional)

More information about our translation API is available in our API documentation.

As of today, theme app extensions are be able to store translations up to 15 KB per locale file.

For more information about file and content size limits for theme app extensions, refer to the theme app extension framework documentation.

You may now see new error values and descriptions if you encounter a Braintree payment method being revoked when associating Braintree payment methods with the customers that you import into Shopify.

Learn more about migrating existing subscription contracts to Shopify.

As of the API version 2022-10, upon deleting a reference type metafield definition with delete_all_associated_metafields argument set to false, REFERENCE_TYPE_DELETION_ERROR will be returned with the following error message:

"Deleting a reference type metafield definition requires deletion of its associated metafields."

Shopify’s GitHub app is requesting write permissions for GitHub Actions. This update will support improvements to the developer experience for Hydrogen custom storefronts hosted on Oxygen.

Today, deployments to the Oxygen hosting platform can only be triggered by committing and pushing a change to a Hydrogen code repository. These additional permissions will enable features such as on-demand re-deploys, automatic branch deployment when creating new Oxygen environments, and other enhancements.

Learn more about Shopify’s GitHub integration.

The customer ID for logged in customers is now included as a parameter in the forwarded query for app proxy requests. The customer ID is passed in the logged_in_customer_id parameter. The parameter will be blank if no customer is currently logged in.

Tip: Make sure that your application is verifying the signature parameter of forwarded queries.

In the 2022-04 API version release, the Product.contextualPricing and ProductVariant.contextualPricing fields can now return null.

This is in preparation for future argument changes. With the current arguments, there is no case where these fields can return null. However, future arguments will introduce null cases.

Learn more about contextualPricing

You can now read and write disputes and dispute evidence for Shopify Payments using the REST and GraphQL Admin APIs. The following new objects, mutations, and endpoints are available:

GraphQL Admin API

• ShopifyPaymentsDisputeEvidence object
• ShopifyPaymentsDisputeFileUploadUpdateInput input object
• ShopifyPaymentsDisputeEvidenceFileType enum
• ShopifyPaymentsDisputeFileUpload object
• ShopifyPaymentsDisputeEvidenceUpdate mutation

REST Admin API

• POST /admin/api/2022-07/shopify_payments/disputes/{{dispute_id}}/dispute_file_uploads.json
• DELETE /admin/api/{version}/shopify_payments/disputes/{{dispute_id}}/dispute_file_uploads/{{dispute_file_upload_id}}
• PUT /admin/api/{version}/shopify_payments/disputes/{{dispute_id}}/dispute_evidences.json

For more information, refer to the Dispute resource developer documentation.

Location resources now support metafields. Use metafields APIs to store additional information in metafield values, like store hours, and then reference them in Liquid. Note: this is currently supported in our unstable API version only.

To learn more about metafields, refer to the metafields documentation. To use location metafields in Liquid, refer to the store_availability Liquid reference.

As of GraphQL Storefront API version 2022-07, the Cart object has a new field: totalQuantity. This field returns an integer representing the total number of items in the cart.

Learn more about the Cart object on Shopify.dev.

As of GraphQL Storefront API version 2022-07, the CartLineEstimatedCost object has two new fields: amount and compareAtAmount. Both fields return an object of type MoneyV2. These new fields allow the price of a product variant on a cart to be queried using buyerIdentity as the context driver.

Learn more about these fields on Shopify.dev.

As of GraphQL Storefront API version 2022-07, a new urlRedirects object has been added.

URL redirects can be used to redirect traffic from one web page to another. The new urlRedirects object can be used to query the path and target URLs for URL redirects already set up on a shop.

Learn more about this object on Shopify.dev.

As of GraphQL Storefront API version 2022-07, the fulfillmentOrderRejectFulfillmentRequest mutation has two new optional arguments:

• reason: Identify the reason the fulfillment request was declined. It can be used to filter, group, and provide workflows to help merchants solve rejection issues.
• lineItems: Identify which line items in a fulfillment request are causing the rejection, and provide a detailed message for each one.

Also in this version, the FulfillmentOrderLineItem object has a new generic warnings field, which can be used to display rejection issues for the line item.

As of the 2022-07 version of the Admin GraphQL API, the phone field of the delivery address will be validated on calls to subscriptionContractCreate and subscriptionDraftUpdate.

This allows you to ensure phone numbers are properly formatted and will prevent errors that may occur when processing subscription payments with invalid data.

Learn more about SubscriptionContractCreate and subscriptionDraftUpdate on Shopify.dev.

You can now enable standard metafields on a shop using namespace and key with our GraphQL API.

Learn more about standard metafields.

Avoid sharing an access token across systems with the new delegateAccessTokenCreate mutation. This mutation creates new tokens with a subset of the total permissions of an app.

For app architectures that require authenticated access from multiple subsystems, it's best to avoid sharing the same token across all systems. Instead, create a new token that has access to only the minimal scopes that are required for proper functioning.

As of API version 2022-07, an input field for Braintree has been added to the CustomerPaymentMethodRemoteInput object, which is used by the customerPaymentMethodRemoteCreate mutation. This field can be used to help you migrate Braintree subscription contracts to Shopify.

Learn more about migrating existing subscription contracts to Shopify.

The fulfillment service SKU sharing feature gives fulfillment service apps the ability to stock and fulfill product variants together with merchant's locations.

Merchants will be able to stock and fulfill the same variant from multiple fulfillment services. This means that they can now have the same product/variant be stocked at their merchant managed locations as well as 3PL services at the same time.

This feature introduces the permits_sku_sharing parameter when creating or updating a fulfillment service. Setting permits_sku_sharing to true allows the merchant to assign fulfillment orders to both the merchant's locations and compatible fulfillment services.

When a fulfillment service app sets permits_sku_sharing to true, some of the following behaviour will break. If you set a product variant's fulfillmentService parameter (REST & GraphQL) to manual, then it no longer means that the variant is stocked only at a merchant-managed location. Apps that use the fulfillmentService parameter in this way should instead use the location parameter on the Fulfillment Order resource to determine which location or fulfillment service fulfills a given product variant.

Learn about multi-managed inventory from merchant's perspective.

Learn more about the building a fulfillment service using the fulfillment orders API.

Learn more about managing fulfillment orders using the REST Admin API and GraphQL Admin API.

As part of the GraphQL Storefront API 2022-07 API release, we are changing how discountAllocations on Cart and CartLine are returned.

• Cart.discountAllocations returns discount allocations that are applied to the entire Cart.

CartLine.discountAllocations now only returns discount allocations that are applied to the specific CartLine.

CartLine.total reflects the line total with only line-level discounts applied, not discounts applied to the entire Cart.

Learn more about the Cart object on Shopify.dev.

Multi-managed inventory introduced a breaking change to LineItem resource fulfillment_service, therefore this field will no longer be supported in REST and GraphQL. Fulfillment services will all be opted into SKU sharing in 2023-04. Please consider using REST FulfillmentOrder#assigned_location & GraphQl FulfillmentOrder#assigned_location

When a fulfillment service app sets permits_sku_sharing to true, some existing behaviour will break. When a product variant's fulfillmentService parameter (REST & GraphQL) is set to manual, it no longer means that the variant is stocked only at a merchant-managed location. Therefore, apps that use the fulfillmentService parameter in this way should instead use the location parameter on the Fulfillment Order resource to determine which location or fulfillment service fulfills for a given line item.

Learn more about managing fulfillment orders using the REST Admin API and GraphQL Admin API.

Learn more about the building a fulfillment service using the fulfillment orders API.

The following other line item object properties on the REST Admin API's Order resource are deprecated:

• origin_location
• destination_location

The following object property on the REST Admin API's Order resource is deprecated:

• total_price_usd

These deprecated properties will be removed from unstable. The change will be made official in the 2022-10 REST Admin API version.

For other recent deprecations on the Orders resource refer to this Change Log

Multi-managed inventory introduced a breaking change to ProductVariant resource fulfillment_service, therefore this field will no longer be supported in REST and GraphQL. Fulfillment services will all be opted into SKU sharing in 2023-04. Once opted into sku sharing a product variant could be linked to multiple fulfillment services.

For GraphQL to see all associated fulfillment services use InventoryLevelConnection#locations. For REST please refer toInventory levels APIs to see how variants are associated to multiple fulfillment services.

When a fulfillment service app sets permits_sku_sharing to true, some existing behaviour will break. When a product variant's fulfillmentService parameter (REST & GraphQL) is set to manual, it no longer means that the variant is stocked only at a merchant-managed location. Therefore, apps that use the fulfillmentService parameter in this way should instead use InventoryLevel APIs to determine which location or fulfillment service fulfills a given product variant.

Learn more about managing fulfillment orders using the REST Admin API and GraphQL Admin API.

Learn more about the building a fulfillment service using the fulfillment orders API.

Also the field presentment_prices is being deprecated in REST and GraphQL. For more context refer to this change log.

This change adds the public GraphQL fields associated with fulfillment hold automations to the 2022-07 Admin API GraphQL release. Specifically, this adds the following field - MailingAddress.coordinatesValidated

This new boolean field can be used by partners to determine if the coordinates of a mailing address have been validated by Shopify. This unlocks ability to hold fulfillments on unvalidated mailing address and ensure that merchants check prior to requesting fulfillments from their 3PL.

Learn more about holding fulfillments with GraphQL and with REST Learn more about Shopify Flow

The Fulfillment API is being deprecated in the Shopify 2022-07 release. Apps will have until the 2023-04 release to migrate away from the deprecated API and use Fulfillment Orders instead. To help you seamlessly migrate, we’ve crafted a migration guide that walks you through the process of moving to Fulfillment Orders. To learn more, visit the migration guide on Shopify.dev.

As of API version 2022-07 all GraphQL schemas will start using the "@deprecated" directive for input fields and arguments which have been deprecated. API versions 2022-04 and below will continue to use the description for deprecation warnings.

It is recommended you use a GraphQL client which supports deprecated input fields and arguments when using GraphQL API versions 2022-07 and above. For example graphql-js added support as of version v15.5.0. See the official GraphQL spec for more details.

As of GraphQL Admin API version 2022-07, a new statistics field has been added to the Customer object for computed customer statistics. It includes a new field predictedSpendTier which indicates the predicted spend of a customer with a shop.

For more information, refer to the CustomerStatistics field in the GraphQL Admin API reference.

Starting with API version 2022-10, we’re introducing updated requirements for apps that use customer data. Updated requirements will be published prior to the release of API version 2022-10.

The protected customer data requirements focus on data minimization, transparency, and security so that Partners can better support merchants' paths towards compliance with privacy and data protection rules.

Learn more about how you can be ready for protected customer data.

With Checkout Extensibility, you can now build apps to customize checkout and Shop Pay. You can leverage Checkout UI extensions and Shopify Functions to surface new functionality, Checkout Branding API to customize styling, and Pixels to track events.

Checkout Extensibility is now available in developer preview.

Learn more about Checkout Extensibility on Shopify.dev.

As of GraphQL Admin API version 2022-07, you can use the Discount APIs to modify combination settings on a discount. This allows a customer to apply more than one discount to their order.

Discount combinations are available now as part of the Checkout extensibility developer preview.

Learn more about how discount combinations work.

As of GraphQL Storefront API version 2022-10, CartCustomDiscountAllocation object has a new field: type. This field returns the type of custom discount (i.e. manual or script) on a discount allocation from a cart line.

Learn more about the Cart object on Shopify.dev.

Shopify Functions lets you extend or replace key parts of Shopify’s backend with custom logic. Functions run on Shopify infrastructure, making them both scalable and performant.

Functions are now available in developer preview for product, order, and shipping discounts.

Learn more about Shopify Functions on Shopify.dev.

With the latest App Bridge enhancements, your app will now look, feel, and perform like it’s a part of Shopify.

More specifically, App Bridge mobile apps can now load 85% faster from the Shopify iOS and Android apps when you enable mobile optimization for your embedded app. App Bridge apps can also now leverage full-screen mode, just like our first-party apps, for complex workflows in the Shopify admin. Lastly, apps that use the NavigationMenu component will now have their navigation embedded into the Shopify admin for faster, more natural access.

Learn more about App Bridge on Shopify.dev.

The updated Shopify CLI 3.0 is both easier to use and more powerful than ever. With Shopify CLI 3.0, we’ve simplified the development process by reducing the number of commands that you need to get started from 13 to 5.

You can also now leverage a single project for your app and extensions, preview your entire project with one command, and push your entire project together with a single command when you’re finished.

Learn more about Shopify CLI 3.0.

As of GraphQL Admin API version 2022-07, we have expanded the Selling Plan API enabling you to integrate support for new deferred purchase options like pre-orders and try before you buy into the Shopify Checkout.

As of GraphQL Admin API version 2022-07, we have introduced new APIs that enable you to collect deferred payment on an order using a vaulted card belonging to the customer. The orderCreateMandatePayment mutation will be available for charging payments against a vaulted credit card. This API returns a GraphApi::Job and paymentReferenceId. This paymentReferenceId can be used to poll the status of the payment using the orderPaymentStatus query.

What a relief - app distribution is now decoupled from the app creation flow in the Partner Dashboard! This means you no longer have to select a public or custom app type before you start coding.

We’ve also improved the navigation within the Partner Dashboard and added a Distribution page, where can manage your Shopify App Store listing or generate your merchant install link. Also, if you’re building your app using Shopify CLI, you’ll be able to copy and paste the commands you need to get started right from the dashboard.

Learn more about app distribution and selecting a distribution method.

As of GraphQL Admin API version 2022-07, the SellingPlanAnchorInput type has an additional optional field.

cutoff_day represents a fixed cutoff day for each anchor, to be used for monthly and weekly selling plans. Use this method if the cutoff should land on the same day each month.

You can also specify a cutoff using the cutoff field of the SellingPlanRecurringDeliveryPolicyInput type, which represents a duration. Using cutoff, the exact cutoff day could be different based on the number of days in the month.

As part of the GraphQL Storefront API 2022-07 API release, the following are changes to have been made to the Cart and CartLine object:

• New attribute field with a key argument
• estimatedCost is renamed to cost on Cart.
• estimatedCost is renamed to cost on CartLine.
• Add subtotalAmountEstimated, totalAmountEstimated, totalTaxAmountEstimated, totalDutyAmountEstimated to CartCost
• amount is renamed to amountPerQuantity on CartLineCost.
• compareAtAmount is renamed to compareAtAmountPerQuantity on CartLineCost.

Learn more about the Cart object on Shopify.dev.

As of GraphQL Admin API version 2022-07, app developers can now choose their preferred update behavior when upgrading or downgrading merchant application subscriptions.

By specifying the desired AppSubscriptionReplacementBehavior type, app developers can control whether the new subscription goes into effect immediately or is deferred to the end of the current subscription's billing cycle. By default, all app subscription changes will continue with the existing behavior.

Learn more about specifying app subscription replacement behavior on Shopify.dev.

When developing a theme using Shopify CLI, you can now preview your local changes using any theme in a store. To specify a theme, run the Shopify CLI theme serve command with the new -t or --theme flag:

shopify theme serve -t my-unpublished-theme

Previously, developers could only preview changes using development themes.

Caution: Before running shopify theme serve, pull your remote theme to ensure that any recent changes don't get overwritten by your local development files.

Learn more about previewing your theme using Shopify CLI.

As of May 9, 2022, you can use the GraphQL Admin API unstable version to surface custom content to buyers in a specific market, including custom content for a store’s default language.

This feature enables merchants to provide the following kinds of localized and custom content:

• Support showing regional spelling or preferred terms. For example, a “Sweaters” menu title for a United States market, and a “Jumpers” menu title for a United Kingdom market.
• Display promotional content based on the buyer’s market. For example, a custom Thanksgiving announcement bar in October for Canadian buyers.

For more information, refer to examples in our developer documentation for the translationsRegister, translationsRemove, and translatableResource mutations.

A much wider range of optimized GIFs, including LZW compression, are now accepted for upload.

To learn more about which image formats Shopify accepts refer to: https://help.shopify.com/en/manual/online-store/images/theme-images#image-formats

Google Pay payments are now accepted for recurring transactions. For these transactions, the CustomerCreditCard will have a source of google_pay.

For more information, refer to Building subscription apps.

The TranslationsRemove endpoint now supports deleting translations that are stored in asset files.

Learn more about the TranslationsRemove endpoint.

Based on your feedback, we've updated the number of sections and blocks you can add within a template. You can now add up to 25 sections per template and 50 blocks per section within each template.

This will support use cases like: * Adding more blocks to an FAQ section * Adding multiple profile sections on the About Us page * Creating multiple areas of focus on the homepage * Section and block support for very large collections

You can specify a lower limit with the max_blocks attribute.

Learn more about section and block limits in our theme architecture documentation.

The visibility of an app block, or app embed block, of a theme app extension can now be controlled based on a custom condition.

The condition can be included in the block's schema with the available_if attribute, and the state of the condition is stored in an app-owned metafield. The metafield can be accessed through the Liquid app object.

To learn more about conditional app blocks, refer to Theme app extensions framework.

A new Liquid app object is available for use within the context of theme app extensions and app proxies. The app object can be used to access an app's metafields.

Refer to the app object documentation for more information.

As of GraphQL Storefront API version 2022-04, a new checkoutChargeAmount field has been added to Cart. It indicates the subtotal amount to be paid for this cart at checkout, not including any deferred payments. This field is currently restricted behind the extend_selling_plans_api beta flag.

The checkoutChargeAmount field is similar to the subtotal field. The subtotal field indicates the subtotal that will be paid altogether, including any payments that will be made at a later date. The checkoutChargeAmount is the actual price that will be paid at the time of checkout.

As of API version 2022-04, the DigitalWallet enum has a new value, FACEBOOK_PAY. This change affects both GraphQL Admin and Storefront APIs.

For more information, refer to the DigitalWallet enum in the GraphQL Admin API reference or Storefront API reference.

As of GraphQL Admin API version 2022-04, the CustomerPaymentMethodRevocationReason object has a new enum value: MERGED. This value is assigned when a customer replaces one payment method with another existing payment method, leaving this revoked payment method with no associated subscription contracts.

Learn more about this API on Shopify.dev.

As of GraphQL Admin API version 2022-04, a new originTime field has been added to subscriptionBillingAttempt. Fulfilment intervals for subscriptions are normally calculated using the billing attempt date, but may be overridden with this new field if the billing happens to occur after the current anchor date. This can be done to prevent fulfilment from being pushed to the next anchor date when billing is delayed.

Visit our documentation on Creating a Billing Attempt and Advanced Delivey Behaviours for Subscriptions to learn more about this new field.

As of the 2022-04 version of the Admin GraphQL API, the customAttributes field will be present on the SubscriptionContract, SubscriptionDraft, and SubscriptionDraftIndex objects. Those new fields correspond to the existing field of the same name on the Order object.

This allows you to update a subscription contract draft with new custom attributes. Those attributes will be copied over to new orders created from that subscription contract.

Learn more about SubscriptionContract and subscriptionDraftUpdate on Shopify.dev.

As of GraphQL Storefront API version 2022-07, the Collection object has a new field: SEO. This field returns an SEO object.

Learn more about this API on Shopify.dev.

As of GraphQL Admin API version 2022-04, a new deliveryGroups connection has been added to cart. It consists of a group of delivery options available for the line items in the cart, for a specified shipping address. Delivery groups are only available for logged-in customers with a full default address.

Refer to our documentation on cartCreate and customerCreate to learn more about how to create a cart associated with a logged-in customer.

As of Admin API version 2022-04, two new fields, source_url and source_identifier have been added to the Orders and Checkout objects in both the REST and Graph APIs. The source_name field will also be updated across these APIs for the Orders, Draft Orders and Checkout object. By adding a valid source_name, the order will be attributed to a list of sales channels found within the partner's dashboard.

More information can be found here

As of version 2022-04, the @inContext directive in the Storefront API accepts a language argument in addition to country. If the requested language is active for the given country, as configured within the shop's Market settings, then the query will return translated values.

The list of available languages can be accessed with this query:

query Localization @inContext(country: CA, language: FR) {
  localization {
    # for the current country
    availableLanguages {
      isoCode
      endonymName
    }
    # and for non-current countries
    availableCountries {
      isoCode
      name
      availableLanguages {
        isoCode
        endonymName
      }
    }
  }
}

If an unsupported language or country is requested via @inContext, the response will fall back to supported values. In all cases, the actual country and language context will be returned as a response extension.

{
  "data": {
    "productByHandle": {
      "title": "Cat bed",
      "variants": {
        "edges": [
          {
            "node": {
              "priceV2": {
                "amount": "100.0",
                "currencyCode": "CAD"
              }
            }
          }
        ]
      }
    }
  },
  "extensions": {
    "context": {
      "country": "CA",
      "language": "EN"
    }
  }
}

Learn more about supporting multiple languages on storefronts.

As of API version 2022-04, the GraphQL Admin API's FilterType enum has a new value(BOOLEAN). The BOOLEAN value is assigned when a filter is based off a boolean type metafield definition.

For more information, refer to the Filter object.

As of the 2022-04 version of the Storefront API, you can fetch a navigation menu by handle with the menu field. The new field returns a Menu object, and can be used to replicate a merchant's Online Store menus on custom storefronts.

The following are changes to the GraphQL Admin API's Customer object:

• The orders_count field is renamed to number_of_orders.
• The total_spent and total_spent_v2 fields are replaced by amount_spent.
• The has_note field is removed. The note field still exists on the customer.
• The has_timeline_comment field is removed. To query for comments on the timeline, use the events connection and a query argument containing verb:comment, or look for a CommentEvent in the __typename of events.

For more information, refer to the Customer object.

The accepts marketing and related fields were used to indicate if a customer subscribed to all marketing channels. In 2021, we started separating marketing consent into SMS and email channels by introducing SMS marketing consent.

In API version 2022-04, we’re completing that split by deprecating the accepts marketing fields and replacing them with email marketing consent fields. You’ll need to update your apps to use the SMS and email marketing consent fields to send the opt-in level, consent state and the time at which the consent was granted, instead of a simple Boolean to express the marketing consent of customers.

As of GraphQL Admin API version 2022-04, we're deprecating the acceptsMarketing, acceptsMarketingUpdatedAt and marketingOptInLevel fields on the Customer object and CustomerInput input object.

The deprecated fields are replaced by the following new fields, that you can access using the emailMarketingConsent field on the CustomerInput object:

• marketingState
• consentUpdatedAt
• marketingOptInLevel

For more information, refer to the CustomerInput input object on Shopify.dev.

As of REST Admin API version 2022-04, we're deprecating the accepts_marketing, accepts_marketing_updated_at and marketing_opt_in_level fields on the Customer resource.

The deprecated fields are replaced by the following properties on the new email_marketing_consent field for the Customer resource:

• state
• consent_updated_at
• opt_in_level

For more information, refer to the Customer resource on Shopify.dev.

As of GraphQL Admin API version 2022-04, a new checkoutCharge field has been added to sellingPlan. It consists of a charge type (either percentage or price), and an amount, indicating how much of the product's cost will be charged at the time of checkout. This field is currently restricted behind the extend_selling_plans_api beta flag.

After the release of Shopify Markets, we are following up with the Markets API in version 2022-04. The API allows you to create, update, and delete markets and their settings.

Shopify Markets unlocks the ability to create high-performing, localized buyer experiences by allowing merchants to specify the domain, language, currency and price that international buyers see when browsing a merchant's storefront.

You can learn more about the Markets API on shopify.dev.

GraphQL Admin API

As of GraphQL Admin API version 2022-04, we're adding the fulfillBy to the FulfillmentOrder object. The field represents the latest date and time when all items in the fulfillment order need to be fulfilled.

We're also adding the maxDeliveryDateTime and minDeliveryDateTime fields to the DeliveryMethod object. When combined, they represent a range of time when the delivery is expected to be completed.

Learn more about FulfillmentOrder and DeliveryMethod objects.

REST Admin API

As of REST Admin API version 2022-04, the following properties are added to the FulfillmentOrder resource:

• fulfill_by
• delivery_method.max_delivery_date_time
• delivery_method.min_delivery_date_time

Learn more about the FulfillmentOrder resource.

In addition to edges, GraphQL connections now have a nodes field. When you only query node on edges, you can simplify the query.

For example:

{ connection { edges { node { fields } } }

can be simplified to:

{ connection { nodes { fields } } }

PageInfo has been expanded as well to include startCursor and endCursor.

When these fields are used in tandem, it can simplify the shape of return data for pagination.

Previous query format:

{ connection { edges { cursor node { fields } } pageInfo { hasNextPage } } }

Improved query format:

{ connection { nodes { fields } pageInfo { hasNextPage endCursor } } }

We are introducing new flexible ways for app partners to offer merchants incentives for app subscriptions.

Recurring App Discounts

As of GraphQL Admin API version 2022-04, app developers can now offer limited time discounts on recurring app charges through the Billing API. Partners may define a percentage or fixed amount discount that will be applied to a designated number of billing cycles (e.g. 20% of 6 billing cycles). This will enable app partners to create introductory offers for new merchants.

Learn more about app billing discounts on Shopify.dev.

App Trial Extensions

App developers can increase the number of trial days offered to a recurring app charge by using the new appSubscriptionTrialExtend offered without merchants accepting a new app subscription. This will enable developers to provide new merchants additional time to trial products. App trial extension is currently available in the unstable version of the GraphQL Admin API.

Learn more about trial extensions on Shopify.dev.

As of GraphQL Admin API version 2022-04, app partners can issue prorated credits for the unused portion of the app subscription when a recurring app charge is cancelled. This enables developers to automatically provide app credits to merchants when they uninstall an app or cancel a subscription, and reduce support requests to app partners for refund requests.

For more information, refer to the appSubscriptionCancel mutation.

As of GraphQL Admin API version 2022-04, checkoutChargeAmount and remainingBalanceChargeAmount fields have been added to sellingPlanAllocation. These fields indicate how much of a product variant's price must be paid upfront, and how much must be paid at a later date. This field is currently restricted behind the extend_selling_plans_api beta flag.

You can now create videos and transcode them to multiple formats, using the FileCreate mutation.

You can also attach videos to metafields using file_reference. These videos are also available using the Storefront API.

As of GraphQL Admin API version 2022-04, a new owner type ApiPermission is now available for metafields. A metafield with this permission type will only be readable and writable by the app that owns the metafield.

Although the INVALID_LOCALE_FOR_SHOP error code was introduced in the 2020-07 version, it has never been used to represent a locale field related error when calling the translationsRegister mutation.

As of GraphQL Admin API version 2022-04, the INVALID_LOCALE_FOR_SHOP error code is used to represent all errors related to the locale field on the Translation object.

Previous verions will still use the INVALID_CODE error code to represent errors related to the locale field.

Theme developers can now use the Shopify CLI theme serve command with the new --theme-editor-sync flag. When active, theme editor changes are automatically synced back to the local development files.

Learn more about Shopify CLI theme commands.

Developers can now programmatically push their scripts and extensions to Shopify from their CI/CD pipelines with CLI authentication tokens.

For more information on how to set up CI/CD for your scripts and extensions, visit our developer documentation.

Two new input setting types have been added to the theme editor: product_list and collection_list. They allow merchants to quickly create curated, ordered and paginatable lists of products and collections.

Learn more about product_list and collection_list on shopify.dev.

As of GraphQL Admin API version 2022-04, an error returns when a metafield definition is created with invalid characters in either the key or the namespace fields. The key and namespace fields can contain only alphanumeric characters, hyphens, and underscores.

Learn more about the MetafieldDefinition object.

As of GraphQL Admin API version 2022-04, new fields on the App resource are available. These include previouslyInstalled, webhookApiVersion, developerType, requestedAccessScopes, availableAccessScopes, and publicCategory. publicCategory introduces a new enum AppPublicCategory which represents the distribution pattern the app uses.

As of March 14, 2022, app listing pages will include additional details about Partners, such as how many apps they have on the store, the average app rating (for all apps combined), and how long they’ve developed for Shopify. Some of this information is already displayed on the app developer pages, but we’re adding it to the app listing page so that merchants have the decision-making details they need in a single place.

See your app listing page under the Support tab for more details.

As of today, apps will be able to store translation strings in a centralized locales folder accessible across all app blocks and app embeds within a theme app extension.

For more information about the locales directory, refer to the theme app extension framework file structure.

We’ve just released Product Scheduled Publishing to Channels, allowing merchants to schedule products to be published to a sales channel at a specific datetime.

For channels that have product validation workflows, you’ll need to integrate with scheduled product publishing so that your channel can validate products before their scheduled publication datetime.

Complete this form to sign your channel up for scheduled publishing.

For more information, refer to scheduled publishing.

A new attribute (total_duties) is now available on the order object. order.total_duties attribute returns the sum of all duties applied to line items in the order. order.total_duties returns nil if duties are not applicable to the order.

For more information, refer to order.total_duties.

As of February 17th, newly-created themes will generate translatable content keys for content in JSON templates in an altered format. Translations originating outside of JSON templates, such as those stored in the locales/ folder of a theme, are not affected by this change.

Old: section.Template—123456__section_id.block_id.setting_id New: section.product.ext.json.section_id.block_id.setting_id:abc123

We consider the precise format of these keys to be an implementation detail, but try to ensure that the keys remain consistent for a resource over time. Given that, these new keys will only be generated for themes that are uploaded or duplicated after 12:00 EST February 17th.

More information about our translation API is available in our API documentation.

We’ve just released Shopify Markets, which helps merchants sell their products to customers in different countries from a single Shopify store. Merchants can also create unique experiences for their global customers from the Shopify Markets admin's Settings. Apps and themes must use the routes object to support subfolders with locale-aware URLs, and should also use the country object (instead of currency) if they provide storefront switchers.

Shopify Markets is now available for all merchants, with some exceptions. All development stores now have access to Shopify Markets.

For more information, refer to Shopify Markets. Developer considerations for supporting multiple currencies and languages can be found here.

It’s now possible to upsell subscriptions in cart in the online store. We added a new field, selling_plan, to the /cart/change.js endpoint in the AJAX REST API to support adding, updating, and removing the selling plan.

Learn more about supporting subcriptions on shopify.dev.

Apple Pay payments are now accepted for recurring transactions. We added source and virtualLastDigits to the CustomerCreditCard object to support this, in the 2021-10 release.

Note: Available to merchants using Shopify Payments in the US, Canada, Australia, and New Zealand for Visa and Mastercard.

For more information, refer to subscriptions.

The app that manages connections between Shopify and GitHub has changed its name from Shopify Online Store to Shopify. There’s no change to the app’s existing functionality.

This change reflects earlier updates to Shopify’s GitHub app, which allows it to be used for custom storefront development with Hydrogen, in addition to managing theme code for the online store. We’ll continue to use this app to manage any additional future connections between Shopify and GitHub.

Learn more about the Shopify GitHub integration.

As part of the 2022-04 API release, we've updated the Admin GraphQL and Storefront APIs to provide clearer URLs for the ExternalVideo type:

• The embeddedUrl field has been deprecated in favor of originUrl. Like embeddedUrl, originUrl returns the URL to the video on its hosted platform (either Vimeo or YouTube).
• A new field called embedUrl has been added. It returns the URL required to embed the video inside an iframe.

Learn more about the Admin API ExternalVideo type and the Storefront API ExternalVideo type on Shopify.dev.

We’ve simplified the app model at Shopify by introducing a new experience for creating, configuring, and building custom apps in the Shopify admin.

Custom apps now support all of the functionality that private apps do today, and provide better security. Going forward private apps will be replaced by custom apps, however existing private apps can still be used and modified.

Learn more about the different types of app you can build.

Channel Attribution is now available in beta

Passing the correct information to these fields will now improve the accuracy of order source reporting up to the sub-channel level as well as reduce the time merchants spend organizing and fulfilling orders from marketplaces.

The following fields are now being used for sales attribution on the Orders, Checkout, and Draft Orders APIs. Please ensure that the version of the API you are using is unstable.

Orders & Checkout fields:

• source_name (string): Handle indicating where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for Shopify channels are protected and cannot be assigned by other API clients: web, pos, shopifydraftorder, iphone, and android. Orders created via the API can be assigned any of the handles listed in the Partner Dashboard, on the app's Marketplace extension. The handles are case sensitive. If the string is not in the list handles, then the order will be left unattributed. If unspecified, then new orders are assigned the value of your app's ID.
• source_identifier (string): The ID belonging to the original order.
• source_url (string): A valid URL pointing to the original order on the originating surface. This URL will eventually be displayed to merchants on the Order Details page. If the URL is invalid, it will not be displayed.

Draft Orders fields

source_name (string): The handle indicating the order’s origin. This field is not writable afterwards so make sure to consult the list of handles beforehand. If your handle does not exist in list of, then value will still be saved and will not block order creation.

Note: You need to include the Content-Type param in the header ("Content-Type: application/json")

Merchants can use the Subscription API if they have Stripe on their Shopify checkout or have permission to do so.

For more information, refer to subscriptions.

On January 5, 2022, we will add a Regulatory operating fee field to the Partner payout and app earnings CSV.

This field will help app and theme developers understand the calculation of the Regulatory Operating Fee introduced in the Partner Program Agreement update. It represents the amount deducted from your app and theme charges to merchants based on the applicable merchant business address.

For more information about the Partner Program Agreement update, refer to our PPA update FAQ.

For more information about tracking your Partner earnings, visit the Shopify Help Center.

API calls made to the Admin and Storefront API are denied access if the API client does not have the required access scopes or the user does not have the required permissions. From 2022-01, when access is denied, the required permissions is returned as part of the error message. An error code is also returned.

We’ve added two new fields to the Product object, standardizedProductType and customProductType. The standardized type is a new data primitive that links products to the Shopify Product Taxonomy. We use this today to determine product eligibility for the Shop app and as a part of our BFCM Notebook. We will see future experiences using the standardized product type. The custom type provides further granularity than the standardized type allows.

For more information on Product Taxonomy, visit our developer documentation.

As of the 2020-10 version of the GraphQL API, a new field is now present on the SuggestedOrderTransaction object: supportedRefundType. This field can contain one of two values, either CARD_NOT_PRESENT_REFUND or CARD_PRESENT_REFUND.

Because "card present" refunds can only be processed by the POS that has access to the physical card, API clients only receive a SuggestedOrderTransaction by default if the supportedRefundType is CARD_NOT_PRESENT_REFUND.

For more information about SuggestedOrderTransactions, visit our developer documentation.

As of GraphQL Admin API version 2022-01, the ProductVariant object has a new field: sellableOnlineQuantity. This field returns the total sellable quantity of the product variant for online channels.

Learn more about this API on Shopify.dev.

As of GraphQL Storefront API version 2022-01, the ProductVariant object has a new field: barcode. This field returns the barcode value (ISBN, UPC, GTIN, etc.) associated with the variant.

Learn more about the barcode field on Shopify.dev.

As of GraphQL Storefront API version 2022-01, the Shop object has a new field: subscriptionPolicy. This field returns the subscription policy associated with the shop.

Learn more about the Shop object in the Storefront API documentation on Shopify.dev.

As of GraphQL Admin API version 2022-01, we are releasing a new mutation orderInvoiceSend. This mutation will take an Order ID and an EmailInput and send the order invoice to the email. It returns the Order when successful.

Learn more about this API on Shopify.dev.

Starting in version 2022-01, the BULK_MUTATION_USER_ERROR_CODE error code for the bulkOperationRunMutation mutation has been replaced by more granular error codes.

For the list of new error codes, refer to the GraphQL Admin API reference.

As of API version 2022-01, you can query for metafieldDefinitions on Order, Collection, and Customer. Previously this was only available on Product and ProductVariant.

Metafield Definitions are used to define a namespace, key, and type across all instances of a type of resource. These definitions enable Admin UI so that merchants can edit these fields in the context of each resource. You can learn more about Metafield Definitions in the Developer Docs.

This new endpoint takes an array of specific resource GIDs, and returns a list of TranslatableResources associated with those GIDs.

Learn more about the translatableResourcesByIds query and the Translations API on shopify.dev.

Shopify Markets is a cross-border management tool that helps merchants identify, set up, launch, optimize and manage their international markets - all from a single store. You can now enable a developer preview to access Shopify Markets on new development stores.

Learn more about this developer preview.

Learn more about Shopify Markets.

We've added subscription support for dynamic and accelerated checkout methods for PayPal Express on some stores.

Learn more about subscriptions in the Shopify Developer documentation.

If available, the language and country/region codes of a customer can now be appended to locale fields to provide more granularity for our partners. Affected fields are Order.customerLocale and Customer.locale in the GraphQL Admin API. For example, if a customer places an order in the french language within the France storefront of the shop, then the Order.customerLocale and Customer.locale fields will have fr-Fr.

For more information, refer to the Order and Customer object fields.

As of GraphQL API version 2021-10, running the CustomerPaymentMethodRevoke mutation can now set the customer_payment_method.revoked_reason field to manually_revoked.

For more information, refer to CustomerPaymentMethodRevocationReason.

The limit for JSON templates is increased from 50 per template to 1000 per theme. After this limit is reached, you can't create more JSON templates on the theme.

Learn more about JSON templates in the Shopify Developer documentation.

We’ve added support for contract notes to the 2022-01 API version. Contract notes are carried over from order notes on the initial order, if present.

For more information, refer to the release notes.

Media objects in the Admin API now includes mediaWarnings which returns information about a media item that might require attention such as when a 3D Model is incorrectly scaled. Data about the warning can be retrieved using the associated MediaWarningCode and message string.

Model3d objects now include a new field boundingBox that returns a Model3dBoundingBox object. The bounding box of the 3D model is the size of the model described by a box that surrounds the model.

[MediaErrorCodes](https://shopify.dev/api/admin-graphql/2021-10/enums/MediaErrorCode) and FileErrorCodes will now include a new enum value named MODEL3DPROCESSINGERROR that is used for when 3D models fail to process after being uploaded to Shopify.

Previously, the Cart API's bundled section rendering operated in the context of /cart when no specific sections_url parameter was set. Now, when sections_url isn't set, sections are rendered in the context of the current page, based on the Referer HTTP request header.

The behavior when sections_url is set remains unchanged.

For most themes, this change won't be disruptive. If the section being requested exists in the context of the current page, then using the Referer as the context for rendering, instead of /cart, shouldn't present any issues.

For more information on bundled section rendering, refer to the Ajax API's Cart reference.

Adding responsive images to your theme is now easier with the new image_tag filter. The filter outputs a responsive HTML img tag by default, allows adding arbitrary HTML attributes, and supports preloading.

Learn more about the image_tag filter on Shopify.dev.

Validation to identify vulnerable passwords has been added to the Storefront API's customerReset and customerResetByUrl mutations.

Now, when you try resetting a password to one that’s considered vulnerable, the API will return an error.

We’ve just released Marketplace Kit, a collection of APIs, components, and pre-built code snippets to add commerce features to any platform.

A marketplace is a purchasing surface on any platform, featuring products from different stores and directing buyers towards a sale. Marketplace Kit uses a channel app to connect Shopify merchants to any platform, and the Storefront API to power the set of actions that a customer can perform in a marketplace - such as viewing products and collections, adding products to a cart, and checking out.

Learn more: shopify.dev/marketplaces

The WebhookSubscription GraphQL object now has a privateMetafieldNamespaces field. You can use this field to specify private metafields that you want to be included in the payload for events sent by that webhook subscription.

The Shopify Online Store app for GitHub lets you associate a GitHub account with your Shopify login to sync changes to your themes continuously for faster development.

We are expanding this integration with GitHub to simplify the future development experience for building and deploying custom storefronts. In order to support this functionality we require additional permissions: Admin, Deployments, Pull requests, Secrets, and Workflows. The GitHub app will only require these permissions to work with custom storefronts.

We are asking for the minimum GitHub app permissions that we require to build a smooth experience for you. Ignoring this request won’t affect your work with the Online Store channel, and you can always come back to grant the permissions as needed.

Learn more about the GitHub integration with Shopify from Shopify Developer docs.

We have changed part of the AbandonedCheckout GraphQL API visibility to public. Third-party apps only have access to the AbandonedCheckout object and a selection of its fields if the marketing_automation_abandonments beta flag is enabled for the app. The available fields are line_items, line_items_quantity, and total_price_set.

The following types of storefront filters on product and variant metafields are now supported:

• single_line_text_field
• number_decimal
• number_integer

Learn more about storefront filters on metafields in the Shopify Developer Docs.

We've added a new CustomerPaymentInstrument and CustomerShopPayAgreement to the 2021-10 API version that allows the ability to store Shop Pay Agreements in Shopify to be used by SubscriptionContracts.

We’ve just launched the Payment Terms API to allow you to build apps that can set due dates on an order and track overdue payments with the newly added overdue status.

Payment terms and overall payment flexibility are important to Shopify merchants, especially those selling B2B, as they allow merchants to improve their buyer experience by offering personalized payment options and reduce the manual effort required to manage and process payments due at a later date.

Learn more about the Payment Terms API and view our release notes.

External apps can now subscribe to a webhook event to be notified when a financial institution challenges a subscription billing attempt charge. This update is in accordance with 3-D Secure.+

The webhook event will trigger a message to be published on the subscription_billing_attempts/challenged topic. To use the topic, an app requires the own_subscription_contracts access scope.

For more information, visit the REST Admin API Webhook documentation.

As of API version 2021-10, you can use the bulkProductResourceFeedbackCreate mutation to create up to 50 feedback entries on a product resource in a single API request. You can also query for product resource feedback with the productResourceFeedback field.

For more information, refer to https://shopify.dev/api/admin/graphql/reference/apps/bulkproductresourcefeedbackcreate

API version 2021-10 adds the origin_address property to the REST Admin API's Fulfillment resource. origin_address specifies the address at which a fulfillment occurred.

origin_address accepts a JSON object with address1, city, zip, province_code, retail, or country_code.

For more information about Fulfillment, visit our developer documentation.

As of API version 2021-10, the TranslatableResourceType enum will include two new resource types: ONLINE_STORE_MENU and PACKING_SLIP_TEMPLATE. ONLINE_STORE_MENU refers to the links used for navigation on an online store. PACKING_SLIP_TEMPLATE refers to templates used for creating packing slips. The ONLINE_STORE_MENU's title field and PACKING_SLIP_TEMPLATE's body field are now translatable with our translations API.

Learn more about this API on Shopify.dev.

As of API version 2021-10, the Order object will include an app field representing the application that created the order. The field returns an OrderApp object.

Learn more about this API on Shopify.dev.

As of API version 2021-10, the line_item object on a Fulfillment will include a fulfillment_line_item_id property. This property represents the ID of a line item from an order that's included in a fulfillment

Learn more about this API on Shopify.dev.

Apps can now subscribe to the bulk_operations/finish webhook topic that sends notifications when a Bulk Operation has completed, failed, or been cancelled.

Apps do not need to poll the GraphQL Admin API to check for status changes anymore. The webhook will notify the app when the Bulk Operation finishes.

This webhook supports query and mutation operations.

Learn more about the new feature in the Bulk Operation tutorial and the API documentation.

The BulkOperation object has a new type field that returns whether the operation is a query or a mutation.

Learn more about the type field in the BulkOperation object documentaion.

As of the 2021-10 API version, we have introduced a customerPaymentMethodGetUpdateUrl mutation to the Admin API that, given a customer payment method ID, returns a URL that enables a customer to update their payment method in a secure way when in a session. This mutation supports Shop Pay as of late 2021, and will expand support to other payment methods in the future. The customerPaymentMethodSendUpdateEmail is recommended as a fallback when the customerPaymentMethodGetUpdateUrl returns an error or when the customer needs to update their payment method outside of a session.

Learn more about this mutation by visiting our developer documentation.

As of API version 2021-10, you can query prices given a particular context using the new field contextualPricing . This functionality allows Apps to query prices in different contexts, including prices for countries (International Pricing). This new field was added to the Product Variant object to return a price and to the Product object to return a price range.

Learn more about the Contextual Pricing API on Shopify.dev.

You can now take advantage of preload links in Liquid by using the preload_tag filter. The filter will add a link tag with rel=preload to the page, and will attempt to add an entry to the response's Link header.

Learn more about the preload_tag filter in the Shopify Developer Docs.

As of API version 2021-10 Sales Channels can now complete a checkout with the Storefront API using TokenizedPaymentInputV3 and the PaymentTokenType value STRIPE_VAULT_TOKEN

Learn more about completing a checkout with the Storefront API and refer to the TokenizedPaymentInputV3 fields documentation on Shopify.dev.

In limited circumstances, such as when using cart permalinks, customer details like email and shipping address could be contained in the query parameters of the resulting checkout URL.

These customer details no longer appear in checkout URLs. Features that resulted in this behavior like cart permalinks should continue to function as normal.