priceListCreate - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a price list. You can use the `priceListCreate` mutation to create a new price list and associate it with a catalog. This enables you to sell your products with contextual pricing.

Access Scopes

`write_products` access scope. Also: The user must have a permission to create a price list.

Arguments

• input: PriceListCreateInput! - The properties of the new price list.

Returns

• priceList: PriceList The newly created price list.
• userErrors: PriceListUserError! The list of errors that occurred from executing the mutation.

Examples

• Create a price list with a percentage adjustment.

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PriceListCreate($input: PriceListCreateInput!) { priceListCreate(input: $input) { userErrors { field message } priceList { id name currency parent { adjustment { type value } } } } }\",\n \"variables\": {\n    \"input\": {\n      \"name\": \"Price List\",\n      \"currency\": \"USD\",\n      \"parent\": {\n        \"adjustment\": {\n          \"type\": \"PERCENTAGE_INCREASE\",\n          \"value\": 10\n        }\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PriceListCreate($input: PriceListCreateInput!) {\n      priceListCreate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        priceList {\n          id\n          name\n          currency\n          parent {\n            adjustment {\n              type\n              value\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"name\": \"Price List\",\n        \"currency\": \"USD\",\n        \"parent\": {\n          \"adjustment\": {\n            \"type\": \"PERCENTAGE_INCREASE\",\n            \"value\": 10\n          }\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation PriceListCreate($input: PriceListCreateInput!) {\n    priceListCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      priceList {\n        id\n        name\n        currency\n        parent {\n          adjustment {\n            type\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"name\": \"Price List\",\n    \"currency\": \"USD\",\n    \"parent\": {\n      \"adjustment\": {\n        \"type\": \"PERCENTAGE_INCREASE\",\n        \"value\": 10\n      }\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << [\n    \"name\" => \"Price List\",\n    \"currency\" => \"USD\",\n    \"parent\" => [\n      \"adjustment\" => [\n        \"type\" => \"PERCENTAGE_INCREASE\",\n        \"value\" => 10,\n      ],\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation PriceListCreate($input: PriceListCreateInput!) {\n    priceListCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      priceList {\n        id\n        name\n        currency\n        parent {\n          adjustment {\n            type\n            value\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"name\": \"Price List\",\n        \"currency\": \"USD\",\n        \"parent\": {\n          \"adjustment\": {\n            \"type\": \"PERCENTAGE_INCREASE\",\n            \"value\": 10\n          }\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PriceListCreate($input: PriceListCreateInput!) {\n  priceListCreate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    priceList {\n      id\n      name\n      currency\n      parent {\n        adjustment {\n          type\n          value\n        }\n      }\n    }\n  }\n}"
        

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

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