Developer changelog

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 the 2020-10 version of the GraphQL API, a new field is now present on the CustomerPaymentMethod object: revokedReason. This field can contain one of the following values: * AUTHORIZE_NET_GATEWAY_NOT_ENABLED * AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD * FAILED_TO_UPDATE_CREDIT_CARD * STRIPE_API_AUTHENTICATION_ERROR * STRIPE_API_INVALID_REQUEST_ERROR * STRIPE_GATEWAY_NOT_ENABLED * STRIPE_PAYMENT_METHOD_NOT_CARD * STRIPE_RETURNED_NO_PAYMENT_METHOD

Updated the customerPaymentMethod API to allow querying for a reason on why a payment method was revoked.

For more information about CustomerPaymentMethod, visit our developer documentation.

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.

You can now directly report violations of our Partner Program Agreement, instead of contacting Shopify Partner Support. Please ensure your report is a term violation rather than a support issue.

Learn more about prohibited actions on Shopify.dev

As of API version 2021-10, you can use the GraphQL Admin API and REST Admin API to retrieve, add, and update a customer's consent to receive marketing material by SMS.

You can also subscribe to a webhook topic to be notified when a customer updates their SMS marketing consent.

For more information, refer to the API 2021-10 release notes.

Shopify’s post-purchase checkout extension now supports subscriptions offers. By surfacing subscription offerings immediately after checkout, you can now start building high-converting experiences for merchants’ most captive buyers.

Learn more about getting started, requirements, and limitations for post-purchase checkout extensions.

Merchants selling on multiple channels are unable to tell how long they have to fulfill a multi-channel order in Shopify to be compliant with the fulfillment policies of the channel. This can lead to merchants being penalized by the channel, having longer processing times which impacts a merchant's ratings on marketplaces and further reduces their dependence on Shopify as their back office.

The new field, fulfill_by on the FulfillmentOrder object, indicates the latest date that a merchant should fulfill an order to ensure that it arrives to the buyer within the estimated delivery window. This is the date at the end of the longest processing time for an order.

For example, if your processing time for an item is 3-5 days, and a buyer orders the item on September 1, then the fulfill_by date for this order is September 6.

The fulfill_by field is currently available only in the unstable version of the GraphQL Admin API and the REST Admin API. They are accessible through the new OrderSetFulfillmentDeadline mutation or endpoint POST /admin/api/unstable/fulfillment_orders/set_fulfillment_deadline.json.

You can now query merchantApprovalSignals on the Shop object to determine whether a merchant is pre-verified for onboarding to channel apps.

This query helps you to accelerate the process for onboarding approved merchants to sales channels.

For more information, refer to the release notes.

We increased the maximum number of app blocks supported in theme app extensions from 10 to 25. Learn more about theme app extensions on Shopify.dev.

We've updated the terms related to the new revenue sharing plan for theme developers in our Partner Program Agreement.

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

The fulfillment service SKU sharing developer preview gives fulfillment service apps the ability to stock and fulfill product variants alongside a merchant's locations.

This preview 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.

Learn more about this developer preview

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

Learn more about fulfillment orders on the REST and GraphQL APIs.

Starting Tuesday September 7, 2021, if you're submitting an app that integrates with a theme to the Shopify App Store, then you need to use theme app extensions.

Existing apps are strongly encouraged to adopt this feature as well. However, there is currently no deadline for existing apps in the Shopify App Store to adopt theme app extensions.

You can now show predictive search results through a rendered section using the following:

• The Liquid predictive_search object
• The /search/suggest endpoint of the Predictive Search API

Learn more about adding predictive search to your theme.

Shopify has introduced new guidelines around currency formatting for themes. If you're developing a theme, you can introduce a currency setting that lets merchants choose whether the currency code is included in price displays.

Showing the currency code with a price helps customers understand what currency they're browsing in, especially when the currency uses a common symbol like the dollar ($), so that there's no confusion at checkout.

To learn more about how this setting is implemented, and other considerations, refer to the price display UX guidelines.

Metafields now support a Rating type. Ratings represent a value on a specified scale, such as a product rating of 4.8 out of 5, or a spiciness rating of 3 chili peppers.

