priceListFixedPricesAdd - admin-graphql - MUTATION

Version: 2024-01

Description:

Creates or updates fixed prices on a price list. You can use the `priceListFixedPricesAdd` mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten.

Access Scopes

`write_products` access scope. Also: The shop has the `international_price_overrides` or Markets or B2B features enabled.

Arguments

• priceListId: ID! - The ID of the price list to which the fixed prices will be added or updated.
• prices: PriceListPriceInput! - The list of fixed prices to add or update in the price list.

Returns

• prices: PriceListPrice The list of fixed prices that were added to or updated in the price list.
• userErrors: PriceListPriceUserError! The list of errors that occurred from executing the mutation.

Examples

• Add multiple fixed prices to a price list

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) { priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) { prices { compareAtPrice { amount currencyCode } price { amount currencyCode } } userErrors { field code message } } }\",\n \"variables\": {\n    \"priceListId\": \"gid://shopify/PriceList/115567603\",\n    \"prices\": [\n      {\n        \"compareAtPrice\": {\n          \"amount\": \"125.50\",\n          \"currencyCode\": \"CAD\"\n        },\n        \"price\": {\n          \"amount\": \"100\",\n          \"currencyCode\": \"CAD\"\n        },\n        \"variantId\": \"gid://shopify/ProductVariant/43729076\"\n      },\n      {\n        \"compareAtPrice\": {\n          \"amount\": \"6.99\",\n          \"currencyCode\": \"CAD\"\n        },\n        \"price\": {\n          \"amount\": \"4\",\n          \"currencyCode\": \"CAD\"\n        },\n        \"variantId\": \"gid://shopify/ProductVariant/138327650\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n      priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n        prices {\n          compareAtPrice {\n            amount\n            currencyCode\n          }\n          price {\n            amount\n            currencyCode\n          }\n        }\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceListId\": \"gid://shopify/PriceList/115567603\",\n      \"prices\": [\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"125.50\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"price\": {\n            \"amount\": \"100\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/43729076\"\n        },\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"6.99\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"price\": {\n            \"amount\": \"4\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/138327650\"\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 priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceListId\": \"gid://shopify/PriceList/115567603\",\n  \"prices\": [{\"compareAtPrice\"=>{\"amount\"=>\"125.50\", \"currencyCode\"=>\"CAD\"}, \"price\"=>{\"amount\"=>\"100\", \"currencyCode\"=>\"CAD\"}, \"variantId\"=>\"gid://shopify/ProductVariant/43729076\"}, {\"compareAtPrice\"=>{\"amount\"=>\"6.99\", \"currencyCode\"=>\"CAD\"}, \"price\"=>{\"amount\"=>\"4\", \"currencyCode\"=>\"CAD\"}, \"variantId\"=>\"gid://shopify/ProductVariant/138327650\"}]\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 = <<<QUERY\n  mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceListId\" => \"gid://shopify/PriceList/115567603\",\n  \"prices\" => [{\"compareAtPrice\"=>{\"amount\"=>\"125.50\", \"currencyCode\"=>\"CAD\"}, \"price\"=>{\"amount\"=>\"100\", \"currencyCode\"=>\"CAD\"}, \"variantId\"=>\"gid://shopify/ProductVariant/43729076\"}, {\"compareAtPrice\"=>{\"amount\"=>\"6.99\", \"currencyCode\"=>\"CAD\"}, \"price\"=>{\"amount\"=>\"4\", \"currencyCode\"=>\"CAD\"}, \"variantId\"=>\"gid://shopify/ProductVariant/138327650\"}],\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 priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceListId\": \"gid://shopify/PriceList/115567603\",\n      \"prices\": [\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"125.50\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"price\": {\n            \"amount\": \"100\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/43729076\"\n        },\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"6.99\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"price\": {\n            \"amount\": \"4\",\n            \"currencyCode\": \"CAD\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/138327650\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n  priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n    prices {\n      compareAtPrice {\n        amount\n        currencyCode\n      }\n      price {\n        amount\n        currencyCode\n      }\n    }\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}"
        

  input: {
    "priceListId": "gid://shopify/PriceList/115567603",
    "prices": [
      {
        "compareAtPrice": {
          "amount": "125.50",
          "currencyCode": "CAD"
        },
        "price": {
          "amount": "100",
          "currencyCode": "CAD"
        },
        "variantId": "gid://shopify/ProductVariant/43729076"
      },
      {
        "compareAtPrice": {
          "amount": "6.99",
          "currencyCode": "CAD"
        },
        "price": {
          "amount": "4",
          "currencyCode": "CAD"
        },
        "variantId": "gid://shopify/ProductVariant/138327650"
      }
    ]
  }

  response: {
    "data": {
      "priceListFixedPricesAdd": {
        "prices": [
          {
            "compareAtPrice": {
              "amount": "125.5",
              "currencyCode": "CAD"
            },
            "price": {
              "amount": "100.0",
              "currencyCode": "CAD"
            }
          },
          {
            "compareAtPrice": {
              "amount": "6.99",
              "currencyCode": "CAD"
            },
            "price": {
              "amount": "4.0",
              "currencyCode": "CAD"
            }
          }
        ],
        "userErrors": []
      }
    }
  }

  Adding a fixed price using a currency that isn't supported by the price list returns a currency mismatch error

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) { priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) { prices { compareAtPrice { amount currencyCode } price { amount currencyCode } } userErrors { field code message } } }\",\n \"variables\": {\n    \"priceListId\": \"gid://shopify/PriceList/115567603\",\n    \"prices\": [\n      {\n        \"compareAtPrice\": {\n          \"amount\": \"125.50\",\n          \"currencyCode\": \"EUR\"\n        },\n        \"price\": {\n          \"amount\": \"100\",\n          \"currencyCode\": \"EUR\"\n        },\n        \"variantId\": \"gid://shopify/ProductVariant/43729076\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n      priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n        prices {\n          compareAtPrice {\n            amount\n            currencyCode\n          }\n          price {\n            amount\n            currencyCode\n          }\n        }\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceListId\": \"gid://shopify/PriceList/115567603\",\n      \"prices\": [\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"125.50\",\n            \"currencyCode\": \"EUR\"\n          },\n          \"price\": {\n            \"amount\": \"100\",\n            \"currencyCode\": \"EUR\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/43729076\"\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 priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceListId\": \"gid://shopify/PriceList/115567603\",\n  \"prices\": [{\"compareAtPrice\"=>{\"amount\"=>\"125.50\", \"currencyCode\"=>\"EUR\"}, \"price\"=>{\"amount\"=>\"100\", \"currencyCode\"=>\"EUR\"}, \"variantId\"=>\"gid://shopify/ProductVariant/43729076\"}]\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 = <<<QUERY\n  mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceListId\" => \"gid://shopify/PriceList/115567603\",\n  \"prices\" => [{\"compareAtPrice\"=>{\"amount\"=>\"125.50\", \"currencyCode\"=>\"EUR\"}, \"price\"=>{\"amount\"=>\"100\", \"currencyCode\"=>\"EUR\"}, \"variantId\"=>\"gid://shopify/ProductVariant/43729076\"}],\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 priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n    priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n      prices {\n        compareAtPrice {\n          amount\n          currencyCode\n        }\n        price {\n          amount\n          currencyCode\n        }\n      }\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceListId\": \"gid://shopify/PriceList/115567603\",\n      \"prices\": [\n        {\n          \"compareAtPrice\": {\n            \"amount\": \"125.50\",\n            \"currencyCode\": \"EUR\"\n          },\n          \"price\": {\n            \"amount\": \"100\",\n            \"currencyCode\": \"EUR\"\n          },\n          \"variantId\": \"gid://shopify/ProductVariant/43729076\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n  priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n    prices {\n      compareAtPrice {\n        amount\n        currencyCode\n      }\n      price {\n        amount\n        currencyCode\n      }\n    }\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}"
        

  input: {
    "priceListId": "gid://shopify/PriceList/115567603",
    "prices": [
      {
        "compareAtPrice": {
          "amount": "125.50",
          "currencyCode": "EUR"
        },
        "price": {
          "amount": "100",
          "currencyCode": "EUR"
        },
        "variantId": "gid://shopify/ProductVariant/43729076"
      }
    ]
  }

  response: {
    "data": {
      "priceListFixedPricesAdd": {
        "prices": [],
        "userErrors": [
          {
            "field": [
              "prices",
              "0",
              "price",
              "currencyCode"
            ],
            "code": "PRICE_LIST_CURRENCY_MISMATCH",
            "message": "The specified currency does not match the price list's currency."
          },
          {
            "field": [
              "prices",
              "0",
              "compareAtPrice",
              "currencyCode"
            ],
            "code": "PRICE_LIST_CURRENCY_MISMATCH",
            "message": "The specified currency does not match the price list's currency."
          }
        ]
      }
    }
  }