Anchor to section titled 'undefined'price
price
query
2024-10latest
Returns a price list resource by ID.
Anchor to section titled 'Arguments'
Arguments
The ID of the
Priceto return.List
Was this section helpful?
Anchor to section titled 'PriceList possible returns'
PriceList possible returns
Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.
For more information on price lists, refer to Support different pricing models.
Was this section helpful?
Code examples for QUERY: priceList
Query Reference for QUERY: priceList
"{\n priceList(id) {\n # PriceList fields\n }\n}"Input Reference for QUERY: priceList
Schema Reference for QUERY: priceList
Display Examples for QUERY: priceList
[
{
"example": {
"type_name": "pricelist",
"title": "Retrieve Price List Details and Associated Catalog Information",
"description": "Retrieves the price list's catalog title. Fetches the currency used in the price list and details about the parent's adjustment type and value.",
"query_string": "query {\n priceList(id: \"gid://shopify/PriceList/524058083\") {\n catalog {\n id\n title\n }\n prices(first: 5, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n currency\n parent {\n adjustment {\n type\n value\n }\n }\n }\n}",
"response": {
"data": {
"priceList": {
"catalog": {
"id": "gid://shopify/MarketCatalog/307400570",
"title": "Just a simple catalog for a US Price List"
},
"prices": {
"nodes": [
{
"price": {
"amount": "9.0",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/30322695"
}
},
{
"price": {
"amount": "13.5",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/113711323"
}
},
{
"price": {
"amount": "13.5",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/236948360"
}
}
]
},
"currency": "USD",
"parent": {
"adjustment": {
"type": "PERCENTAGE_DECREASE",
"value": 10
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-01",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/price_list_examples_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\": \"query { priceList(id: \\\"gid://shopify/PriceList/524058083\\\") { catalog { id title } prices(first: 5, query: \\\"product_id:20995642\\\") { nodes { price { amount currencyCode } variant { id } } } currency parent { adjustment { type value } } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceList(id: \"gid://shopify/PriceList/524058083\") {\n catalog {\n id\n title\n }\n prices(first: 5, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n currency\n parent {\n adjustment {\n type\n value\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 query {\n priceList(id: \"gid://shopify/PriceList/524058083\") {\n catalog {\n id\n title\n }\n prices(first: 5, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n currency\n parent {\n adjustment {\n type\n value\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceList(id: \"gid://shopify/PriceList/524058083\") {\n catalog {\n id\n title\n }\n prices(first: 5, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n currency\n parent {\n adjustment {\n type\n value\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 query {\n priceList(id: \"gid://shopify/PriceList/524058083\") {\n catalog {\n id\n title\n }\n prices(first: 5, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n currency\n parent {\n adjustment {\n type\n value\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "pricelist",
"title": "Retrieve Quantity Rules on Price List",
"description": "Retrieves the fixed associated quantity rules on a price list.",
"query_string": "query {\n priceList(id: \"gid://shopify/PriceList/225060712\") {\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n currency\n }\n}",
"response": {
"data": {
"priceList": {
"quantityRules": {
"nodes": [
{
"increment": 100,
"maximum": 5000,
"minimum": 500,
"productVariant": {
"id": "gid://shopify/ProductVariant/43729076",
"title": "151cm"
}
},
{
"increment": 10,
"maximum": 1000,
"minimum": 100,
"productVariant": {
"id": "gid://shopify/ProductVariant/138327650",
"title": "Default"
}
},
{
"increment": 5,
"maximum": null,
"minimum": 10,
"productVariant": {
"id": "gid://shopify/ProductVariant/389013007",
"title": "Small"
}
}
]
},
"currency": "USD"
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/price_list_examples_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\": \"query { priceList(id: \\\"gid://shopify/PriceList/225060712\\\") { quantityRules(first: 3, originType: FIXED) { nodes { increment maximum minimum productVariant { id title } } } currency } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceList(id: \"gid://shopify/PriceList/225060712\") {\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n currency\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 query {\n priceList(id: \"gid://shopify/PriceList/225060712\") {\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n currency\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceList(id: \"gid://shopify/PriceList/225060712\") {\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n currency\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 query {\n priceList(id: \"gid://shopify/PriceList/225060712\") {\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n currency\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "pricelist",
"title": "Retrieve the FIXED prices on a price list",
"description": "Retrieve the first ten fixed prices on a price list, returning the associated price, compareAtPrice, and variant values.",
"query_string": "query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, originType: FIXED) {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n originType\n variant {\n id\n }\n }\n }\n }\n}",
"response": {
"data": {
"priceList": {
"id": "gid://shopify/PriceList/294167858",
"name": "simple_pricelist",
"prices": {
"nodes": [
{
"price": {
"amount": "19.96",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "24.99",
"currencyCode": "USD"
},
"originType": "FIXED",
"variant": {
"id": "gid://shopify/ProductVariant/113711323"
}
},
{
"price": {
"amount": "9.99",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "14.99",
"currencyCode": "USD"
},
"originType": "FIXED",
"variant": {
"id": "gid://shopify/ProductVariant/498744621"
}
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/price_list_examples_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\": \"query { priceList(id: \\\"gid://shopify/PriceList/294167858\\\") { id name prices(first: 10, originType: FIXED) { nodes { price { amount currencyCode } compareAtPrice { amount currencyCode } originType variant { id } } } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, originType: FIXED) {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n originType\n variant {\n id\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, originType: FIXED) {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n originType\n variant {\n id\n }\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, originType: FIXED) {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n originType\n variant {\n id\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, originType: FIXED) {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n originType\n variant {\n id\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "pricelist",
"title": "Retrieve the prices on a price list filtered by product_id",
"description": "Retrieve the first ten prices on a price list, filtered by product_id, returning the associated price, compareAtPrice, and variant values.",
"query_string": "query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n product {\n id\n }\n }\n }\n }\n }\n}",
"response": {
"data": {
"priceList": {
"id": "gid://shopify/PriceList/294167858",
"name": "simple_pricelist",
"prices": {
"nodes": [
{
"price": {
"amount": "10.0",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "14.0",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/30322695",
"product": {
"id": "gid://shopify/Product/20995642"
}
}
},
{
"price": {
"amount": "19.96",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "24.99",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/113711323",
"product": {
"id": "gid://shopify/Product/20995642"
}
}
},
{
"price": {
"amount": "15.0",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "17.0",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/236948360",
"product": {
"id": "gid://shopify/Product/20995642"
}
}
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-01",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/price_list_examples_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\": \"query { priceList(id: \\\"gid://shopify/PriceList/294167858\\\") { id name prices(first: 10, query: \\\"product_id:20995642\\\") { nodes { price { amount currencyCode } compareAtPrice { amount currencyCode } variant { id product { id } } } } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n product {\n id\n }\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n product {\n id\n }\n }\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n product {\n id\n }\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"product_id:20995642\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n product {\n id\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "pricelist",
"title": "Retrieve the prices on a price list filtered by variant_id",
"description": "Retrieve the first ten prices on a price list, filtered by variant_id, returning the associated price, compareAtPrice, and variant values.",
"query_string": "query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"variant_id:498744621\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n }\n}",
"response": {
"data": {
"priceList": {
"id": "gid://shopify/PriceList/294167858",
"name": "simple_pricelist",
"prices": {
"nodes": [
{
"price": {
"amount": "9.99",
"currencyCode": "USD"
},
"compareAtPrice": {
"amount": "14.99",
"currencyCode": "USD"
},
"variant": {
"id": "gid://shopify/ProductVariant/498744621"
}
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-01",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/price_list_examples_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\": \"query { priceList(id: \\\"gid://shopify/PriceList/294167858\\\") { id name prices(first: 10, query: \\\"variant_id:498744621\\\") { nodes { price { amount currencyCode } compareAtPrice { amount currencyCode } variant { id } } } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"variant_id:498744621\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"variant_id:498744621\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"variant_id:498744621\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n }\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 query {\n priceList(id: \"gid://shopify/PriceList/294167858\") {\n id\n name\n prices(first: 10, query: \"variant_id:498744621\") {\n nodes {\n price {\n amount\n currencyCode\n }\n compareAtPrice {\n amount\n currencyCode\n }\n variant {\n id\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
}
]