Learn more about Ratings in our metafield types and metafield object documentation.

As of August 2021, Shopify automatically minifies theme JavaScript when it is requested by the storefront. Minified JavaScript files are cached until the next time the underlying file is updated.

Minification improves storefront performance, leading to a better buying experience for customers.

Learn more about theme performance on Shopify.dev.

External apps can now subscribe to SellingPlanGroups webhook events to keep track of SellingPlans and SellingPlanGroups lifecycles.

The following are the topics for the events:

• selling_plan_groups/create: Triggered when a new SellingPlanGroup is created.
• selling_plan_groups/update: Triggered when a SellingPlanGroup is updated, including adding/removing/updating SellingPlans.
• selling_plan_groups/delete: Triggered when a new SellingPlanGroup is removed.

To use the topics, an app requires the read_products access scope.

On August 1, 2021, we will introduce two changes to the Partner payout CSV and app earnings CSV. These changes will help developers understand the calculation of their app revenue after they register for the new app store revenue share plan.

The following fields will be added or updated:

• Processing fee (new) - This new field represents the amount deducted from your application's charges to merchants for processing the charge.

• Partner share (updated) - The calculation of this field will be updated to represent the Partner sale amount less the Processing fee as well as the Shopify fee. This field will now better represent the amount you earn for each app charge.

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

Starting today, the following changes are effective on the unstable version of Partner API to help developers with the calculation of their app store revenue.

• The transaction objects AppOneTimeSale, AppSaleAdjustment, AppSaleCredit, AppSubscriptionSale, and AppUsageSale have a new field titled processingFee. The processingFee field indicates the amount that was deducted for processing your application’s charge to a merchant.
• The previously mentioned transaction objects have a new calculation for the netAmount field. The new calculation accounts for the deduction of processingFee amount from your app charge and adjustment to a merchant.
• SALE_SHOPIFY_FEE in the TaxTransactionType enum is deprecated and replaced by the SALE_FEES value. When taxes are charged on all fees for an app, theme, or service transaction, the SALE_FEES value is returned in the TaxTransaction object.
• The type field in TaxTransaction object is deprecated. A new field titled taxType is now present on the object, which will return either TaxTransactionType.REFERRAL_COMMISSION for taxes paid out on your commission fee for a referral or TaxTransactionType.SALE_FEES for taxes charged on fees for an app, theme, or service transaction.

These changes are available in the unstable version today and will be made official in the 2022-01 version of Partner API. Learn more about partner API reference documentation at Shopify.dev.

Starting August 1, 2021 at 10:00 am PST (1:00 pm EST), app developers can register for a reduced revenue share plan for apps sold through the Shopify App Store in the apps section of the Partner Dashboard.

In this new plan, Shopify collects 0% on the first 1,000,000 USD in annual gross app revenue earned through the Shopify App Store. Total app revenues in excess of 1,000,000 USD annually will be subject to a 15% revenue share, reduced from the previous 20%.

Learn more about updates to revenue share for Shopify App Store developers in the Shopiry Help Center.

We've updated the following items in our Partner Program Agreement:

• Terms related to the new revenue sharing plan for app developers
• Administrative details that help support the growth of Shopify Partners

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

As of API version 2021-07, you can use the GraphQL Admin API and Google Cloud Pub/Sub to subscribe to, update, and delete webhook subscriptions.

You can learn more about managing webhooks with Google Cloud Pub/Sub at Shopify.dev.

When merchants sell on multiple sales channels, it can be difficult to determine whether the merchant or the sales channel is responsilbe for remitting sales taxes. For example, most marketplaces are the liable party for sales tax, and should be excluded from merchant sales tax filings.

As of the 2021-07 version of the REST and GraphQL orders APIs, a new field is now present on the TaxLine object: channel_liable. This field indicates whether the sales channel that submitted the order is liable for remittance for each tax line. It can contain the following values: - true indicates that the channel is responsible for remittance of the tax line. - false indicates that the channel is not responsible for remittance of the tax line. - null indicates that it is unknown who has the responsibility, and that the merchant should check with a local tax authority to determine their tax obligations.

