publishableUnpublish - admin-graphql - MUTATION

Version: 2024-01

Description:

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`.

Access Scopes

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

Arguments

• id: ID! - The resource to delete or update publications for.
• input: PublicationInput! - Specifies the input fields required to unpublish a resource.

Returns

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

Examples

• Delete a collection listing to unpublish a collection from your app

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) { publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) { publishable { publishedOnPublication(publicationId: $publicationId) } userErrors { field message } } }\",\n \"variables\": {\n    \"collectionId\": \"gid://shopify/Collection/142458073\",\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {\n      publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {\n        publishable {\n          publishedOnPublication(publicationId: $publicationId)\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"collectionId\": \"gid://shopify/Collection/142458073\",\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\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 PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"collectionId\": \"gid://shopify/Collection/142458073\",\n  \"publicationId\": \"gid://shopify/Publication/762454635\"\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 PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"collectionId\" => \"gid://shopify/Collection/142458073\",\n  \"publicationId\" => \"gid://shopify/Publication/762454635\",\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 PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"collectionId\": \"gid://shopify/Collection/142458073\",\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PublishableUnpublish($collectionId: ID!, $publicationId: ID!) {\n  publishableUnpublish(id: $collectionId, input: {publicationId: $publicationId}) {\n    publishable {\n      publishedOnPublication(publicationId: $publicationId)\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "collectionId": "gid://shopify/Collection/142458073",
    "publicationId": "gid://shopify/Publication/762454635"
  }

  response: {
    "data": {
      "publishableUnpublish": {
        "publishable": {
          "publishedOnPublication": false
        },
        "userErrors": []
      }
    }
  }

  Delete a product listing to unpublish a product from your app

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PublishableUnpublish($productId: ID!, $publicationId: ID!) { publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) { publishable { publishedOnPublication(publicationId: $publicationId) } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/108828309\",\n    \"publicationId\": \"gid://shopify/Publication/762454635\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PublishableUnpublish($productId: ID!, $publicationId: ID!) {\n      publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) {\n        publishable {\n          publishedOnPublication(publicationId: $publicationId)\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\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 PublishableUnpublish($productId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/108828309\",\n  \"publicationId\": \"gid://shopify/Publication/762454635\"\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 PublishableUnpublish($productId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/108828309\",\n  \"publicationId\" => \"gid://shopify/Publication/762454635\",\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 PublishableUnpublish($productId: ID!, $publicationId: ID!) {\n    publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) {\n      publishable {\n        publishedOnPublication(publicationId: $publicationId)\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"publicationId\": \"gid://shopify/Publication/762454635\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PublishableUnpublish($productId: ID!, $publicationId: ID!) {\n  publishableUnpublish(id: $productId, input: {publicationId: $publicationId}) {\n    publishable {\n      publishedOnPublication(publicationId: $publicationId)\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/108828309",
    "publicationId": "gid://shopify/Publication/762454635"
  }

  response: {
    "data": {
      "publishableUnpublish": {
        "publishable": {
          "publishedOnPublication": false
        },
        "userErrors": []
      }
    }
  }