Anchor to section titled 'undefined'price
price
mutation
2024-10latest
Requires write access scope. Also: The shop has the international or Markets or B2B features enabled.
Creates or updates fixed prices on a price list. You can use the price 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.
Anchor to section titled 'Arguments'
Arguments
The ID of the price list to which the fixed prices will be added or updated.
The list of fixed prices to add or update in the price list.
Was this section helpful?
Anchor to section titled 'PriceListFixedPricesAddPayload returns'
PriceListFixedPricesAddPayload returns
The list of fixed prices that were added to or updated in the price list.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: priceListFixedPricesAdd
Query Reference for MUTATION: priceListFixedPricesAdd
"mutation priceListFixedPricesAdd($priceListId: ID!, $prices: [PriceListPriceInput!]!) {\n priceListFixedPricesAdd(priceListId: $priceListId, prices: $prices) {\n prices {\n # PriceListPrice fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: priceListFixedPricesAdd
"{\n \"priceListId\": \"gid://shopify/<objectName>/10079785100\",\n \"prices\": [\n {\n \"compareAtPrice\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"variantId\": \"gid://shopify/<objectName>/10079785100\"\n }\n ]\n}"Schema Reference for MUTATION: priceListFixedPricesAdd
"input PriceListPriceInput {\n compareAtPrice: MoneyInput\n price: MoneyInput!\n variantId: ID!\n}\n\ninput MoneyInput {\n amount: Decimal!\n currencyCode: CurrencyCode!\n}\n"Display Examples for MUTATION: priceListFixedPricesAdd
[
{
"example": {
"type_name": "pricelistfixedpricesadd",
"title": "Add multiple fixed prices to a price list",
"description": "Add fixed prices for two product variants in Canadian currency.",
"query_string": "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}",
"variables": {
"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": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/price_list_fixed_prices_add_test.rb",
"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 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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "priceListId",
"description": "The ID of the price list to which the fixed prices will be added or updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "priceListId",
"argValue": " \"gid://shopify/PriceList/115567603\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "prices",
"description": "The list of fixed prices to add or update in the price list.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceListPriceInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[PriceListPriceInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "prices",
"argValue": " [{\"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\"}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "pricelistfixedpricesadd",
"title": "Adding a fixed price using a currency that isn't supported by the price list returns a currency mismatch error",
"description": "Attempt to add a fixed price using the Euro currency on a price list that only supports Canadian currency.",
"query_string": "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}",
"variables": {
"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."
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/price_list_fixed_prices_add_test.rb",
"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 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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "priceListId",
"description": "The ID of the price list to which the fixed prices will be added or updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "priceListId",
"argValue": " \"gid://shopify/PriceList/115567603\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "prices",
"description": "The list of fixed prices to add or update in the price list.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceListPriceInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[PriceListPriceInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "prices",
"argValue": " [{\"compareAtPrice\":{\"amount\":\"125.50\",\"currencyCode\":\"EUR\"},\"price\":{\"amount\":\"100\",\"currencyCode\":\"EUR\"},\"variantId\":\"gid://shopify/ProductVariant/43729076\"}]",
"typeKind": "MUTATION"
}
]
}
]