publishablePublish
mutation

Choose a version:

Requires write_publications access scope. Also: The user must have permission to create and edit products or create and edit catalogs.

Publishes a resource to a 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.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The resource to create or update publications for.
Anchor to input input [PublicationInput!]! required: Specifies the input fields required to publish a resource.

Was this section helpful?

Anchor to section titled 'PublishablePublishPayload returns'

PublishablePublishPayload returns

Anchor to PublishablePublishPayload.publishable publishable Publishable: Resource that has been published.
Anchor to PublishablePublishPayload.shop shop Shop! non-null: The user's shop.
Anchor to PublishablePublishPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: publishablePublish

Query Reference for MUTATION: publishablePublish

"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\n    publishable {\n      # Publishable fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: publishablePublish

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"input\": [\n    {\n      \"publicationId\": \"gid://shopify/<objectName>/10079785100\",\n      \"publishDate\": \"2019-09-07T15:50:00Z\"\n    }\n  ]\n}"

Schema Reference for MUTATION: publishablePublish

"input PublicationInput {\n  channelId: ID\n  publicationId: ID\n  publishDate: DateTime\n}\n"

Display Examples for MUTATION: publishablePublish

[
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a collection with a publication ID",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Collection/636030761",
        "input": {
          "publicationId": "gid://shopify/Publication/762454635"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": {
              "availablePublicationsCount": {
                "count": 1
              },
              "resourcePublicationsCount": {
                "count": 1
              }
            },
            "shop": {
              "publicationCount": 8
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Collection/636030761\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/636030761\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/636030761\",\n  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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/636030761\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/636030761\",\n  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/762454635\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Collection/636030761\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/762454635\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a product that does not belong to the shop",
      "description": "Attempting to publish a product that does not belong to the same shop returns an error.\n",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Product/921728736",
        "input": {
          "publicationId": "gid://shopify/Publication/762454635"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": null,
            "shop": {
              "publicationCount": 8
            },
            "userErrors": [
              {
                "field": [
                  "id"
                ],
                "message": "Resource does not exist"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/921728736\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/762454635\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Product/921728736\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/762454635\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a product that does not exist",
      "description": "Attempting to publish a product that does not exists returns an error.\n",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Product/0",
        "input": {
          "publicationId": "gid://shopify/Publication/762454635"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": null,
            "shop": {
              "publicationCount": 8
            },
            "userErrors": [
              {
                "field": [
                  "id"
                ],
                "message": "Resource does not exist"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/0\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/0\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/0\",\n  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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/0\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/0\",\n  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/762454635\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Product/0\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/762454635\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a product with a future publication date",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Product/558169081",
        "input": {
          "publicationId": "gid://shopify/Publication/762454635",
          "publishDate": "2999-01-01T00:00:00-00:00"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": {
              "availablePublicationsCount": {
                "count": 0
              },
              "resourcePublicationsCount": {
                "count": 0
              }
            },
            "shop": {
              "publicationCount": 8
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/558169081\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/762454635\",\n      \"publishDate\": \"2999-01-01T00:00:00-00:00\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\",\n        \"publishDate\": \"2999-01-01T00:00:00-00:00\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/762454635\",\n    \"publishDate\": \"2999-01-01T00:00:00-00:00\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\",\n        \"publishDate\": \"2999-01-01T00:00:00-00:00\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/762454635\",\n    \"publishDate\" => \"2999-01-01T00:00:00-00:00\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Product/558169081\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/762454635\",\"publishDate\":\"2999-01-01T00:00:00-00:00\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a product with a publication ID",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Product/558169081",
        "input": {
          "publicationId": "gid://shopify/Publication/762454635"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": {
              "availablePublicationsCount": {
                "count": 1
              },
              "resourcePublicationsCount": {
                "count": 1
              }
            },
            "shop": {
              "publicationCount": 8
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/558169081\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/762454635\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/762454635\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Product/558169081\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/762454635\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "publishablepublish",
      "title": "Publish a product with an invalid publication ID",
      "description": "Attempting to publish a product with an invalid publication ID returns an error.\n",
      "query_string": "mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n  publishablePublish(id: $id, input: $input) {\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}",
      "variables": {
        "id": "gid://shopify/Product/558169081",
        "input": {
          "publicationId": "gid://shopify/Publication/0"
        }
      },
      "response": {
        "data": {
          "publishablePublish": {
            "publishable": {
              "availablePublicationsCount": {
                "count": 0
              },
              "resourcePublicationsCount": {
                "count": 0
              }
            },
            "shop": {
              "publicationCount": 8
            },
            "userErrors": [
              {
                "field": [
                  "input",
                  "0",
                  "publicationId"
                ],
                "message": "Publication does not exist or is not publishable"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_publish_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) { publishablePublish(id: $id, input: $input) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/558169081\",\n    \"input\": {\n      \"publicationId\": \"gid://shopify/Publication/0\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/0\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\": {\n    \"publicationId\": \"gid://shopify/Publication/0\"\n  }\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\": `mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n      publishablePublish(id: $id, input: $input) {\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/558169081\",\n      \"input\": {\n        \"publicationId\": \"gid://shopify/Publication/0\"\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  mutation publishablePublish($id: ID!, $input: [PublicationInput!]!) {\n    publishablePublish(id: $id, input: $input) {\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/558169081\",\n  \"input\" => [\n    \"publicationId\" => \"gid://shopify/Publication/0\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The resource to create or update publications for.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Product/558169081\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "input",
          "description": "Specifies the input fields required to publish a resource.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PublicationInput",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[PublicationInput!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"publicationId\":\"gid://shopify/Publication/0\"}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

publishablePublishmutation

Arguments

PublishablePublishPayload returns

publishablePublish
mutation