publication

Retrieves a Publication by ID. Returns null if the publication doesn't exist.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the publication action (under Publication).
Fill in the fields below, then reference the result from later steps as {{publication.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 Publication($id: ID!) {
  publication(id: $id) {
    app {
      apiKey
      appStoreAppUrl
      appStoreDeveloperUrl
      availableAccessScopes {
        description
        handle
      }
      banner {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      description
      developerName
      developerType
      developerUrl
      embedded
      failedRequirements {
        action
        message
      }
      features
      feedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      handle
      icon {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      id
      installUrl
      installation {
        accessScopes
        activeSubscriptions
        app
        channel
        id
        launchUrl
        publication
        subscriptions
        uninstallUrl
      }
      isPostPurchaseAppInUse
      launchUrl
      navigationItems {
        id
        title
        url
      }
      optionalAccessScopes {
        description
        handle
      }
      previouslyInstalled
      pricingDetails
      pricingDetailsSummary
      privacyPolicyUrl
      publicCategory
      published
      requestedAccessScopes {
        description
        handle
      }
      screenshots {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      shopifyDeveloped
      title
      uninstallMessage
      uninstallUrl
      webhookApiVersion
    }
    autoPublish
    catalog {
      id
      operations {
        id
        processedRowCount
        rowCount
        status
      }
      priceList {
        catalog
        currency
        fixedPricesCount
        id
        name
        parent
      }
      publication
      status
      title
    }
    id
    name
    operation
    supportsFuturePublishing
  }
}

Variables

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

idstringrequired

The ID of the Publication to return.

json

{
  "id": "string"
}

Response

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

appobject

apiKeystring

appStoreAppUrlstring

appStoreDeveloperUrlstring

availableAccessScopesarray<object>

bannerobject7 fields

descriptionstring

developerNamestring

developerTypestring

One ofSHOPIFYPARTNERMERCHANTUNKNOWN

developerUrlstring

embeddedboolean

failedRequirementsarray<object>

featuresarray<object>

feedbackobject6 fields

handlestring

iconobject7 fields

idstring

installUrlstring

installationobject9 fields

isPostPurchaseAppInUseboolean

launchUrlstring

navigationItemsarray<object>

optionalAccessScopesarray<object>

previouslyInstalledboolean

pricingDetailsstring

pricingDetailsSummarystring

privacyPolicyUrlstring

publicCategorystring

One ofPRIVATEPUBLICCUSTOMOTHER

publishedboolean

requestedAccessScopesarray<object>

screenshotsarray<object>

shopifyDevelopedboolean

titlestring

uninstallMessagestring

uninstallUrlstring

webhookApiVersionstring

autoPublishboolean

catalogobject

idstring

operationsarray<object>

priceListobject6 fields

publicationobject

Recursive reference to Publication, not further expanded.

statusstring

One ofACTIVEARCHIVEDDRAFT

titlestring

idstring

namestring

operationobject

This field can return one of several different object shapes — properties from every possible shape are shown together.

idstring

processedRowCountnumber

rowCountobject2 fields

statusstring

One ofCREATEDACTIVECOMPLETE

supportsFuturePublishingboolean

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

Was this page helpful?