publishablePublish

Publishes a resource, such as a Product or Collection, to one or more publications. For products to be visible in a channel, they must have an active ProductStatus.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the publishablePublish action (under Publishable).
Fill in the fields below, then reference the result from later steps as {{publishablepublish.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 PublishablePublish($id: ID!, $input: [PublicationInput!]!) {
  publishablePublish(id: $id, input: $input) {
    publishable {
      availablePublicationsCount {
        count
        precision
      }
      publishedOnCurrentChannel
      publishedOnCurrentPublication
    }
    shop {
      accountOwner {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      alerts {
        action
        description
      }
      allProductCategories {
        productTaxonomyNode
      }
      allProductCategoriesList {
        ancestorIds
        childrenIds
        fullName
        id
        isArchived
        isLeaf
        isRoot
        level
        name
        parentId
      }
      analyticsToken
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        zip
      }
      channelDefinitionsForInstalledChannels {
        channelDefinitions
        channelName
      }
      checkoutApiSupported
      contactEmail
      countriesInShippingZones {
        countryCodes
        includeRestOfWorld
      }
      createdAt
      currencyCode
      currencyFormats {
        moneyFormat
        moneyInEmailsFormat
        moneyWithCurrencyFormat
        moneyWithCurrencyInEmailsFormat
      }
      customerAccounts
      customerAccountsV2 {
        customerAccountsVersion
        loginLinksVisibleOnStorefrontAndCheckout
        loginRequiredAtCheckout
        url
      }
      description
      domains {
        host
        id
        localization
        marketWebPresence
        sslEnabled
        url
      }
      email
      enabledPresentmentCurrencies
      entitlements {
        b2b
        markets
      }
      features {
        avalaraAvatax
        branding
        bundles
        buyerExperienceDepositEnabled
        captcha
        captchaExternalDomains
        cartTransform
        deliveryProfiles
        directConnectionCatalogAssignmentEnabled
        dynamicRemarketing
        eligibleForSubscriptionMigration
        eligibleForSubscriptions
        giftCards
        harmonizedSystemCode
        internationalDomains
        internationalPriceOverrides
        internationalPriceRules
        legacySubscriptionGatewayEnabled
        liveView
        marketDrivenShipping
        onboardingVisual
        paypalExpressSubscriptionGatewayStatus
        reports
        sellsSubscriptions
        shopifyPlus
        showMetrics
        storefront
        subCountryMarketsEnabled
        unifiedMarkets
        usingShopifyBalance
      }
      fulfillmentServices {
        callbackUrl
        fulfillmentOrdersOptIn
        handle
        id
        inventoryManagement
        location
        requiresShippingMethod
        serviceName
        trackingSupport
        type
      }
      ianaTimezone
      id
      limitedPendingOrderCount {
        atMax
        count
      }
      marketingSmsConsentEnabledAtCheckout
      merchantApprovalSignals {
        identityVerified
        verifiedByShopify
        verifiedByShopifyTier
      }
      myshopifyDomain
      name
      navigationSettings {
        id
        title
        url
      }
      orderNumberFormatPrefix
      orderNumberFormatSuffix
      paymentSettings {
        supportedDigitalWallets
      }
      plan {
        displayName
        partnerDevelopment
        publicDisplayName
        shopifyPlus
      }
      primaryDomain {
        host
        id
        localization
        marketWebPresence
        sslEnabled
        url
      }
      publicationCount
      resourceLimits {
        locationLimit
        maxProductOptions
        maxProductVariants
        redirectLimitReached
      }
      richTextEditorUrl
      searchFilters {
        productAvailability
      }
      setupRequired
      shipsToCountries
      shopAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        zip
      }
      shopOwnerName
      shopPolicies {
        body
        createdAt
        id
        title
        type
        updatedAt
        url
      }
      storefrontUrl
      taxShipping
      taxesIncluded
      timezoneAbbreviation
      timezoneOffset
      timezoneOffsetMinutes
      transactionalSmsDisabled
      unitSystem
      updatedAt
      url
      weightUnit
    }
    userErrors {
      field
      message
    }
  }
}

Variables

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

idstringrequired

The resource to create or update publications for.

inputarray<object>required

Specifies the input fields required to publish a resource.

channelIdstring

publicationIdstring

publishDatestring

json

{
  "id": "string",
  "input": [
    {
      "channelId": "string",
      "publicationId": "string",
      "publishDate": "string"
    }
  ]
}

Response

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

publishableobject

availablePublicationsCountobject2 fields

publishedOnCurrentChannelboolean

publishedOnCurrentPublicationboolean

shopobject

accountOwnerobject13 fields

alertsarray<object>

allProductCategoriesarray<object>

allProductCategoriesListarray<object>

analyticsTokenstring

billingAddressobject19 fields

channelDefinitionsForInstalledChannelsarray<object>

checkoutApiSupportedboolean

contactEmailstring

countriesInShippingZonesobject2 fields

createdAtstring

currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

currencyFormatsobject4 fields

customerAccountsstring

One ofREQUIREDOPTIONALDISABLED

customerAccountsV2object4 fields

descriptionstring

domainsarray<object>

emailstring

enabledPresentmentCurrenciesarray<object>

entitlementsobject2 fields

featuresobject30 fields

fulfillmentServicesarray<object>

ianaTimezonestring

idstring

limitedPendingOrderCountobject2 fields

marketingSmsConsentEnabledAtCheckoutboolean

merchantApprovalSignalsobject3 fields

myshopifyDomainstring

namestring

navigationSettingsarray<object>

orderNumberFormatPrefixstring

orderNumberFormatSuffixstring

paymentSettingsobject1 fields

planobject4 fields

primaryDomainobject6 fields

publicationCountnumber

resourceLimitsobject4 fields

richTextEditorUrlstring

searchFiltersobject1 fields

setupRequiredboolean

userErrorsarray<object>

fieldobject

messageobject

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

Was this page helpful?