Version: 2025-01
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query($identifier: ProductIdentifierInput!) { product: productByIdentifier(identifier: $identifier) { id handle title } }\",\n \"variables\": {\n \"identifier\": {\n \"customId\": {\n \"namespace\": \"custom\",\n \"key\": \"id\",\n \"value\": \"1001\"\n }\n }\n }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }`,\n \"variables\": {\n \"identifier\": {\n \"customId\": {\n \"namespace\": \"custom\",\n \"key\": \"id\",\n \"value\": \"1001\"\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 query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }\nQUERY\n\nvariables = {\n \"identifier\": {\n \"customId\": {\n \"namespace\": \"custom\",\n \"key\": \"id\",\n \"value\": \"1001\"\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 = <<<QUERY\n query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }\nQUERY;\n\n$variables = [\n \"identifier\" => [\n \"customId\" => [\n \"namespace\" => \"custom\",\n \"key\" => \"id\",\n \"value\" => \"1001\",\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 query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }`,\n {\n variables: {\n \"identifier\": {\n \"customId\": {\n \"namespace\": \"custom\",\n \"key\": \"id\",\n \"value\": \"1001\"\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n"
Graphql query: "query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n}"
input: {
"identifier": {
"customId": {
"namespace": "custom",
"key": "id",
"value": "1001"
}
}
}
response: {
"data": {
"product": {
"id": "gid://shopify/Product/20995642",
"handle": "element",
"title": "Element"
}
}
}
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query($identifier: ProductIdentifierInput!) { product: productByIdentifier(identifier: $identifier) { id handle title } }\",\n \"variables\": {\n \"identifier\": {\n \"handle\": \"boots\"\n }\n }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }`,\n \"variables\": {\n \"identifier\": {\n \"handle\": \"boots\"\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 query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }\nQUERY\n\nvariables = {\n \"identifier\": {\n \"handle\": \"boots\"\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 = <<<QUERY\n query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }\nQUERY;\n\n$variables = [\n \"identifier\" => [\n \"handle\" => \"boots\",\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 query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n }`,\n {\n variables: {\n \"identifier\": {\n \"handle\": \"boots\"\n }\n },\n },\n);\n\nconst data = await response.json();\n"
Graphql query: "query($identifier: ProductIdentifierInput!) {\n product: productByIdentifier(identifier: $identifier) {\n id\n handle\n title\n }\n}"
input: {
"identifier": {
"handle": "boots"
}
}
response: {
"data": {
"product": {
"id": "gid://shopify/Product/121709582",
"handle": "boots",
"title": "Boots"
}
}
}