Choose a version:

Anchor to collectionConditionsSourceDelete

collectionConditionsSourceDelete

mutation

Requires write_products access scope. Also: The store must not be on the Starter or Retail plans and the user must have permission to delete a collection source.

Deletes a shareable collection source owned by the calling app.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the source to delete.

Was this section helpful?

Anchor to CollectionConditionsSourceDeletePayload returnsCollectionConditionsSourceDeletePayload returns

Anchor to deletedIddeletedId •ID: The ID of the deleted collection source.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete a shareable collection source

Description

Delete a shareable collection source owned by the calling app. If the source is linked to collections, deleting it also unlinks it from those collections.

Query

mutation CollectionConditionsSourceDelete($id: ID!) {
  collectionConditionsSourceDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/CollectionConditionsSource/129168209"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CollectionConditionsSourceDelete($id: ID!) { collectionConditionsSourceDelete(id: $id) { deletedId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CollectionConditionsSource/129168209"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation CollectionConditionsSourceDelete($id: ID!) {
    collectionConditionsSourceDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 CollectionConditionsSourceDelete($id: ID!) {
    collectionConditionsSourceDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CollectionConditionsSource/129168209"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CollectionConditionsSourceDelete($id: ID!) {
      collectionConditionsSourceDelete(id: $id) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation CollectionConditionsSourceDelete($id: ID!) {
  collectionConditionsSourceDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CollectionConditionsSource/129168209"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation CollectionConditionsSourceDelete($id: ID!) {
        collectionConditionsSourceDelete(id: $id) {
          deletedId
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "collectionConditionsSourceDelete": {
    "deletedId": "gid://shopify/CollectionConditionsSource/129168209",
    "userErrors": []
  }
}

collectionConditionsSourceDelete reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation CollectionConditionsSourceDelete($id: ID!) {

collectionConditionsSourceDelete(id: $id) {

deletedId

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/CollectionConditionsSource/129168209"

);

const json = await response.json();

return json.data;

}

GQL

mutation CollectionConditionsSourceDelete($id: ID!) {
  collectionConditionsSourceDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CollectionConditionsSourceDelete($id: ID!) { collectionConditionsSourceDelete(id: $id) { deletedId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CollectionConditionsSource/129168209"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation CollectionConditionsSourceDelete($id: ID!) {
    collectionConditionsSourceDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CollectionConditionsSourceDelete($id: ID!) {
      collectionConditionsSourceDelete(id: $id) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  },
});

Ruby

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 CollectionConditionsSourceDelete($id: ID!) {
    collectionConditionsSourceDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CollectionConditionsSource/129168209"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation CollectionConditionsSourceDelete($id: ID!) {
  collectionConditionsSourceDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CollectionConditionsSource/129168209"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation CollectionConditionsSourceDelete($id: ID!) {
        collectionConditionsSourceDelete(id: $id) {
          deletedId
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/CollectionConditionsSource/129168209"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/CollectionConditionsSource/129168209"

}

Response

JSON

{

"collectionConditionsSourceDelete": {

"deletedId": "gid://shopify/CollectionConditionsSource/129168209",

"userErrors": []

}