Publication
A group of products and collections that are published to an app.
Each publication manages which products and collections display on its associated Channel. Merchants can automatically publish products when they're created if is enabled, or manually control publication through publication records.
Publications support scheduled publishing through future publish dates for online store channels, allowing merchants to coordinate product launches and promotional campaigns. The catalog field links to pricing and availability rules specific to that publication's context.
Anchor to FieldsFields
- autoPublish (Boolean!)
- catalog (Catalog)
- collectionPublicationsV3 (ResourcePublicationConnection!)
- collections (CollectionConnection!)
- hasCollection (Boolean!)
- id (ID!)
- includedProducts (ProductConnection!)
- operation (PublicationOperation)
- productPublicationsV3 (ResourcePublicationConnection!)
- products (ProductConnection!)
- supportsFuturePublishing (Boolean!)
- Anchor to autoPublishauto•Boolean!
Publish non-null Whether new products are automatically published to this publication.
- Anchor to catalogcatalog•Catalog
The catalog associated with the publication.
- Anchor to collectionPublicationsV3collection•Resource
Publications V3 Publication Connection! non-null The list of collection publication records, each representing the publication status and details for a collection published to this publication (typically channel).
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to collectionscollections•Collection
Connection! non-null The list of collections published to the publication.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to hasCollectionhas•Boolean!
Collection non-null Whether the collection is available to the publication.
- •ID!required
Collection ID to check.
Arguments
- •ID!
- •ID!non-null
A globally-unique ID.
- Anchor to includedProductsincluded•Product
Products Connection! non-null The list of products included, but not necessarily published, in the publication.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to operationoperation•Publication
Operation A background operation associated with this publication.
- Anchor to productPublicationsV3product•Resource
Publications V3 Publication Connection! non-null The product publications for the list of products published to the publication.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to productsproducts•Product
Connection! non-null The list of products published to the publication.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to supportsFuturePublishingsupports•Boolean!
Future Publishing non-null Whether the publication supports future publishing.
Deprecated fields
- app (App!): deprecated
- name (String!): deprecated
- •App!non-nullDeprecated
- Anchor to namename•String!non-nullDeprecated
Anchor to QueriesQueries
- publication (Publication)
- publications (PublicationConnection!)
- •query
Retrieves a
Publicationby.Returns
nullif the publication doesn't exist.- •ID!required
The ID of the Publication to return.
Arguments
- •ID!
- •query
Returns a paginated list of
Publication.- Anchor to catalogTypecatalog•Catalog
Type Type Filter publications by catalog type.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
Anchor to MutationsMutations
- publicationCreate (PublicationCreatePayload)
- publicationUpdate (PublicationUpdatePayload)
- •mutation
Creates a
Publicationthat controls whichProductandCollectioncustomers can access through aCatalog.When to create a publication
Publications are optional for catalogs. Only create a publication if you need to control which products are visible in a specific catalog context. When a publication isn't associated with a catalog, product availability is determined by the sales channel.
Create a publication if you need to:
- Restrict product visibility to a subset of your inventory for a specific market or company location
- Publish different product selections to different contexts
Do NOT create a publication if:
- You want product availability determined by the sales channel
- You only need custom pricing (use a price list on the catalog instead)
Configuration options
You can create an empty publication and add products later, or prepopulate it with all existing products. The
field determines whether the publication automatically adds newly created products.- Anchor to inputinput•Publication
Create Input! required The input fields to use when creating the publication.
Arguments
- •mutation
Updates a
Publication.You can add or remove products from the publication, with a maximum of 50 items per operation. The
field determines whether new products automatically display in this publication.- •ID!required
The ID of the publication to update.
- Anchor to inputinput•Publication
Update Input! required The input fields to use when updating the publication.
Arguments
- •ID!