Sales Channels & Apps Restrictions?

[bahamagician]

Previously, only products marked for inclusion in a particular Sales Channel or App was included in the products returned from the shopify api. However, now I'm getting all of the products in the store regardless of whether they're meant to be included in the App that I've used to set up the API key. Is there a way to exclude those products from the results returned?

[sslotsky]

Thanks for the issue. I'm not familiar with the concept of sales channels. Looking at the Admin API docs, it's possible to filter orders by sales channel, but I don't see any indication that other object types can be filtered this way. Do you happen to know where I can learn more about how sales channels work?

[div-cowboy]

@sslotsky Sales Channels are how Shopify controls what products show up on the Online Store, Shopify POS, Social Media (ads), and any Private App integrations (like this plugin). You can set availability on any product/collection, screenshots attached, and more insight here

Screenshots

If I'm not mistaken, I believe that @bahamagician is pulling products that are not available on his Private App integration

[sslotsky]

Thanks for the info @iamkratos that was really helpful. It looks like the Admin API makes this available through publication data, but that data is only available for limited access scopes:

read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

We'll have to think on how to do this correctly. It will almost certainly involve opting in via pluginOptions. At that point we could either add an operation to fetch publication data and link the publications to the product nodes, or we could figure out how to incorporate publichedOnCurrentPublication into the products query. https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/publishable

[bahamagician]

Hey,

@iamkratos is correct. Products not marked for inclusion in a particular sales channel are being included in the results pulled.
See the screenshots below which indicate where the feature is in the Shopify admin.

[lamellama]

This is causing problems adding items to cart because they should not be visible on the store

[sslotsky]

While we're still working this out, can folks here who are experiencing the issue let me know if my previous comment looks like it would be helpful for you?

https://github.com/gatsbyjs/gatsby-source-shopify/issues/118#issuecomment-814900262

[lamellama]

publishedOnCurrentPublication (Boolean!)
Check to see whether the resource is published to the calling app's publication.

Sounds like what I'm expecting. I am surprised this is not the default and the API has access outside the channel

[sslotsky]

It's the admin API that we're using and I think the intention is that you can have an accurate reflection of what's really in the database. It makes sense why they would exclude these products from the Storefront API.

[sslotsky]

@lamellama follow up questions

1. In addition to supporting this field publishedOnCurrentPublication on both products and collections, is it also helpful to source the list of all publications?
2. We will have to support this optionally via pluginOptions, but if the answer to the above ☝🏼 is yes for at least some users, I'm wondering how many plugin options we need. Some folks might want the field without the list.

[sslotsky]

Here's what I'm thinking. We can add a new pluginOption called e.g. privilegedAccessScopes. If read_publications is included, then we will add publishedOnCurrentPublication to the product and collections queries.

Then if publication data is also desired, publications could be added to the shopifyConnections array in plugin options, which will only be considered valid if read_publications has been included in privilegedAccessScopes.

[sslotsky]

Actually I'm partly wrong about this! publishedOnCurrentPublication does not require privileged access. It does requre the read_product_listings permission, but that's not limited to Shopify Plus stores so we can simply document this requirement.

So this really only leaves the question of whether or not you also need publication data to be sourced as well. If that's not useful to anyone, we can skip it and ship the new field that will hopefully help you solve your problem.

[lamellama]

I have currently modified the plugin to add publishedOnCurrentPublication to product and collection queries and then filtered my createPages accordingly which achieves what I need.

This is the only functionality I need but I am wondering if there is a more efficient way to avoid querying the extra data althogether.

[sslotsky]

I am wondering if there is a more efficient way to avoid querying the extra data althogether.

Taking yet another look at the docs and I see one thing that could work. There is a filter key called publishable_status that you can feed to the products query. But so far I'm unable to find what the accepted values are for that filter or a description of what it does. If you find anything out here, by all means please let us know!

[sslotsky]

I've inquired about this with Shopify so hopefully we'll have an answer soon.

[div-cowboy]

@sslotsky Did some digging this weekend, and found this

Could this provide the logic we need to resolve this issue?

[waywardm]

When you create a private app to connect to Shopify such as 'Gatsby' that is then listed as an available sales channel. So it would make sense for the default to be online store with the option to have the 'Gatsby' Channel as the main preference. One problem with the shopify system is that when a new sales channel is created, all products are not enabled on that channel by default. So for a novice user, it would be best to have the default set to the online store but the ability to override with inputting your preferred sales channel in the config.

[div-cowboy]

@sslotsky No, we don't want the Online Store channel (the channel is typically used for product availability in a standard Shopify theme). When I create a new Private App in Shopify, it adds a new channel to all the product pages that shares the same name as the app. In the screenshots attached, I would want the channel to be the V8 (WMG)

