Catalog
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, ,
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
- id (ID!)
- operations ([ResourceOperation!]!)
- priceList (PriceList)
- publication (Publication)
- status (CatalogStatus!)
- title (String!)
- •ID!non-null
A globally-unique ID.
- Anchor to operationsoperations•[Resource
Operation!]! non-null Most recent catalog operations.
- Anchor to priceListprice•Price
List List 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•Catalog
Status! non-null The status of the catalog.
- Anchor to titletitle•String!non-null
The name of the catalog.
Anchor to Types implemented inTypes implemented in
- AppCatalog (AppCatalog)
- CompanyLocationCatalog (CompanyLocationCatalog)
- MarketCatalog (MarketCatalog)
- •OBJECT
A catalog that defines the publication associated with an app.
- Anchor to appsapps•App
Connection! non-null The apps associated with the catalog.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to channelschannels•Channel
Connection! non-null The channels associated with the catalog.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •ID!non-null
A globally-unique ID.
- Anchor to operationsoperations•[Resource
Operation!]! non-null Most recent catalog operations.
- Anchor to priceListprice•Price
List List 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•Catalog
Status! non-null The status of the catalog.
- Anchor to titletitle•String!non-null
The name of the catalog.
- •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 companyLocationscompany•Company
Locations Location Connection! non-null The company locations associated with the catalog.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodiecompany_id id created_at time external_id string id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234ids string metafields.{namespace}.{key} mixed Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more aboutquerying by metafield value. -
-name string updated_at time You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Location Sort Keys Default:ID Sort the underlying list by the given key.
Arguments
- Anchor to companyLocationsCountcompany•Count
Locations Count The number of company locations associated with the catalog.
- •ID!non-null
A globally-unique ID.
- Anchor to operationsoperations•[Resource
Operation!]! non-null Most recent catalog operations.
- Anchor to priceListprice•Price
List List 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•Catalog
Status! non-null The status of the catalog.
- Anchor to titletitle•String!non-null
The name of the catalog.
- •OBJECT
A catalog for managing product availability and pricing for specific
Marketcontexts. Each catalog links to one or more markets. The catalog can optionally include aPublicationto control whichProductobjects customers see, and afor 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.
- •ID!non-null
A globally-unique ID.
- Anchor to marketsmarkets•Market
Connection! non-null The markets associated with the catalog.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to statusstatus•Market
Status Default:null Filters markets by status.
- Anchor to typetype•Market
Type Default:null Filters markets by type.
Arguments
- Anchor to marketsCountmarkets•Count
Count The number of markets associated with the catalog.
- Anchor to limitlimit•Int
The upper bound on count value before returning a result. Use
nullto have no limit.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodieid id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234market_condition_types string A comma-separated list of condition types. market_type string name string status string -
-wildcard_company_location_with_country_code string You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - Anchor to statusstatus•Market
Status Default:null Filters markets by status.
- Anchor to typetype•Market
Type Default:null Filters markets by type.
Arguments
- Anchor to operationsoperations•[Resource
Operation!]! non-null Most recent catalog operations.
- Anchor to priceListprice•Price
List List 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•Catalog
Status! non-null The status of the catalog.
- Anchor to titletitle•String!non-null
The name of the catalog.
- •ID!