what is the function of the 'published_scope' field?

Shopify Partner
10 0 0

Is there any more documentation about the "published_scope" field for custom collections? What is the field used for?

From: http://docs.shopify.com/api/customcollection

{ "published_scope" : "global"}

The sales channels in which the custom collection is visible.

Thank you!

Replies 7 (7)
Shopify Staff (Retired)
130 0 19

"global" means it will be visible everywhere and "web" means it won't show up on Point of Sale.

New Member
1 0 1


What about the other way around -  if you want a product to appear on POS, but not on web?




Shopify Staff (Retired)
623 104 160

Hi @laura44 ,


If you are a merchant/store-owner you can set this through the Shopify Admin webpage by going opening the page for your specific product, and then on the right side of the screen clicking the "Manage" link next to Product Availability to select which channels you want your product to be published on.


However if you are building an app and want to accomplish this via the API and not use the web admin, this is only possible through GraphQL using the following resources:

In order to perform these mutations, your app will need the scope "write_publications". As of right now, we are only granting this scope to Private Apps. If you would like your Private App to have this scope, go to your Shopify Partners Dashboard and reach out to 'Partner Support' for more details.

Hassain | Developer Support Specialist @ Shopify
 - Was my reply helpful? Click Like to let me know! 
 - Was your question answered? Click Accept as Solution 

New Member
2 0 0

I have a product with published_scope" as "global", but the published_at date for this product is null. Any reason behind such a behavior?

3 0 1


I want to set the sales channel in the import product sheet. So I got 'global' and 'web' covered. But what about POS-only? As said, this is something I want to set in the sheet which I import (not for each of my 1500 products in the Admin console). 

Best regards,

Shopify Partner
373 67 164

I have the same issue, I need an option to set published_scope to "pos only"

Peanut Butter Collective | Shopify Experts
- Was my reply helpful? Please Like and Accept Solution.
- Want to customize and improve your store? Hire us.
- Feel free to contact me us hello@peanutbutter.es
3 0 6