[sslotsky]

Thanks y'all this is super duper helpful

[sslotsky]

Ok, I believe this is the solution being requested:

    const publishedStatus = this.pluginOptions.salesChannel
      ? encodeURIComponent(`${this.pluginOptions.salesChannel}=visible`)
      : `published`;

    const filters = [`status:active`, `published_status:${publishedStatus}`];

If you supply salesChannel via pluginOptions, you'll get published_status:<salesChannel>=visible. Otherwise, you'll get published_status:published which should default to the online store channel.

[div-cowboy]

@sslotsky looks slick 😎

[sslotsky]

One more question. Given the solution we've agreed on here, is it useful in any way to also include the following fields:

availablePublicationCount
publicationCount
publishedOnCurrentPublication

We can add them if they are useful, but there's some cost because they all require certain permissions.

[div-cowboy]

@sslotsky I don't think we need them. I never used these on the previous gatsby-source-shopify, and I'm not sure how I could make use of them in my builds.

[sslotsky]

Published in the newest @rc

[div-cowboy]

@sslotsky unfortunately, I think we have to re-open this. Although Shopify displays the Private App integration as a Sales Channel, it doesn't consider it one in the API. I've tried configuring my store use the new method but it wouldn't work.

[waywardm]

I tried the other day too stating a salesChannel and it didn’t filter them out. Regards Paul Kidd Thunderfix

…

________________________________ From: iamkratos ***@***.***> Sent: Tuesday, May 11, 2021 4:00:53 PM To: gatsbyjs/gatsby-source-shopify ***@***.***> Cc: Thunderfix ***@***.***>; Comment ***@***.***> Subject: Re: [gatsbyjs/gatsby-source-shopify] Sales Channels & Apps Restrictions? (#118) @sslotsky<https://github.com/sslotsky> unfortunately, I think we have to re-open this. Although Shopify displays the Private App integration as a Sales Channel, it doesn't consider it one in the API. I've tried configuring my store use the new method but it wouldn't work. — You are receiving this because you commented. Reply to this email directly, view it on GitHub<https://github.com/gatsbyjs/gatsby-source-shopify/issues/118#issuecomment-838631577>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AC7LM6ROQNOQGBYVXFAWTSTTNFBCLANCNFSM42PFZ2OQ>.

[sslotsky]

Although Shopify displays the Private App integration as a Sales Channel, it doesn't consider it one in the API.

@iamkratos did you try that with their API directly? If it's true that their API does not consider the private app to be a sales channel, then I'm not sure how y'all want this to behave.

[waywardm]

maybe this is the reason

taken from

https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product#resourcepublications-2021-04

[lamellama]

seems sales channel scope is only for public apps: https://community.shopify.com/c/Shopify-APIs-SDKs/Private-App-as-a-sales-channel/td-p/418433

[fnebenfuehr]

Would be cool to get this working. I currently use a dirty graphql filter as workaround:

allShopifyProduct(
      filter: { onlineStoreUrl: {regex: "/https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)/"} }
      limit: 4
    ) {
  edges {
    node {
      id
      title
      }
    }
  }

[jackonawalk]

Here's a couple updates on sales channel support with gatsby-source-shopify

• Private apps are now able to function as a sales channel. This was a recent update from Shopify within the past couple weeks
• Gatsby Cloud is now available on Shopify's App Store which enables a "Gatsby Cloud" sales channel (no more private app configuration needed!). This works for new sites on Gatsby Cloud.

[div-cowboy]

@jacksellwood Thanks for looking into this Jack. I just updated all my plugins, and have tried:

• Sourcing products without a sales channel in my config (it's still pulling products that are only available on POS, not the Online Store channel)
• Adding sales channel as both regular case, and camel case to my gatsby config, but it's still not pulling the right product set (still pulling everything that is Active on any sales channel)

I'm trying the Gastby Cloud public app now, but I thought I'd mention these ^

[fnebenfuehr]

I can confirm. Having the same issue. Any updates on this?

[fnebenfuehr]

It turns out using the name of the sales channel doesn't work. Using the ID of the sales channel seems to work. #32674 (comment)

The ID of the sales channel is displayed in the URL when filtering orders for sales channel (https://community.shopify.com/c/shopify-apis-and-sdks/how-to-get-id-for-my-shopify-app/m-p/527761/highlight/true#M34613)

[div-cowboy]

@jacksellwood has there been any progress on this issue? Gatsby does not update the products on my site when I update my product sales channel (it should remove the product, but the cached pdp page is still there)