The channel_liable field lets developers inform merchants that another party is responsible for sales tax remittance, which then helps merchants better understand the tax that they are responsible for.

As of API version 2021-07, the GraphQL Admin API returns XXX in response to an unrecognized currency code. XXX is the ISO code used to denote transactions that involve no currency.

In mutations, a CurrencyCode input value of XXX is invalid. XXX can only be returned as a result and not as an input value.

This change prevents order pages from breaking if payments include a currency code that's not in the list of [supported values for the CurrencyCode object](api/admin/reference/common-objects/currencycode).

The new Liquid input setting allows merchants to add custom Liquid code directly from the editor. The Liquid setting is similar to the HTML setting type, except it allows access to Liquid variables. This means merchants will be able to access global and template-specific Liquid objects without editing their theme code.

Learn more about this update in our developer documentation.

Refer to Dawn’s custom-liquid section for an example of how the Liquid setting can be implemented.

As of API version 2021-07, you can use the File API to create, update, and delete generic files and images. This functionality allows merchants to reuse files for different apps. These files are added to the Files page in Shopify admin.

Learn more about the File API on Shopify.dev.

With the Shopify GitHub integration, you can connect your GitHub user account or organization to your Shopify admin, and connect Git branches to themes in your store. Native support for version control allows you to make and track and manage changes to theme code, as well as collaborate with other developers and share progress in real time.

Learn more about the Shopify GitHub integration.

You can now access our post-purchase checkout extension beta. This allows you to start building high-converting experiences like upsell offers, survey, donation requests, and more.

For more information on getting started, requirements, limitations, and more, refer to our detailed developer documentation.

Theme developers can now use Shopify CLI to build themes.

You can now do the following:

• Develop, preview, and test changes using development themes
• Hot-reload CSS and Liquid section changes as you’re developing
• Initialize a new theme project using our reference theme, Dawn, as a starting point
• Push and publish themes from the command line
• Lint your theme’s code using Theme Check
• Populate test data for your theme, including products, customers, and draft orders

Learn more about developing themes using Shopify CLI.

Theme Check scans themes for errors and highlights Shopify theme and Liquid best practices. You can run these checks as a part of the Shopify Liquid Visual Studio Code extension. Theme Check identifies several types of issues within your theme code, including:

• Liquid syntax errors
• Missing templates
• Unused variables and snippets
• Unknown and deprecated tags
• Excessive snippet nesting
• Performance issues

Learn more about Theme Check.

Development themes are temporary, hidden themes that are connected to the Shopify store you’re using for development. When you run shopify theme serve, Shopify CLI automatically creates a development theme inside the store you’re working on, and will reuse that theme each time shopify theme serve is subsequently run during the same session. You don’t need to worry about others viewing or making edits to it because development themes are not visible on the Online store > Themes page.

Learn more about Development Themes.

We've released a new commerce-oriented type system for metafields. Metafields created with these new types from our APIs will be more interoperable across our system.

The type system is exposed through a new type field. The type field replaces the valueType field, which is now deprecated, and will be removed in our 2021-10 release.

Most new types map to the old MetafieldValueType enum, except for json_string and json. json replaces json_string, but json_string will continue to exist because it behaves differently than the new json type when referenced in Liquid.

Note: json_string will not automatically migrate to the json type.

Learn more about the type system and how to migrate to it in the Metafields documentation.

To learn more about these API changes, refer to our API reference documentation:

• Admin REST reference
• Admin GraphQL reference
• Storefront API reference

Dawn is Shopify’s first open source reference theme–built with performance and flexibility in mind, and using Online Store 2.0 features, including JSON templates, which support app blocks and sections on all pages.

Dawn uses a HTML-first, Javascript-only-as-needed approach to theme development, and can be used as a model for building new themes on Shopify. Using Shopify CLI, theme developers can clone Dawn as a starting point for building new themes.

View the Dawn repository on GitHub.

We've released a new commerce-oriented type system for metafields. Metafields created with these new types from our APIs will now be more interoperable across our system.

The type system is exposed through a new type field that replaces the existing valueType field which is now deprecated. To make the migration easier, this is a non-breaking change. Both fields being supported until 2021-10 when valueType will be removed.

