Choose a version:

priceListCreate

mutation

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

Creates a PriceList. Price lists enable contextual pricing by defining fixed prices or percentage-based adjustments.

The price list requires a unique name, currency for fixed prices, and parent adjustment settings that determine how the system calculates prices relative to base prices. To apply contextual pricing, link the price list to a Catalog. When that catalog's context is matched, customers receive the price list's prices.

Learn more about building catalogs with price lists.

Anchor to Arguments

Arguments

Anchor to inputinput

•PriceListCreateInput!

required

The properties of the new price list.

Was this section helpful?

Anchor to PriceListCreatePayload returnsPriceListCreatePayload returns

Anchor to priceListpriceList •PriceList: The newly created price list.
Anchor to userErrorsuserErrors •[PriceListUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a price list with a percentage adjustment.

Description

Create a price list that applies a 10% price increase.

Query

mutation PriceListCreate($input: PriceListCreateInput!) {
  priceListCreate(input: $input) {
    userErrors {
      field
      message
    }
    priceList {
      id
      name
      currency
      parent {
        adjustment {
          type
          value
        }
      }
    }
  }
}

Variables

{
  "input": {
    "name": "Price List",
    "currency": "USD",
    "parent": {
      "adjustment": {
        "type": "PERCENTAGE_INCREASE",
        "value": 10
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PriceListCreate($input: PriceListCreateInput!) { priceListCreate(input: $input) { userErrors { field message } priceList { id name currency parent { adjustment { type value } } } } }",
 "variables": {
    "input": {
      "name": "Price List",
      "currency": "USD",
      "parent": {
        "adjustment": {
          "type": "PERCENTAGE_INCREASE",
          "value": 10
        }
      }
    }
  }
}'

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 PriceListCreate($input: PriceListCreateInput!) {
    priceListCreate(input: $input) {
      userErrors {
        field
        message
      }
      priceList {
        id
        name
        currency
        parent {
          adjustment {
            type
            value
          }
        }
      }
    }
  }`,
  {
    variables: {
        "input": {
            "name": "Price List",
            "currency": "USD",
            "parent": {
                "adjustment": {
                    "type": "PERCENTAGE_INCREASE",
                    "value": 10
                }
            }
        }
    },
  },
  );
  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 PriceListCreate($input: PriceListCreateInput!) {
    priceListCreate(input: $input) {
      userErrors {
        field
        message
      }
      priceList {
        id
        name
        currency
        parent {
          adjustment {
            type
            value
          }
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "name": "Price List",
    "currency": "USD",
    "parent": {
      "adjustment": {
        "type": "PERCENTAGE_INCREASE",
        "value": 10
      }
    }
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation PriceListCreate($input: PriceListCreateInput!) {
      priceListCreate(input: $input) {
        userErrors {
          field
          message
        }
        priceList {
          id
          name
          currency
          parent {
            adjustment {
              type
              value
            }
          }
        }
      }
    }`,
    "variables": {
        "input": {
            "name": "Price List",
            "currency": "USD",
            "parent": {
                "adjustment": {
                    "type": "PERCENTAGE_INCREASE",
                    "value": 10
                }
            }
        }
    },
  },
});

Response

{
  "priceListCreate": {
    "userErrors": [],
    "priceList": {
      "id": "gid://shopify/PriceList/1014716633",
      "name": "Price List",
      "currency": "USD",
      "parent": {
        "adjustment": {
          "type": "PERCENTAGE_INCREASE",
          "value": 10
        }
      }
    }
  }
}

priceListCreate 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 PriceListCreate($input: PriceListCreateInput!) {

priceListCreate(input: $input) {

userErrors {

field

message

}

priceList {

name

currency

parent {

adjustment {

type

value

}

}`,

{

variables: {

"input": {

"name": "Price List",

"currency": "USD",

"parent": {

"adjustment": {

"type": "PERCENTAGE_INCREASE",

"value": 10

}

);

const json = await response.json();

return json.data;

}

GQL

mutation PriceListCreate($input: PriceListCreateInput!) {
  priceListCreate(input: $input) {
    userErrors {
      field
      message
    }
    priceList {
      id
      name
      currency
      parent {
        adjustment {
          type
          value
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PriceListCreate($input: PriceListCreateInput!) { priceListCreate(input: $input) { userErrors { field message } priceList { id name currency parent { adjustment { type value } } } } }",
 "variables": {
    "input": {
      "name": "Price List",
      "currency": "USD",
      "parent": {
        "adjustment": {
          "type": "PERCENTAGE_INCREASE",
          "value": 10
        }
      }
    }
  }
}'

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 PriceListCreate($input: PriceListCreateInput!) {
    priceListCreate(input: $input) {
      userErrors {
        field
        message
      }
      priceList {
        id
        name
        currency
        parent {
          adjustment {
            type
            value
          }
        }
      }
    }
  }`,
  {
    variables: {
        "input": {
            "name": "Price List",
            "currency": "USD",
            "parent": {
                "adjustment": {
                    "type": "PERCENTAGE_INCREASE",
                    "value": 10
                }
            }
        }
    },
  },
  );
  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 PriceListCreate($input: PriceListCreateInput!) {
      priceListCreate(input: $input) {
        userErrors {
          field
          message
        }
        priceList {
          id
          name
          currency
          parent {
            adjustment {
              type
              value
            }
          }
        }
      }
    }`,
    "variables": {
        "input": {
            "name": "Price List",
            "currency": "USD",
            "parent": {
                "adjustment": {
                    "type": "PERCENTAGE_INCREASE",
                    "value": 10
                }
            }
        }
    },
  },
});

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 PriceListCreate($input: PriceListCreateInput!) {
    priceListCreate(input: $input) {
      userErrors {
        field
        message
      }
      priceList {
        id
        name
        currency
        parent {
          adjustment {
            type
            value
          }
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "name": "Price List",
    "currency": "USD",
    "parent": {
      "adjustment": {
        "type": "PERCENTAGE_INCREASE",
        "value": 10
      }
    }
  }
}

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

Input variables

JSON

{

"input": {

"name": "Price List",

"currency": "USD",

"parent": {

"adjustment": {

"type": "PERCENTAGE_INCREASE",

"value": 10

}

Response

JSON

{

"priceListCreate": {

"userErrors": [],

"priceList": {

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

"name": "Price List",

"currency": "USD",

"parent": {

"adjustment": {

"type": "PERCENTAGE_INCREASE",

"value": 10

}