publishableUnpublishToCurrentChannel

mutation

Requires write_publications 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.

Arguments

Anchor to idid • ID!required: The resource to delete or update publications for.

Was this section helpful?

Anchor to PublishableUnpublishToCurrentChannelPayload returnsPublishableUnpublishToCurrentChannelPayload returns

Anchor to publishablepublishable • Publishable: Resource that has been unpublished.
Anchor to shopshop • Shop!non-null: The user's shop.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Unpublish a product from the current channel
publishableUnpublishToCurrentChannel reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation publishableUnpublishToCurrentChannel($id: ID!) {
6    publishableUnpublishToCurrentChannel(id: $id) {
7      publishable {
8        availablePublicationsCount {
9          count
10        }
11        resourcePublicationsCount {
12          count
13        }
14      }
15      shop {
16        publicationCount
17      }
18      userErrors {
19        field
20        message
21      }
22    }
23  }`,
24  {
25    variables: {
26      "id": "gid://shopify/Product/921728736"
27    },
28  },
29);
30
31const data = await response.json();
32

mutation publishableUnpublishToCurrentChannel($id: ID!) {
  publishableUnpublishToCurrentChannel(id: $id) {
    publishable {
      availablePublicationsCount {
        count
      }
      resourcePublicationsCount {
        count
      }
    }
    shop {
      publicationCount
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation publishableUnpublishToCurrentChannel($id: ID!) { publishableUnpublishToCurrentChannel(id: $id) { publishable { availablePublicationsCount { count } resourcePublicationsCount { count } } shop { publicationCount } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Product/921728736"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation publishableUnpublishToCurrentChannel($id: ID!) {
    publishableUnpublishToCurrentChannel(id: $id) {
      publishable {
        availablePublicationsCount {
          count
        }
        resourcePublicationsCount {
          count
        }
      }
      shop {
        publicationCount
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Product/921728736"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation publishableUnpublishToCurrentChannel($id: ID!) {
      publishableUnpublishToCurrentChannel(id: $id) {
        publishable {
          availablePublicationsCount {
            count
          }
          resourcePublicationsCount {
            count
          }
        }
        shop {
          publicationCount
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Product/921728736"
    },
  },
});

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 publishableUnpublishToCurrentChannel($id: ID!) {
    publishableUnpublishToCurrentChannel(id: $id) {
      publishable {
        availablePublicationsCount {
          count
        }
        resourcePublicationsCount {
          count
        }
      }
      shop {
        publicationCount
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Product/921728736"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/Product/921728736"
3}

Response

JSON

1{
2  "publishableUnpublishToCurrentChannel": {
3    "publishable": {
4      "availablePublicationsCount": {
5        "count": 1
6      },
7      "resourcePublicationsCount": {
8        "count": 1
9      }
10    },
11    "shop": {
12      "publicationCount": 3
13    },
14    "userErrors": []
15  }
16}