catalog

Retrieves a catalog by its ID. A catalog represents a list of products with publishing and pricing information, and can be associated with a context, such as a market, company location, or app.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the catalog action (under Catalog).
Fill in the fields below, then reference the result from later steps as {{catalog.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 Catalog($id: ID!) {
  catalog(id: $id) {
    id
    operations {
      id
      processedRowCount
      rowCount {
        count
        exceedsMax
      }
      status
    }
    priceList {
      catalog
      currency
      fixedPricesCount
      id
      name
      parent {
        adjustment
        settings
      }
    }
    publication {
      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
      name
      operation
      supportsFuturePublishing
    }
    status
    title
  }
}

Variables

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

idstringrequired

The ID of the `Catalog` to return.

json

{
  "id": "string"
}

Response

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

idstring

operationsarray<object>

idobject

processedRowCountobject

rowCountobject

statusobject

priceListobject

catalogobject

Recursive reference to Catalog, not further expanded.

currencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

fixedPricesCountnumber

idstring

namestring

parentobject2 fields

publicationobject

appobject35 fields

autoPublishboolean

catalogobject

Recursive reference to Catalog, not further expanded.

idstring

namestring

operationobject4 fields

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

supportsFuturePublishingboolean

statusstring

One ofACTIVEARCHIVEDDRAFT

titlestring

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

Was this page helpful?