Choose a version:

catalogCreate

mutation

Requires write_products access scope. Also: The user must have permission to create and edit catalogs.

Creates a Catalog that controls product availability and pricing for specific contexts like markets or B2B company locations. Catalogs use Publication objects to determine which products are available and PriceList objects to set custom pricing.

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

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

Anchor to Arguments

Arguments

Anchor to inputinput •CatalogCreateInput! required: The properties of the new catalog.

Was this section helpful?

Anchor to CatalogCreatePayload returnsCatalogCreatePayload returns

Anchor to catalogcatalog •Catalog: The newly created catalog.
Anchor to userErrorsuserErrors •[CatalogUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a catalog with a publication

Query

mutation catalogCreate($input: CatalogCreateInput!) {
  catalogCreate(input: $input) {
    catalog {
      id
      status
      title
      publication {
        id
        autoPublish
      }
      priceList {
        id
        currency
      }
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "title": "Market Catalog",
    "status": "ACTIVE",
    "context": {
      "marketIds": [
        "gid://shopify/Market/128989799"
      ]
    },
    "priceListId": "gid://shopify/PriceList/294167858",
    "publicationId": "gid://shopify/Publication/1056839876"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation catalogCreate($input: CatalogCreateInput!) { catalogCreate(input: $input) { catalog { id status title publication { id autoPublish } priceList { id currency } } userErrors { field message } } }",
 "variables": {
    "input": {
      "title": "Market Catalog",
      "status": "ACTIVE",
      "context": {
        "marketIds": [
          "gid://shopify/Market/128989799"
        ]
      },
      "priceListId": "gid://shopify/PriceList/294167858",
      "publicationId": "gid://shopify/Publication/1056839876"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        publication {
          id
          autoPublish
        }
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "Market Catalog",
            "status": "ACTIVE",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/128989799"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858",
            "publicationId": "gid://shopify/Publication/1056839876"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        publication {
          id
          autoPublish
        }
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "Market Catalog",
    "status": "ACTIVE",
    "context": {
      "marketIds": [
        "gid://shopify/Market/128989799"
      ]
    },
    "priceListId": "gid://shopify/PriceList/294167858",
    "publicationId": "gid://shopify/Publication/1056839876"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation catalogCreate($input: CatalogCreateInput!) {
      catalogCreate(input: $input) {
        catalog {
          id
          status
          title
          publication {
            id
            autoPublish
          }
          priceList {
            id
            currency
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "Market Catalog",
            "status": "ACTIVE",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/128989799"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858",
            "publicationId": "gid://shopify/Publication/1056839876"
        }
    },
  },
});

Response

{
  "catalogCreate": {
    "catalog": {
      "id": "gid://shopify/MarketCatalog/1068177653",
      "status": "ACTIVE",
      "title": "Market Catalog",
      "publication": {
        "id": "gid://shopify/Publication/1056839876",
        "autoPublish": false
      },
      "priceList": {
        "id": "gid://shopify/PriceList/294167858",
        "currency": "USD"
      }
    },
    "userErrors": []
  }
}

Create a pricing-only catalog

Description

Create a [pricing-only catalog](https://shopify.dev/docs/apps/build/markets/catalogs-different-markets#pricing-only-catalogs).

Query

mutation catalogCreate($input: CatalogCreateInput!) {
  catalogCreate(input: $input) {
    catalog {
      id
      status
      title
      priceList {
        id
        currency
      }
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "title": "Pricing Only Catalog",
    "status": "DRAFT",
    "context": {
      "marketIds": [
        "gid://shopify/Market/1054177655"
      ]
    },
    "priceListId": "gid://shopify/PriceList/294167858"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation catalogCreate($input: CatalogCreateInput!) { catalogCreate(input: $input) { catalog { id status title priceList { id currency } } userErrors { field message } } }",
 "variables": {
    "input": {
      "title": "Pricing Only Catalog",
      "status": "DRAFT",
      "context": {
        "marketIds": [
          "gid://shopify/Market/1054177655"
        ]
      },
      "priceListId": "gid://shopify/PriceList/294167858"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "Pricing Only Catalog",
            "status": "DRAFT",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/1054177655"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "Pricing Only Catalog",
    "status": "DRAFT",
    "context": {
      "marketIds": [
        "gid://shopify/Market/1054177655"
      ]
    },
    "priceListId": "gid://shopify/PriceList/294167858"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation catalogCreate($input: CatalogCreateInput!) {
      catalogCreate(input: $input) {
        catalog {
          id
          status
          title
          priceList {
            id
            currency
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "Pricing Only Catalog",
            "status": "DRAFT",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/1054177655"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858"
        }
    },
  },
});

Response

{
  "catalogCreate": {
    "catalog": {
      "id": "gid://shopify/MarketCatalog/1068177654",
      "status": "DRAFT",
      "title": "Pricing Only Catalog",
      "priceList": {
        "id": "gid://shopify/PriceList/294167858",
        "currency": "USD"
      }
    },
    "userErrors": []
  }
}

catalogCreate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation catalogCreate($input: CatalogCreateInput!) {

catalogCreate(input: $input) {

catalog {

status

title

publication {

autoPublish

}

priceList {

currency

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"title": "Market Catalog",

"status": "ACTIVE",

"context": {

"marketIds": [

"gid://shopify/Market/128989799"

]

"priceListId": "gid://shopify/PriceList/294167858",

"publicationId": "gid://shopify/Publication/1056839876"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation catalogCreate($input: CatalogCreateInput!) {
  catalogCreate(input: $input) {
    catalog {
      id
      status
      title
      publication {
        id
        autoPublish
      }
      priceList {
        id
        currency
      }
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation catalogCreate($input: CatalogCreateInput!) { catalogCreate(input: $input) { catalog { id status title publication { id autoPublish } priceList { id currency } } userErrors { field message } } }",
 "variables": {
    "input": {
      "title": "Market Catalog",
      "status": "ACTIVE",
      "context": {
        "marketIds": [
          "gid://shopify/Market/128989799"
        ]
      },
      "priceListId": "gid://shopify/PriceList/294167858",
      "publicationId": "gid://shopify/Publication/1056839876"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        publication {
          id
          autoPublish
        }
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "Market Catalog",
            "status": "ACTIVE",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/128989799"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858",
            "publicationId": "gid://shopify/Publication/1056839876"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation catalogCreate($input: CatalogCreateInput!) {
      catalogCreate(input: $input) {
        catalog {
          id
          status
          title
          publication {
            id
            autoPublish
          }
          priceList {
            id
            currency
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "Market Catalog",
            "status": "ACTIVE",
            "context": {
                "marketIds": [
                    "gid://shopify/Market/128989799"
                ]
            },
            "priceListId": "gid://shopify/PriceList/294167858",
            "publicationId": "gid://shopify/Publication/1056839876"
        }
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation catalogCreate($input: CatalogCreateInput!) {
    catalogCreate(input: $input) {
      catalog {
        id
        status
        title
        publication {
          id
          autoPublish
        }
        priceList {
          id
          currency
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "Market Catalog",
    "status": "ACTIVE",
    "context": {
      "marketIds": [
        "gid://shopify/Market/128989799"
      ]
    },
    "priceListId": "gid://shopify/PriceList/294167858",
    "publicationId": "gid://shopify/Publication/1056839876"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"title": "Market Catalog",

"status": "ACTIVE",

"context": {

"marketIds": [

"gid://shopify/Market/128989799"

]

"priceListId": "gid://shopify/PriceList/294167858",

"publicationId": "gid://shopify/Publication/1056839876"

}

Response

JSON

{

"catalogCreate": {

"catalog": {

"id": "gid://shopify/MarketCatalog/1068177653",

"status": "ACTIVE",

"title": "Market Catalog",

"publication": {

"id": "gid://shopify/Publication/1056839876",

"autoPublish": false

"priceList": {

"id": "gid://shopify/PriceList/294167858",

"currency": "USD"

}

"userErrors": []

}