Skip to main content
object

Defines errors encountered while managing a catalog.

•CatalogUserErrorCode

The error code.

•[String!]

The path to the input field that caused the error.

•String!
non-null

The error message.


Was this section helpful?

•mutation

Modifies which contexts, like markets or B2B company locations, can access a Catalog. You can add or remove contexts to control where the catalog's products and prices are available.

Learn more about managing catalog contexts and managing B2B catalogs.

Arguments

•ID!
required

The ID of the catalog for which to update the context.

•CatalogContextInput

The contexts to add to the catalog.

•CatalogContextInput

The contexts to remove from the catalog.


•mutation

Creates a Catalog that controls product availability and pricing for specific contexts like markets or B2B company locations.

Publications and Price Lists

  • Publication objects control which products are visible in a catalog. Publications are optional. When a publication isn't associated with a catalog, product availability is determined by the sales channel.
  • PriceList objects define custom pricing for products in a catalog.

You can optionally associate a publication and price list when creating the catalog, or add them later using separate mutations.

When to use Publications

Create a publication only if you need to:

  • Limit which products are visible in a specific context (e.g., show different products to different company locations or markets)
  • Publish a curated subset of your product catalog

Do NOT create a publication if:

  • You want product availability determined by the sales channel
  • You only need to customize pricing (use a price list without a publication)

Important: For company location catalogs that only require custom pricing, create the catalog with a price list but without a publication.

Learn more about managing catalog contexts and using catalogs for different markets.

Arguments

•CatalogCreateInput!
required

The properties of the new catalog.


•mutation

Delete a catalog.

Arguments

•ID!
required

The ID of the catalog to delete.

Anchor to deleteDependentResourcesdeleteDependentResources
•Boolean
Default:false

Whether to also delete the price list and the publication owned by the catalog.


•mutation

Updates an existing catalog's configuration. Catalogs control product publishing and pricing for specific contexts like markets or B2B company locations.

You can modify the catalog's title, status, and associated context. You can also update the PriceList that determines pricing adjustments or the Publication that controls which products customers see.

Arguments

•ID!
required

The ID of the catalog to update.

•CatalogUpdateInput!
required

The properties of the updated catalog.



Was this section helpful?


Was this section helpful?