CollectionUpdatePayload

Version 2019-04

Return type for collectionUpdate mutation.

Show definition
"""
Return type for `collectionUpdate` mutation.
"""
type CollectionUpdatePayload {
  """
  The updated collection.
  """
  collection: Collection
  """
  The asynchronous job updating the products based on the new rule set.
  """
  job: Job
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The updated collection.

job (Job)

The asynchronous job updating the products based on the new rule set.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Return type for collectionUpdate mutation.

Show definition
"""
Return type for `collectionUpdate` mutation.
"""
type CollectionUpdatePayload {
  """
  The updated collection.
  """
  collection: Collection
  """
  The asynchronous job updating the products based on the new rule set.
  """
  job: Job
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The updated collection.

job (Job)

The asynchronous job updating the products based on the new rule set.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Return type for collectionUpdate mutation.

Show definition
"""
Return type for `collectionUpdate` mutation.
"""
type CollectionUpdatePayload {
  """
  The updated collection.
  """
  collection: Collection
  """
  The asynchronous job updating the products based on the new rule set.
  """
  job: Job
  """
  List of errors that occurred executing the mutation.
  """
  userErrors: [UserError!]!
}

Fields

collection (Collection)

The updated collection.

job (Job)

The asynchronous job updating the products based on the new rule set.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up