Anchor to publishableUnpublishpublishable
publishable Unpublish
mutation
Requires access scope. Also: The user must have permission to create and edit products or create and edit catalogs.
Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is active
.
Anchor to Arguments
Arguments
- •ID!required
The resource to delete or update publications for.
- Anchor to inputinput•[Publication
Input!]!required Specifies the input fields required to unpublish a resource.
Was this section helpful?
- Anchor to publishablepublishable•
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Was this section helpful?
- Delete a collection listing to unpublish a collection from your app
- Delete a product listing to unpublish a product from your app
- Error response
- Unpublish a product from a channel
- Unpublish a product from a non-existing channel
- Unpublish a product from a non-existing publication
- Unpublish a product from a publication
- Unpublish a product using both a channel ID and publication ID
- publishableUnpublish reference
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {6 publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {7 publishable {8 publishedOnPublication(publicationId: $publicationId)9 }10 userErrors {11 field12 message13 }14 }15 }`,16 {17 variables: {18 "collectionId": "gid://shopify/Collection/142458073",19 "publicationId": "gid://shopify/Publication/762454635"20 },21 },22);2324const data = await response.json();25
mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {
publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {
publishable {
publishedOnPublication(publicationId: $publicationId)
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) { publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) { publishable { publishedOnPublication(publicationId: $publicationId) } userErrors { field message } } }",
"variables": {
"collectionId": "gid://shopify/Collection/142458073",
"publicationId": "gid://shopify/Publication/762454635"
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {
publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {
publishable {
publishedOnPublication(publicationId: $publicationId)
}
userErrors {
field
message
}
}
}`,
{
variables: {
"collectionId": "gid://shopify/Collection/142458073",
"publicationId": "gid://shopify/Publication/762454635"
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {
publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {
publishable {
publishedOnPublication(publicationId: $publicationId)
}
userErrors {
field
message
}
}
}`,
"variables": {
"collectionId": "gid://shopify/Collection/142458073",
"publicationId": "gid://shopify/Publication/762454635"
},
},
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {
publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {
publishable {
publishedOnPublication(publicationId: $publicationId)
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"collectionId": "gid://shopify/Collection/142458073",
"publicationId": "gid://shopify/Publication/762454635"
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "collectionId": "gid://shopify/Collection/142458073",3 "publicationId": "gid://shopify/Publication/762454635"4}
Response
JSON1{2 "publishableUnpublish": {3 "publishable": {4 "publishedOnPublication": false5 },6 "userErrors": []7 }8}