publishablePublishToCurrentChannel - admin-graphql - MUTATION

Version: 2024-04

Description:

Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores.

Access Scopes

`write_publications` access scope. Also: The user must have a permission to create and edit products.

Arguments

• id: ID! - The resource to create or update publications for.

Returns

• publishable: Publishable Resource that has been published.
• shop: Shop! The user's shop.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Publish a product to the current channel

          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\": \"mutation publishablePublishToCurrentChannel($id: ID!) { publishablePublishToCurrentChannel(id: $id) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/921728736\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation publishablePublishToCurrentChannel($id: ID!) {\n      publishablePublishToCurrentChannel(id: $id) {\n        publishable {\n          availablePublicationsCount {\n            count\n          }\n          resourcePublicationsCount {\n            count\n          }\n        }\n        shop {\n          publicationCount\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Product/921728736\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Product/921728736\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Product/921728736\",\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Product/921728736\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation publishablePublishToCurrentChannel($id: ID!) {\n  publishablePublishToCurrentChannel(id: $id) {\n    publishable {\n      availablePublicationsCount {\n        count\n      }\n      resourcePublicationsCount {\n        count\n      }\n    }\n    shop {\n      publicationCount\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Product/921728736"
  }

  response: {
    "data": {
      "publishablePublishToCurrentChannel": {
        "publishable": {
          "availablePublicationsCount": {
            "count": 2
          },
          "resourcePublicationsCount": {
            "count": 2
          }
        },
        "shop": {
          "publicationCount": 3
        },
        "userErrors": []
      }
    }
  }

  Publish a publication to the current channel

          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\": \"mutation publishablePublishToCurrentChannel($id: ID!) { publishablePublishToCurrentChannel(id: $id) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Collection/841564295\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation publishablePublishToCurrentChannel($id: ID!) {\n      publishablePublishToCurrentChannel(id: $id) {\n        publishable {\n          availablePublicationsCount {\n            count\n          }\n          resourcePublicationsCount {\n            count\n          }\n        }\n        shop {\n          publicationCount\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Collection/841564295\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Collection/841564295\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Collection/841564295\",\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Collection/841564295\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation publishablePublishToCurrentChannel($id: ID!) {\n  publishablePublishToCurrentChannel(id: $id) {\n    publishable {\n      availablePublicationsCount {\n        count\n      }\n      resourcePublicationsCount {\n        count\n      }\n    }\n    shop {\n      publicationCount\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Collection/841564295"
  }

  response: {
    "data": {
      "publishablePublishToCurrentChannel": {
        "publishable": {
          "availablePublicationsCount": {
            "count": 2
          },
          "resourcePublicationsCount": {
            "count": 2
          }
        },
        "shop": {
          "publicationCount": 3
        },
        "userErrors": []
      }
    }
  }

  Publishing a product that does not exist

          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\": \"mutation publishablePublishToCurrentChannel($id: ID!) { publishablePublishToCurrentChannel(id: $id) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/non-existent_product_id\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation publishablePublishToCurrentChannel($id: ID!) {\n      publishablePublishToCurrentChannel(id: $id) {\n        publishable {\n          availablePublicationsCount {\n            count\n          }\n          resourcePublicationsCount {\n            count\n          }\n        }\n        shop {\n          publicationCount\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Product/non-existent_product_id\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Product/non-existent_product_id\"\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Product/non-existent_product_id\",\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  mutation publishablePublishToCurrentChannel($id: ID!) {\n    publishablePublishToCurrentChannel(id: $id) {\n      publishable {\n        availablePublicationsCount {\n          count\n        }\n        resourcePublicationsCount {\n          count\n        }\n      }\n      shop {\n        publicationCount\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Product/non-existent_product_id\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation publishablePublishToCurrentChannel($id: ID!) {\n  publishablePublishToCurrentChannel(id: $id) {\n    publishable {\n      availablePublicationsCount {\n        count\n      }\n      resourcePublicationsCount {\n        count\n      }\n    }\n    shop {\n      publicationCount\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Product/non-existent_product_id"
  }

  response: {
    "data": {
      "publishablePublishToCurrentChannel": {
        "publishable": null,
        "shop": {
          "publicationCount": 3
        },
        "userErrors": [
          {
            "field": [
              "id"
            ],
            "message": "Resource does not exist"
          }
        ]
      }
    }
  }