CollectionPublishPayload

Version 2019-04

Return type for collectionPublish mutation.

Show definition
"""
Return type for `collectionPublish` mutation.
"""
type CollectionPublishPayload {
  """
  The published collection.
  """
  collection: Collection
  """
  The channels where the collection has been published.
  """
  collectionPublications: [CollectionPublication!]
  """
  The shop associated with the collection.
  """
  shop: Shop!
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The published collection.

collectionPublications ([CollectionPublication!])

The channels where the collection has been published.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Return type for collectionPublish mutation.

Show definition
"""
Return type for `collectionPublish` mutation.
"""
type CollectionPublishPayload {
  """
  The published collection.
  """
  collection: Collection
  """
  The channels where the collection has been published.
  """
  collectionPublications: [CollectionPublication!]
  """
  The shop associated with the collection.
  """
  shop: Shop!
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The published collection.

collectionPublications ([CollectionPublication!])

The channels where the collection has been published.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Return type for collectionPublish mutation.

Show definition
"""
Return type for `collectionPublish` mutation.
"""
type CollectionPublishPayload {
  """
  The published collection.
  """
  collection: Collection
  """
  The channels where the collection has been published.
  """
  collectionPublications: [CollectionPublication!]
  """
  The shop associated with the collection.
  """
  shop: Shop!
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The published collection.

collectionPublications ([CollectionPublication!])

The channels where the collection has been published.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up