To learn more about the API changes, refer to the API specific reference documentation:

• Admin REST reference
• Admin GraphQL reference
• Storefront API reference

Theme developers can now use dynamic sources to insert standard metafields and known resource properties as setting defaults.

Learn more about the type system and how to migrate to it in the Metafields documentation.

The Shopify Subscription APIs now support Authorize.net!

We have updated our CustomerPaymentMethod API on the September 2021 release to allow Shopify to store credit cards from Authorize.net and be used by the SubscriptionContract API.

Learn more about Shopify Subscription APIs.

Accurate and reliable sales data is critical to our merchants' businesses. It surfaces the insights they need to report on sales, reconcile their accounts, and measure and improve the performance of their business.

Shopify is releasing a new set of APIs that provide app developers the ability to query a list of all sales related changes on any Shopify order. You can now have a single consistent way to ensure your app is retrieving the most up to date and precise sales data as opposed to stitching order and sales data together through multiple resources. The APIs offer a variety of helpful metrics regarding each sale including detailed information about discounts, taxes, and the additional ability to reference information about the line item associated with the sale. You can think of it as a queryable audit trail to track all order changes from new sales, order edits, returns, and more.

To learn more about the new APIs, visit our getting started guide in the Shopify Developer Docs.

The Storefront API, which was previously limited to only private apps and public sales channel apps, can now also be used by custom apps to create custom buying experiences.

Learn more about the Storefront API here.

With the Developer Console, you no longer need to build your app extension in an isolated environment, you can now test your app extension with real store data in a local store environment. Any changes made to your local environment will render immediately, meaning you no longer need to publish your app to view your modifications.

You can also render both desktop and mobile testing environments.

Learn more about product subscription app extensions and the developer console.

App developers and their teams can independently investigate billing questions from merchants and issue app refunds directly from the Charge Overview page. Developers no longer need to contact Shopify Support to issue app refunds. By responding to merchant billing support inquiries directly, app developers can increase merchant satisfaction.

Staff acounts can use the new Manage refunds permission to issue app refunds so that app developers can decide which team members perform refunds. Developers can issue refunds for app charges up to $1,000.00 USD and app charges that were created less than a year ago.

To learn more about partner app refunds, refer to: Issuing app refunds page

The new Theme Kit Access app makes it easier for merchants to grant access to their theme. Instead of relying on a private app API password to authenticate, merchants can now leverage the Theme Kit Access app to create, share, and manage Theme Kit access with their partners.

To start leveraging the Theme Kit Access app, click here.

To reduce the complexity of searching for apps, we’ve reduced the number of app categories and subcategories in the Shopify App Store, and renamed some of our categories to better fit the merchant's vocabulary and search intent.

This change means that most developers will find their apps listed in different or renamed categories and subcategories, and therefore some might also have a different page rank.

To learn more about app store categorization, please visit the shopify.dev

You can now iterate through the global Liquid pages object, instead of only being able to directly reference known pages through their handle. This allows you to access a paginated pages listing of up to 50 items at a time and produce HTML that is conditional to the page data that is available.

You can return properties for a specific page using {{ pages.pagename.propertyname }}:

<h1>{{ pages.about.title }}</h1>
<p>{{ pages.about.author }} says...</p>
<div>{{ pages.about.content }}</div>

You can also interate through up to 50 pages at a time with pagination:

<ul>
{%- paginate pages by 50 \-%}
    {%- for p in pages -%}
        <li>{{p.title}}</li>
    {%- endfor -%}
    {{ paginate | default\_pagination: next: 'Older', previous: 'Newer' }} 
{%- endpaginate \-%}
</ul>

We have added a new payment method type, CustomerPaypalBillingAgreement, to the 2021-07 release candidate that allows the ability to store Paypal Billing Agreements in Shopify to be used by SubscriptionContracts.

This change also introduces two new mutations. One to create a PayPal billing agreement for a customer, and one to update existing agreements. For more information on the new mutations, visit our documentation on customerPaymentMethodPaypalBillingAgreementCreate and customerPaymentMethodPaypalBillingAgreementUpdate