Shopify Developers Updates & Release Notes

Follow

434 updates curated from 442 sources by the Releasebot Team. Last updated: Nov 7, 2026

Get this feed:
  • Nov 6, 2026
    • Date parsed from source:
      Nov 6, 2026
    • First seen by Releasebot:
      Nov 7, 2026
    Shopify logo

    Shopify Developers by Shopify

    Partner apps must enable bulk operations before use

    Shopify Developers now requires partner-built public and custom apps to enable separate access for GraphQL Admin API bulk queries and mutations. Apps can manage permissions in the Partner Dashboard, and existing apps retain access if they used each operation type within the last 31 days.

    Starting today, apps need access to bulk operations before they can run bulk queries or bulk mutations with the GraphQL Admin API. You can enable access for your app in the Partner Dashboard.

    What changed

    Bulk queries and bulk mutations are enabled separately:

    • To run bulk Operation Run Query, your app needs access to bulk queries.
    • To run bulk Operation Run Mutation, your app needs access to bulk mutations.

    If your app starts a bulk operation without access, then the request returns an access denied error. The requirement applies to all GraphQL Admin API versions.

    Who's affected

    Public apps and custom apps that you build as a partner and that run bulk operations. Apps that merchants create in the Shopify admin or the Dev Dashboard aren't affected at this time.

    If your app already runs bulk operations, then we've already enabled access for it. You can confirm this in the Partner Dashboard.

    Apps that haven't run a bulk query or bulk mutation in the last 31 days lose access to that operation type. If your app loses access, then follow the steps below to enable it again.

    What to do

    Check your app's access and enable the operation types that it runs:

    1. From the Partner Dashboard, go to Apps, and then select your app.
    2. In the sidebar, click API access requests.
    3. Under Run bulk operations, click Allow bulk queries, Allow bulk mutations, or both. If an operation type is already enabled, then the section shows that it's enabled.

    You don't need to change your app configuration, release a new app version, or ask merchants to reinstall your app. Access applies to every store that has your app installed.

    For details, see Enabling access to bulk operations.

    Original source
  • Nov 6, 2026
    • Date parsed from source:
      Nov 6, 2026
    • First seen by Releasebot:
      Nov 7, 2026
    Shopify logo

    Shopify Developers by Shopify

    Apps must enable bulk operations before use

    Shopify Developers now requires partner-built public and custom apps to enable bulk query and mutation access separately in the Partner Dashboard before using these GraphQL Admin API operations. Existing access may expire after 31 days of inactivity, but no app update or merchant reinstall is needed.

    Starting today, apps need access to bulk operations before they can run bulk queries or bulk mutations with the GraphQL Admin API. You can enable access for your app in the Partner Dashboard.

    What changed

    Bulk queries and bulk mutations are enabled separately:

    • To run bulk Operation Run Query, your app needs access to bulk queries.
    • To run bulk Operation Run Mutation, your app needs access to bulk mutations.

    If your app starts a bulk operation without access, then the request returns an access denied error. The requirement applies to all GraphQL Admin API versions.

    Who's affected

    Public apps and custom apps that you build as a partner and that run bulk operations are affected. Apps that merchants create in the Shopify admin or the Dev Dashboard aren't affected at this time.

    If your app already runs bulk operations, then we've already enabled access for it. You can confirm this in the Partner Dashboard.

    Apps that haven't run a bulk query or bulk mutation in the last 31 days lose access to that operation type. If your app loses access, then follow the steps below to enable it again.

    What to do

    Check your app's access and enable the operation types that it runs:

    • From the Partner Dashboard, go to Apps, and then select your app.
    • In the sidebar, click API access requests.
    • Under Run bulk operations, click Allow bulk queries, Allow bulk mutations, or both. If an operation type is already enabled, then the section shows that it's enabled.

    You don't need to change your app configuration, release a new app version, or ask merchants to reinstall your app. Access applies to every store that has your app installed.

    For details, see Enabling access to bulk operations.

    Original source
  • All of your release notes in one feed

    Join Releasebot and get updates from Shopify and hundreds of other software products.

    Create account
  • Nov 6, 2026
    • Date parsed from source:
      Nov 6, 2026
    • First seen by Releasebot:
      Nov 7, 2026
    Shopify logo

    Shopify Developers by Shopify

    Merchant notes on store credit transactions

    Shopify Developers adds optional merchant-only notes to store credit credits and debits in GraphQL Admin API 2027-01, with transaction records returning saved notes. Existing integrations need no changes, and notes remain hidden from customers.

    As of GraphQL Admin API version 2027-01, you can attach a merchant-only note when crediting or debiting a store credit account and read those notes on store credit transactions. Notes are optional, so existing integrations continue to work without changes or required updates.

    What changed

    • Store Credit Account Credit Input and Store Credit Account Debit Input accept an optional note string.
    • Store Credit Account Transaction.note returns the stored note for credit, debit, and debit-revert transactions, or null when no note is set. Expiration transactions always return null.
    • Notes support up to 5,000 characters. Longer notes return a NOTE_TOO_LONG user error and the API doesn’t create the transaction.
    • Notes are for merchants only and aren't visible to customers. You can set a note when you create a transaction, but you can’t edit a note on an existing transaction.

    Who's affected

    This change applies to apps that manage store credit using GraphQL Admin API version 2027-01 or later. Versions 2026-10 and earlier don’t expose these fields.

    Existing read_store_credit_account_transactions and write_store_credit_account_transactions access scopes and permission requirements still apply. No new scope is required.

    What to do

    You don’t need to change existing integrations. To start using notes:

    • Target GraphQL Admin API version 2027-01 or later in your app.
    • When you create a credit or debit, include note in the input.
    • Select note on the returned Store Credit Account Transaction to read the stored value.
    • Test in a dev store by creating a transaction with a note and verifying that the response includes the expected note string.

    Related docs

    • store Credit Account Credit mutation reference
    • store Credit Account Debit mutation reference
    Original source
  • Nov 5, 2026
    • Date parsed from source:
      Nov 5, 2026
    • First seen by Releasebot:
      Nov 6, 2026
    Shopify logo

    Shopify Developers by Shopify

    App security updates: IP allowlist is now required

    Shopify Developers strengthens public app security with required IP allowlisting, ASN support for dynamic networks, token visibility in merchant settings, and tools to test network access and scan apps in CI/CD. Bulk operations will also require separate access scopes in a forthcoming update.

    The IP allowlist is now required for every public app by November 20, or November 11 if you use bulk ops. ASN support covers serverless hosting. Plus token updates.

    On Oct 27 we recommended the IP allowlist. It is now required for every public app by November 20, or November 12 if you use bulk ops. An IP allowlist means a leaked token can't be used anywhere but your own servers. With the busiest weeks of the year for merchants almost here, we're asking for it now.

    Action required

    • All public apps that call the Admin API: Turn on the IP allowlist by November 20, 2026 at 11:59 PM ET. With it on, your tokens only work from the addresses or networks you list, so a leaked token can't be used anywhere else. The IP allowlist is required for public apps. If you're on serverless or dynamic IPs, you'll need to allowlist by network with ASN support instead.
    • Bulk operations: Turn on the IP allowlist by November 12, 2026 at 11:59 PM ET. After that date, bulk queries and mutations from public apps without an IP allowlist are blocked.

    Also this week

    • Merchants can now see your app's security setup in Settings > Apps: expiring tokens and IP allowlist. After November 20, apps without an IP allowlist are flagged.
    • Find non-expiring tokens fast: filter your Dev Dashboard API logs by token type. And our Token Expiry FAQ answers the most common questions.
    • Network access testing in dev store previews: You can now test your network _access declarations before you release. It flags any site or server your app uses that you haven't declared yet. Test network access in dev store previews
    • Run app security checks in CI/CD. A new tutorial walks you through how to automatically scan your app for security issues.
    • Coming soon, access scopes for bulk operations: Bulk queries and bulk mutations will each need their own scope. If your app ran a bulk operation in the last 180 days, Shopify grants the scopes automatically. Once they're live, add them to your app config before your next deploy. We'll share the changelog with the scope names when ready.

    If you miss a deadline

    To protect merchant security, we'll begin enforcing IP allowlists starting in November. The timelines for expiring offline access tokens remain the same. In both cases, existing installs keep working until April 1, 2027:

    IP allowlist Expiring offline access tokens Bulk queries and mutations blocked November 12, 2026 Delisted from the App Store, no new installs November 20, 2026 Flagged in merchant Settings > Apps November 20, 2026 Merchants see a warning in their admin January 15, 2027 Admin API requests fail April 1, 2027

    Get help

    If you see something suspicious, tell us right away at [email protected]. You're responsible for fixing it and notifying affected merchants, and we'll support you through it.

    For general security inquiries, contact Shopify Support.

    Everything lives in the App Security Hub, and we answer questions on the App Security board in the developer community.

    Original source
  • Nov 5, 2026
    • Date parsed from source:
      Nov 5, 2026
    • First seen by Releasebot:
      Nov 6, 2026
    Shopify logo

    Shopify Developers by Shopify

    IP allowlists are now required for public apps

    Shopify Developers is requiring all public apps to configure IP allowlists by November 2026 to protect merchants and limit the impact of leaked tokens. Apps that miss the deadlines will face failed bulk operations or removal from the App Store and blocked new installs.

    We're enhancing protection of merchants by adding IP allowlist configuration as a requirement for public apps. All public apps using bulk operations must configure an allowlist by November 12, 2026, and all other public apps must configure an allowlist by November 20, 2026.

    If an app is not migrated by these dates:

    • November 12, 2026 at 11:59 PM ET.: Bulk operations from public apps without an IP allowlist will fail to execute.
    • November 20, 2026 at 11:59 PM ET: Public apps without an IP allowlist will be delisted from the Shopify App Store and blocked from new installs.

    What apps are affected

    All public apps.

    What apps are unaffected

    • Custom apps
    • Apps created by merchants either in the Dev Dashboard or in the admin

    Why we're making this change

    Leaked tokens can be used from any network location. IP allowlists reduce the impact of a credential leak by limiting the networks from which your app can invoke the Admin API.

    What to do

    Configure your app's allowed IPs in the Dev Dashboard:

    • If your app calls Shopify from static IP addresses, configure your IP allowlist based on static IPs or CIDR range.
    • If your app's egress IP addresses are dynamic, allow your hosting provider's ASNs and list the countries your app runs in.

    For setup instructions, see Restrict API access with an IP allowlist.

    What if my app makes Admin API calls from merchant infrastructure?

    You should move as quickly as possible to an architecture that better limits exposure of Admin API tokens. You may submit a request for an extension to the deadlines above.

    Original source
  • Similar to Shopify Developers with recent updates:

  • Nov 5, 2026
    • Date parsed from source:
      Nov 5, 2026
    • First seen by Releasebot:
      Nov 6, 2026
    Shopify logo

    Shopify Developers by Shopify

    App IP allowlists now support apps with serverless hosting through ASNs

    Shopify Developers adds ASN-based IP allowlists for apps without static IP addresses. Developers can allow hosting provider networks, limit access by country, test against recent traffic, and enforce restrictions to help secure Shopify API requests.

    Apps without static IP addresses, such as apps on serverless platforms, can now add your hosting provider's autonomous system numbers (ASNs) to your app's IP allowlist in the Dev Dashboard.

    What changed

    The IP allowlist section of your app's Settings page now lets you allow either IP addresses or Networks (ASN). For networks, enter up to 10 ASNs and limit them to up to 10 countries. Test them against recent traffic, then turn on enforcement. Requests from outside your allowed networks fail with a 403 status code.

    What to do

    IP allowlists will soon be required for all public apps. Shopify strongly recommends all apps use an IP allowlist.

    If your app calls Shopify from static IP addresses, keep allowing those addresses. If your app's egress IP addresses are dynamic, allow your hosting provider's ASNs and list the countries your app runs in.

    For setup instructions, see Restrict API access with an IP allowlist.

    Original source
  • Nov 4, 2026
    • Date parsed from source:
      Nov 4, 2026
    • First seen by Releasebot:
      Nov 6, 2026
    Shopify logo

    Shopify Developers by Shopify

    RETRY_DECLINED added to CustomerPaymentMethodRevocationReason

    Shopify Developers adds RETRY_DECLINED to the GraphQL Admin API’s Customer Payment Method revocation reasons in version 2027-01, helping apps identify when a payment processor has blocked further subscription payment retries.

    As of GraphQL Admin API version 2027-01, Customer Payment Method.revoked Reason can return a new value: RETRY_DECLINED. Shopify uses this value when a subscription payment method is revoked because the payment processor has blocked any further retry attempts. On earlier API versions, these revocations continue to return TOO_MANY_CONSECUTIVE_FAILURES.

    If your app reads Customer Payment Method.revoked Reason using API version 2027-01, use RETRY_DECLINED to indicate to merchants and buyers that the processor has blocked further charges to the saved payment method and that a different payment method is required.

    The customer_payment_methods/revoke webhook payload is unchanged. After receiving the webhook, query Customer Payment Method.revoked Reason to determine whether the payment method was revoked because of RETRY_DECLINED or TOO_MANY_CONSECUTIVE_FAILURES.

    Original source
  • Nov 4, 2026
    • Date parsed from source:
      Nov 4, 2026
    • First seen by Releasebot:
      Nov 5, 2026
    Shopify logo

    Shopify Developers by Shopify

    Test app network access configuration on dev stores

    Shopify Developers adds a network access testing preview for dev stores, helping app teams verify allowed hosts and sources through navigation warnings and browser console alerts before configuring storefront network settings.

    You can now test your app's [network_access] settings on a dev store with the new network access testing feature preview. The preview helps you confirm you have the right networks listed, and find hosts and servers you missed.

    What changed

    When you create a dev store with the network_access_testing feature preview, you can confirm your network configuration behaves as expected:

    • Links to hosts that aren't in allowed_navigation_hosts show the exit warning, so you can ensure you're warning when appropriate and not showing exit warnings for trusted hosts.
    • The browser console warns when a storefront page loads from or sends requests to a server that isn't in allowed_sources. The preview only warns. It doesn't block anything.

    Who's affected

    Any app whose code links to or contacts external servers from a storefront can use this new testing option. Shopify recommends all apps configure these settings to avoid navigation warnings on merchant sites, and to help Shopify spot suspicious activity.

    What to do

    For step-by-step instructions and troubleshooting, follow the steps to test network access configuration on a dev store.

    Original source
  • Oct 31, 2026
    • Date parsed from source:
      Oct 31, 2026
    • First seen by Releasebot:
      Nov 3, 2026
    Shopify logo

    Shopify Developers by Shopify

    currententrychange now returns the previous page in event.from for customer account full-page extensions

    Shopify Developers documents a breaking Navigation API change for customer account full-page extensions in API version 2027-01: event.from will refer to the previous page. Extensions should use shopify.navigation.currentEntry to read the newly navigated page.

    Starting in API version 2027-01, in customer account full-page extensions the Navigation API currententrychange event sets event.from to the page the customer navigated away from, instead of the page they navigated to. This is a breaking change for customer account full-page extensions that read the new page from event.from. Update them to read shopify.navigation.currentEntry before you move them to 2027-01.

    What changed

    In customer account full-page extensions (customer-account.page.render and customer-account.order.page.render), currententrychange passes a NavigationCurrentEntryChangeEvent whose from property is documented as the previous history entry. In API version 2026-10 and earlier, from is the new entry instead, the same value as shopify.navigation.currentEntry. Starting in 2027-01, from is the previous entry.

    Who's affected

    Full-page extensions on API version 2027-01 or later that use event.from to find the page the customer navigated to are affected.

    Extensions on 2026-10 and earlier aren't affected, because their behavior doesn't change. Extensions that read shopify.navigation.currentEntry, including extensions that use the useNavigationCurrentEntry hook, aren't affected on any version.

    Breaking changes and migrations

    On 2027-01, code that reads the new page from event.from.url gets the previous page's URL instead. For example, an extension that chooses which route to render from event.from keeps showing the previous route after each navigation.

    Replace those reads with shopify.navigation.currentEntry.url.

    Before:

    shopify.navigation.addEventListener('currententrychange', (event) => {
      setPath(new URL(event.from.url).pathname);
    });
    

    After:

    shopify.navigation.addEventListener('currententrychange', () => {
      setPath(new URL(shopify.navigation.currentEntry.url).pathname);
    });
    

    The updated code works on API version 2025-10 and later, so you can make the change before you update your API version.

    Action required

    Before you update a customer account full-page extension to 2027-01, update every currententrychange handler that reads the new page from event.from. To confirm the update, navigate between two routes in your extension and check that each navigation shows the page you navigated to.

    Related docs

    Navigation API reference for customer account UI extensions

    Original source
  • Oct 30, 2026
    • Date parsed from source:
      Oct 30, 2026
    • First seen by Releasebot:
      Nov 3, 2026
    Shopify logo

    Shopify Developers by Shopify

    UI extensions now support a larger number of locales

    Shopify Developers removes the 256 KB combined locale-file limit for UI extensions, letting apps deploy more languages without trimming translations. The 30 KB per-file limit remains, and no action is required for existing apps.

    UI extensions no longer have a 256 KB limit on the combined size of their locale files. As of October 30, 2026, you can add more languages to an extension without hitting a combined size limit at deploy. This applies to all apps with UI extensions, and no action is required.

    What changed

    Previously, the total size of the locale files in a UI extension's locales folder couldn't exceed 256 KB. Extensions with many languages could reach that limit and fail to deploy, which forced you to trim translations or drop languages.

    That combined limit is now removed. The 30 KB limit for each individual locale file still applies. Locale files keep the same format, file naming, and fallback behavior described in the checkout UI extension localization guide. You don't need to change how you structure translations.

    Who's affected

    This change applies to every app that includes UI extensions with locale files, on all API versions. Existing extension versions keep working as before. New deploys aren't limited by the combined size of locale files.

    If your extensions were under the old limit, nothing changes for you.

    What to do

    You don't need to take any action. If you previously removed languages or shortened translations to stay under 256 KB, you can add them back:

    • Add the locale files you need to your extension's locales folder, for example de.json or pt-BR.json. Keep each file under 30 KB.
    • Run shopify app deploy to release a new app version.
    • Preview the extension in a development store with the store or customer locale set to one of the new languages, and confirm the translated strings appear.

    Related docs

    • Localize a checkout UI extension
    • Localize a customer account UI extension
    Original source
  • Oct 30, 2026
    • Date parsed from source:
      Oct 30, 2026
    • First seen by Releasebot:
      Nov 3, 2026
    Shopify logo

    Shopify Developers by Shopify

    Gift Card line_item_id will become read-only in REST Admin API version 2027-01

    Shopify Developers notes that REST Admin API 2027-01 makes Gift Card line_item_id read-only, ignoring it in create and update requests while preserving existing associations. Apps must stop sending the field before upgrading.

    In REST Admin API version 2027-01 and later, the line_item_id property on the Gift Card resource is read-only. Shopify ignores the property in create and update requests. Remove it from those requests before you upgrade.

    What changed

    In REST Admin API version 2027-01 and later, apps can't add, replace, or clear a gift card's line-item association through Gift Card create or update requests. Shopify ignores any line_item_id value in those requests.

    Gift Card responses still include existing line-item and order associations. Earlier API versions keep their current behavior.

    Who's affected

    This change affects you if all of the following are true:

    • Your app uses the REST Admin API Gift Card resource.
    • Your app includes line_item_id when it creates or updates gift cards.
    • You plan to upgrade your app to API version 2027-01 or later.

    If your app only reads line_item_id from Gift Card responses, or stays on an API version earlier than 2027-01, then this change doesn't affect you.

    Why this matters

    A gift card's line-item association records the order line item that created the gift card. Making line_item_id read-only stops apps from changing the link between a gift card and its order.

    Breaking changes and migrations

    In REST Admin API version 2027-01 and later, Shopify accepts create and update requests that include line_item_id and ignores the property. The gift card keeps its existing line-item association.

    Before you upgrade to API version 2027-01:

    • Find the REST Gift Card create and update calls that send line_item_id.
    • Remove line_item_id from those request payloads.
    • If your app needs the existing association, then keep reading line_item_id from Gift Card responses.

    There isn't a replacement API for adding, replacing, or clearing a gift card's line-item association from outside Shopify.

    To confirm the migration:

    • Send a create or update request without line_item_id.
    • Read the same gift card, and check that its line_item_id value didn't change.

    Action required

    Before you move production traffic to REST Admin API version 2027-01 or later, stop sending line_item_id in Gift Card create and update requests. Otherwise, your app's records might not match Shopify's, because Shopify keeps the original association.

    Related docs

    • REST Admin API Gift Card resource for 2027-01
    • Shopify API versioning
    Original source
  • Oct 30, 2026
    • Date parsed from source:
      Oct 30, 2026
    • First seen by Releasebot:
      Nov 3, 2026
    Shopify logo

    Shopify Developers by Shopify

    New trusted vault origin signal in Payments Apps API

    Shopify Developers adds an optional trusted-vault signal in the Payments Apps API 2027-01 release candidate, helping payment apps handle missing CVV on trusted-vault cards while preserving existing checks when the signal is absent or false.

    The Payments Apps API 2027-01 release candidate adds payment_method.data.trusted_vault_origin to credit card payment and verification requests. Payment app developers can use this optional Boolean to handle missing CVV for cards from a vault Shopify trusts. Adoption is optional and requires Shopify enablement.

    What changed

    Shopify can include trusted_vault_origin in both encrypted card and payment_instrument payloads. Read it from payment_method.data, outside the encrypted card details or payment_instrument object.

    • true: Don't reject the payment or verification for missing CVV alone. A CVV may still be present.
    • false or absent: Keep your existing CVV rules for that flow, including flows that accept payments without CVV.

    Continue your fraud checks, 3-D Secure authentication, and validation of any CVV provided. The signal does not identify the originating vault. See the trusted vault origin reference for the field contract and payload examples.

    Who's affected

    This applies to payments apps that handle requests with payment_method.type set to credit_card. Your extension must use API version 2027-01 or later, and Shopify must enable the field for your app. Changing the API version does not enable it.

    Shopify omits the field on earlier API versions, when it has not enabled the field for your app, or when it has no value to send.

    What to do

    No immediate production migration is required. Use the 2027-01 release candidate for testing and keep production apps on a supported stable version.

    To prepare your integration:

    • Review your payment and verification handlers. Add support for the optional field and the CVV handling described above.
    • For integration testing, set your development extension's api_version to 2027-01. Confirm Shopify has enabled the field for your app before expecting Shopify to send it.
    • Test true, false, and an absent field, with and without CVV. Cover each payload format your app supports and repeat the cases for verification requests if applicable. Confirm that missing CVV does not cause rejection for true, while false and absence preserve your existing handling.

    Related docs

    • Configure payments extensions
    • Test credit card payment requests
    • Shopify API versioning
    Original source
  • October 2026
    • No date parsed from source.
    • First seen by Releasebot:
      Oct 30, 2026
    Shopify logo

    Shopify Developers by Shopify

    Exponential

    Shopify Developers highlights new updates for non-linear growth.

    Everything new for non-linear growth

    Original source
  • Oct 29, 2026
    • Date parsed from source:
      Oct 29, 2026
    • First seen by Releasebot:
      Nov 6, 2026
    Shopify logo

    Shopify Developers by Shopify

    FulfillmentOrderDestination now includes provinceCode

    Shopify Developers adds a provinceCode field to the FulfillmentOrderDestination object in GraphQL Admin API 2027-01, letting apps read a destination’s province or state code directly without mapping its name.

    As of GraphQL Admin API version 2027-01, the FulfillmentOrderDestination object has a provinceCode field. It returns the alphanumeric code of the destination's province or state, such as ON for Ontario, so apps can read the code directly instead of mapping the province name themselves.

    What changed

    • FulfillmentOrderDestination.provinceCode returns the province code as a String, alongside the existing province and countryCode fields.
    • The field returns null if the destination has no province, or if the province isn't recognized for the destination's country.
    • The field has the same access requirements as the rest of FulfillmentOrderDestination. No new access scopes are needed.

    Related docs

    • FulfillmentOrderDestination reference
    Original source
  • Oct 28, 2026
    • Date parsed from source:
      Oct 28, 2026
    • First seen by Releasebot:
      Oct 30, 2026
    Shopify logo

    Shopify Developers by Shopify

    Shop SDK lead capture now supports Rich Authorization Requests

    Shopify Developers now support Rich Authorization Requests in Shop SDK lead capture, letting apps request specific profile fields as required or optional. The update also details consent-token handling, server-side data retrieval, and testing for authorization outcomes.

    You can now request the specific profile data your app needs during Shop SDK lead capture, including details that aren't saved on the user's Shop profile. Use Rich Authorization Requests (RAR) to select which fields are required and which ones users can skip. Existing integrations don't need changes to continue working; RAR is opt-in.

    What changed

    Lead capture now accepts an authorizationDetails attribute. The attribute takes a serialized JSON array that lists the fields your app needs and marks each one as required or optional. For example, this request requires a phone number and makes birthdate optional:

    const authorizationDetails = JSON.stringify([
      {
        type: 'urn:shopify:shop_app:data-sharing:v1',
        datatypes: [
          { name: 'phone_number', required: true },
          { name: 'birthdate', required: false },
        ],
      },
    ]);
    

    You can request given name, family name, phone number, and birthdate with RAR. The existing OAuth scopes shop_app:user:profile and shop_app:user:phone let you request existing names and phone numbers, respectively, but don't prompt users to provide missing values.

    Before a user authorizes your app, Shop asks them for any requested fields that they haven't shared with your app. Users must provide values for required fields and can skip optional ones. If a user declines to authorize your app, then onComplete doesn't include a shopConsentToken, even if the user signs in to the store. Handle a missing shopConsentToken as an expected outcome.

    Who's affected

    This change applies to apps that use Shop SDK lead capture. To read data that you request with RAR, your app needs a client secret and a trusted server.

    As with existing lead capture, an authorized phone number returned by Shop can replace a different phone number on the store's customer record. Existing names aren't replaced.

    What to do

    To request data with RAR:

    • Pass your serialized array as attributes.authorizationDetails when you create the lead capture instance. To also request the user's identifier and email, set attributes.scope to 'shop_app:oauth', as shown in the guide.
    • In onComplete, send shopConsentToken to your server when the event includes one. The event doesn't include the requested data. If the event includes customerUpdateErrors, then the update to the store's customer record failed.
    • From your server, exchange the consent token with the fetchTokensForUser mutation on the Shop Partners API. Read the authorized fields from the response or from the Shop Users API, and handle null for fields that weren't granted or have no value.
    • Before you ship, test a completed authorization, a skipped optional field, a declined authorization, and a request with malformed authorizationDetails JSON that returns invalid_authorization_details in onError. For the request format and error handling, see the lead capture guide.

    Related docs

    • Lead capture
    • Get Shop user information
    Original source
Releasebot

Curated by the Releasebot team

Releasebot is an aggregator of official product update announcements from hundreds of software vendors and thousands of sources.

Our editorial process involves the manual review and audit of release notes procured with the help of automated systems.