collectionCreate

Creates a collection to group products together in the online store and other sales channels.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the collectionCreate action (under Collection).
Fill in the fields below, then reference the result from later steps as {{collectioncreate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CollectionCreate($input: CollectionInput, $collection: CollectionCreateInput) {
  collectionCreate(input: $input, collection: $collection) {
    collection {
      activeOperations {
        duplicate
      }
      availablePublicationsCount {
        count
        precision
      }
      descriptionHtml
      feedback {
        appFeedback
        details
        summary
      }
      handle
      id
      legacyResourceId
      productsCount {
        count
        precision
      }
      publishedOnCurrentChannel
      publishedOnCurrentPublication
      ruleSet {
        appliedDisjunctively
        rules
      }
      seo {
        description
        title
      }
      sortOrder
      sources {
        app
        description
        id
        title
      }
      storefrontId
      subCollectionEligibility {
        exclusion
        inclusion
      }
      templateSuffix
      title
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

inputobject

The properties to use when creating the collection. Deprecated in favor of `collection`, which defines membership with `sources` instead of the legacy `ruleSet`.

descriptionHtmlstring

handlestring

idstring

imageobject3 fields

productsarray<string>

publicationsarray<object>3 fields

ruleSetobject2 fields

templateSuffixstring

sortOrderstring

One ofALPHA_ASCALPHA_DESCBEST_SELLINGMOST_RELEVANTCREATEDCREATED_DESCMANUALPRICE_ASCPRICE_DESC

titlestring

metafieldsarray<object>5 fields

seoobject2 fields

redirectNewHandleboolean

collectionobject

The properties and sources to use when creating the collection. Define product membership with `sources` (conditions and manual selections) instead of the legacy `ruleSet`.

descriptionHtmlstring

handlestring

imageobject3 fields

templateSuffixstring

sortOrderstring

One ofALPHA_ASCALPHA_DESCBEST_SELLINGMOST_RELEVANTCREATEDCREATED_DESCMANUALPRICE_ASCPRICE_DESC

titlestringrequired

metafieldsarray<object>5 fields

seoobject2 fields

sourcesarray<object>3 fields

json

{
  "input": {
    "descriptionHtml": "string",
    "handle": "string",
    "id": "string",
    "image": {
      "id": "string",
      "altText": "string",
      "src": "string"
    },
    "products": [
      "string"
    ],
    "publications": [
      {
        "publicationId": "string",
        "channelId": "string",
        "channelHandle": "string"
      }
    ],
    "ruleSet": {
      "appliedDisjunctively": false,
      "rules": [
        "string"
      ]
    },
    "templateSuffix": "string",
    "sortOrder": "ALPHA_ASC",
    "title": "string",
    "metafields": [
      {
        "id": "string",
        "namespace": "string",
        "key": "string",
        "value": "string",
        "type": "string"
      }
    ],
    "seo": {
      "title": "string",
      "description": "string"
    }
  },
  "collection": {
    "title": "string",
    "descriptionHtml": "string",
    "handle": "string",
    "image": {
      "id": "string",
      "altText": "string",
      "src": "string"
    },
    "templateSuffix": "string",
    "sortOrder": "ALPHA_ASC",
    "metafields": [
      {
        "id": "string",
        "namespace": "string",
        "key": "string",
        "value": "string",
        "type": "string"
      }
    ],
    "seo": {
      "title": "string",
      "description": "string"
    },
    "sources": [
      {
        "source": "string",
        "subCollections": "string",
        "shareableSource": "string"
      }
    ]
  }
}

Response

Read the result with {{collectioncreate.response.data.data.collectionCreate}}. If the API returns errors, the step fails and they are at {{collectioncreate.response.data.errors}}.

collectionobject

activeOperationsobject1 fields

availablePublicationsCountobject2 fields

descriptionHtmlstring

feedbackobject3 fields

handlestring

idstring

legacyResourceIdstring

productsCountobject2 fields

publishedOnCurrentChannelboolean

publishedOnCurrentPublicationboolean

ruleSetobject2 fields

seoobject2 fields

sortOrderstring

One ofALPHA_ASCALPHA_DESCBEST_SELLINGMOST_RELEVANTCREATEDCREATED_DESCMANUALPRICE_ASCPRICE_DESC

sourcesarray<object>

storefrontIdstring

subCollectionEligibilityobject2 fields

templateSuffixstring

titlestring

updatedAtstring

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?