Anchor to section titled 'undefined'publishable
publishable
mutation
Unstable
Requires write access scope. Also: The user must have a permission to create and edit products.
Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.
Anchor to section titled 'Arguments'
Arguments
The resource to delete or update publications for.
Was this section helpful?
Anchor to section titled 'PublishableUnpublishToCurrentChannelPayload returns'
PublishableUnpublishToCurrentChannelPayload returns
Resource that has been unpublished.
The user's shop.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: publishableUnpublishToCurrentChannel
Query Reference for MUTATION: publishableUnpublishToCurrentChannel
"mutation publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(id: $id) {\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: publishableUnpublishToCurrentChannel
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: publishableUnpublishToCurrentChannel
""
Display Examples for MUTATION: publishableUnpublishToCurrentChannel
[
{
"example": {
"type_name": "publishableunpublishtocurrentchannel",
"title": "Unpublish a product from the current channel",
"query_string": "mutation publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(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}",
"variables": {
"id": "gid://shopify/Product/921728736"
},
"response": {
"data": {
"publishableUnpublishToCurrentChannel": {
"publishable": {
"availablePublicationsCount": {
"count": 1
},
"resourcePublicationsCount": {
"count": 1
}
},
"shop": {
"publicationCount": 3
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/publishable_unpublish_to_current_channel_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 publishableUnpublishToCurrentChannel($id: ID!) { publishableUnpublishToCurrentChannel(id: $id) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Product/921728736\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(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",
"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 publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(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",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation publishableUnpublishToCurrentChannel($id: ID!) {\n publishableUnpublishToCurrentChannel(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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The resource to delete 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"
}
]
}
]