price Listsquery
All price lists for a shop.
PriceListConnection argumentsPriceListConnection!
The elements that come after the specified cursor.
Anchor to beforebeforeThe elements that come before the specified cursor.
Anchor to firstfirstThe first
n
elements from the paginated list.The last
n
elements from the paginated list.Reverse the order of the underlying list.
Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
PriceListConnection possible returns
The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
A list of nodes that are contained in PriceListEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
An object that’s used to retrieve cursor information about the current page.
Code examples for QUERY: priceLists
Query Reference for QUERY: priceLists
"{\n priceLists {\n # PriceListConnection fields\n }\n}"
Input Reference for QUERY: priceLists
Schema Reference for QUERY: priceLists
Display Examples for QUERY: priceLists
[ { "example": { "type_name": "pricelists", "title": "Retrieve price list in reversed order", "description": "Fetch the first price list and return the ID, currency, fixed prices count and catalog information", "query_string": "query {\n priceLists(first: 1, reverse: true) {\n nodes {\n id\n currency\n fixedPricesCount\n catalog {\n id\n title\n }\n }\n }\n}", "response": { "data": { "priceLists": { "nodes": [ { "id": "gid://shopify/PriceList/1014716632", "currency": "USD", "fixedPricesCount": 0, "catalog": null } ] } } }, "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 { priceLists(first: 1, reverse: true) { nodes { id currency fixedPricesCount catalog { id title } } } }\"\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceLists(first: 1, reverse: true) {\n nodes {\n id\n currency\n fixedPricesCount\n catalog {\n id\n title\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 priceLists(first: 1, reverse: true) {\n nodes {\n id\n currency\n fixedPricesCount\n catalog {\n id\n title\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 priceLists(first: 1, reverse: true) {\n nodes {\n id\n currency\n fixedPricesCount\n catalog {\n id\n title\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 priceLists(first: 1, reverse: true) {\n nodes {\n id\n currency\n fixedPricesCount\n catalog {\n id\n title\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [] }, { "example": { "type_name": "pricelists", "title": "Retrieve the ID, name, currency and quantity rules information", "description": "Fetch the first price list and retrieves the ID, currency, and fetches the first three fixed quantity rules associated with that price list, including the increment, maximum, minimum values for each rule, and the product variant it is on.", "query_string": "query {\n priceLists(first: 1) {\n nodes {\n id\n name\n currency\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n }\n }\n}", "response": { "data": { "priceLists": { "nodes": [ { "id": "gid://shopify/PriceList/225060712", "name": "price_list_with_quantity_rules", "currency": "USD", "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" } } ] } } ] } } }, "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 { priceLists(first: 1) { nodes { id name currency quantityRules(first: 3, originType: FIXED) { nodes { increment maximum minimum productVariant { id title } } } } } }\"\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceLists(first: 1) {\n nodes {\n id\n name\n currency\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\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 priceLists(first: 1) {\n nodes {\n id\n name\n currency\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\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 priceLists(first: 1) {\n nodes {\n id\n name\n currency\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\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 priceLists(first: 1) {\n nodes {\n id\n name\n currency\n quantityRules(first: 3, originType: FIXED) {\n nodes {\n increment\n maximum\n minimum\n productVariant {\n id\n title\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [] }, { "example": { "type_name": "pricelists", "title": "Retrieve the first two price lists", "description": "Fetches the first two price lists. For each price list, it retrieves the ID, name, currency, and the count of fixed prices. It also fetches the adjustment type and value of the price list.", "query_string": "query {\n priceLists(first: 2) {\n edges {\n node {\n id\n name\n currency\n fixedPricesCount\n parent {\n adjustment {\n type\n value\n }\n }\n }\n }\n }\n}", "response": { "data": { "priceLists": { "edges": [ { "node": { "id": "gid://shopify/PriceList/11668351", "name": "location_price_list", "currency": "USD", "fixedPricesCount": 0, "parent": { "adjustment": { "type": "PERCENTAGE_DECREASE", "value": 50 } } } }, { "node": { "id": "gid://shopify/PriceList/36142538", "name": "relative_pricelist_nullify", "currency": "CAD", "fixedPricesCount": 0, "parent": { "adjustment": { "type": "PERCENTAGE_DECREASE", "value": 5 } } } } ] } } }, "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 { priceLists(first: 2) { edges { node { id name currency fixedPricesCount 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 priceLists(first: 2) {\n edges {\n node {\n id\n name\n currency\n fixedPricesCount\n parent {\n adjustment {\n type\n value\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 priceLists(first: 2) {\n edges {\n node {\n id\n name\n currency\n fixedPricesCount\n parent {\n adjustment {\n type\n value\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 priceLists(first: 2) {\n edges {\n node {\n id\n name\n currency\n fixedPricesCount\n parent {\n adjustment {\n type\n value\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 priceLists(first: 2) {\n edges {\n node {\n id\n name\n currency\n fixedPricesCount\n parent {\n adjustment {\n type\n value\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [] } ]