publications

Returns a paginated list of Publication. Filter publications by CatalogType.

Use it in a workflow

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

Query

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

graphql

query Publications($catalogType: CatalogType, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  publications(
    catalogType: $catalogType
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        app
        autoPublish
        catalog
        id
        name
        operation
        supportsFuturePublishing
      }
    }
    nodes {
      app {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      autoPublish
      catalog {
        id
        operations
        priceList
        publication
        status
        title
      }
      id
      name
      operation
      supportsFuturePublishing
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

catalogTypestring

Filter publications by catalog type.

One ofNONEAPPCOMPANY_LOCATIONMARKET

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "catalogType": "NONE",
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

appobject

autoPublishobject

catalogobject

idobject

nameobject

operationobject

supportsFuturePublishingobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?