Skip to main content
Anchor to Catalog

Catalog

interface

Requires products or product_listings read access scope. The user must have permission to view markets or customers or companies.

A list of products with publishing and pricing information. A catalog can be associated with a specific context, such as a Market, CompanyLocation, or App.

Catalogs can optionally include a publication to control product visibility and a price list to customize pricing. When a publication isn't associated with a catalog, product availability is determined by the sales channel.

Anchor to FieldsFields

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to operationsoperations
•[ResourceOperation!]!
non-null

Most recent catalog operations.

Anchor to priceListpriceList
•PriceList

The price list associated with the catalog.

Anchor to publicationpublication
•Publication

A group of products and collections that's published to a catalog.

Anchor to statusstatus
•CatalogStatus!
non-null

The status of the catalog.

Anchor to titletitle
•String!
non-null

The name of the catalog.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to AppCatalogAppCatalog
•OBJECT

A catalog that defines the publication associated with an app.

Anchor to appsapps
•AppConnection!
non-null

The apps associated with the catalog.

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to operationsoperations
•[ResourceOperation!]!
non-null

Most recent catalog operations.

Anchor to priceListpriceList
•PriceList

The price list associated with the catalog.

Anchor to publicationpublication
•Publication

A group of products and collections that's published to a catalog.

Anchor to statusstatus
•CatalogStatus!
non-null

The status of the catalog.

Anchor to titletitle
•String!
non-null

The name of the catalog.

Anchor to CompanyLocationCatalogCompanyLocationCatalog
•OBJECT

A list of products with publishing and pricing information associated with company locations.

Company location catalogs can include an optional publication to control product visibility and a price list to customize pricing. When a publication isn't associated with the catalog, product availability is determined by the sales channel.

Anchor to companyLocationscompanyLocations
•CompanyLocationConnection!
non-null

The company locations associated with the catalog.

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to company_id
•id
Anchor to created_at
•time
Anchor to external_id
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to ids
•string
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Anchor to
•
  • metafields.custom.on_sale:true
    - metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name
•string
Anchor to updated_at
•time
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyLocationSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to companyLocationsCountcompanyLocationsCount
•Count

The number of company locations associated with the catalog.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to operationsoperations
•[ResourceOperation!]!
non-null

Most recent catalog operations.

Anchor to priceListpriceList
•PriceList

The price list associated with the catalog.

Anchor to publicationpublication
•Publication

A group of products and collections that's published to a catalog.

Anchor to statusstatus
•CatalogStatus!
non-null

The status of the catalog.

Anchor to titletitle
•String!
non-null

The name of the catalog.

Anchor to MarketCatalogMarketCatalog
•OBJECT

A catalog for managing product availability and pricing for specific Market contexts. Each catalog links to one or more markets. The catalog can optionally include a Publication to control which Product objects customers see, and a PriceList for market-specific pricing adjustments. When a publication isn't associated with the catalog, product availability is determined by the sales channel.

Use catalogs to create distinct shopping experiences for different geographic regions or customer segments.

Learn more about building a catalog and managing markets.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to marketsmarkets
•MarketConnection!
non-null

The markets associated with the catalog.

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to statusstatus
•MarketStatus
Default:null

Filters markets by status.

Anchor to typetype
•MarketType
Default:null

Filters markets by type.

Anchor to marketsCountmarketsCount
•Count

The number of markets associated with the catalog.

Arguments

Anchor to limitlimit
•Int

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to market_condition_types
•string

A comma-separated list of condition types.

Anchor to market_type
•string
Anchor to name
•string
Anchor to status
•string

Valid values:

  • ACTIVE
  • DRAFT
Anchor to wildcard_company_location_with_country_code
•string
Anchor to statusstatus
•MarketStatus
Default:null

Filters markets by status.

Anchor to typetype
•MarketType
Default:null

Filters markets by type.

Anchor to operationsoperations
•[ResourceOperation!]!
non-null

Most recent catalog operations.

Anchor to priceListpriceList
•PriceList

The price list associated with the catalog.

Anchor to publicationpublication
•Publication

A group of products and collections that's published to a catalog.

Anchor to statusstatus
•CatalogStatus!
non-null

The status of the catalog.

Anchor to titletitle
•String!
non-null

The name of the catalog.

Was this section helpful?