publication
query

Choose a version:

Lookup a publication by ID.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the Publication to return.

Was this section helpful?

Anchor to section titled 'Publication possible returns'

Publication possible returns

Anchor to Publication Publication Publication: A publication is a group of products and collections that is published to an app.

Was this section helpful?

Code examples for QUERY: publication

Query Reference for QUERY: publication

"{\n  publication(id) {\n    # Publication fields\n  }\n}"

Input Reference for QUERY: publication

Schema Reference for QUERY: publication

Display Examples for QUERY: publication

[
  {
    "example": {
      "type_name": "publication",
      "title": "Retrieve a publication that doesn't exist",
      "description": "Retrieving a publication by an ID that doesn't exist returns `null`.\n",
      "query_string": "query publication($id: ID!) {\n  publication(id: $id) {\n    name\n    collections(first: 5) {\n      edges {\n        node {\n          id\n          title\n          updatedAt\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Publication/-1"
      },
      "response": {
        "data": {
          "publication": null
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/apps/test/unit/graph_api/admin/publication_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query publication($id: ID!) { publication(id: $id) { name collections(first: 5) { edges { node { id title updatedAt } } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Publication/-1\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Publication/-1\"\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 publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Publication/-1\"\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\": `query publication($id: ID!) {\n      publication(id: $id) {\n        name\n        collections(first: 5) {\n          edges {\n            node {\n              id\n              title\n              updatedAt\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Publication/-1\"\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 publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Publication/-1\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "publication",
      "title": "Retrieve an existing publication",
      "query_string": "query publication($id: ID!) {\n  publication(id: $id) {\n    name\n    collections(first: 5) {\n      edges {\n        node {\n          id\n          title\n          updatedAt\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Publication/244171671"
      },
      "response": {
        "data": {
          "publication": {
            "name": "Online Store",
            "collections": {
              "edges": [
                {
                  "node": {
                    "id": "gid://shopify/Collection/79210309",
                    "title": "Custom Other Items",
                    "updatedAt": "2008-10-10T00:00:00Z"
                  }
                },
                {
                  "node": {
                    "id": "gid://shopify/Collection/94229130",
                    "title": "All products more expensive than free",
                    "updatedAt": "2006-02-02T00:00:00Z"
                  }
                },
                {
                  "node": {
                    "id": "gid://shopify/Collection/142458073",
                    "title": "All snowboards",
                    "updatedAt": "2006-02-02T00:00:00Z"
                  }
                },
                {
                  "node": {
                    "id": "gid://shopify/Collection/411960790",
                    "title": "Bold snowboards",
                    "updatedAt": "2006-02-02T00:00:00Z"
                  }
                },
                {
                  "node": {
                    "id": "gid://shopify/Collection/431528632",
                    "title": "All arbor products tagged deepsnow",
                    "updatedAt": "2006-02-02T00:00:00Z"
                  }
                }
              ]
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/apps/test/unit/graph_api/admin/publication_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query publication($id: ID!) { publication(id: $id) { name collections(first: 5) { edges { node { id title updatedAt } } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Publication/244171671\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Publication/244171671\"\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 publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Publication/244171671\"\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\": `query publication($id: ID!) {\n      publication(id: $id) {\n        name\n        collections(first: 5) {\n          edges {\n            node {\n              id\n              title\n              updatedAt\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Publication/244171671\"\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 publication($id: ID!) {\n    publication(id: $id) {\n      name\n      collections(first: 5) {\n        edges {\n          node {\n            id\n            title\n            updatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Publication/244171671\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

publicationquery

Arguments

Publication possible returns

publication
query