publication - admin-graphql - QUERY

Version: 2024-01

Description:

Lookup a publication by ID.

Access Scopes

Arguments

• id: ID! - The ID of the Publication to return.

Returns

• app: App! The app associated with the publication.
• autoPublish: Boolean! Whether new products are automatically published to this publication.
• catalog: Catalog The catalog associated with the publication.
• hasCollection: Boolean! Whether the collection is available to the publication.
• id: ID! A globally-unique ID.
• name: String! Name of the publication.
• operation: PublicationOperation A background operation associated with this publication.
• supportsFuturePublishing: Boolean! Whether the publication supports future publishing.

Examples

• Retrieve a publication that doesn't exist

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/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"
          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"
          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"
          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"
          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"
          Graphql 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}"
        

  input: {
    "id": "gid://shopify/Publication/-1"
  }

  response: {
    "data": {
      "publication": null
    }
  }

  Retrieve an existing publication

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/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"
          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"
          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"
          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"
          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"
          Graphql 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}"
        

  input: {
    "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"
              }
            }
          ]
        }
      }
    }
  }