Choose a version:

fulfillmentServiceDelete

mutation

Requires write_fulfillments access scope. Also: The user must have fulfill_and_ship_orders permission.

Deletes a fulfillment service.

Arguments

Anchor to destinationLocationIddestinationLocationId

•ID

The ID of an active merchant managed location where inventory and commitments will be relocated after the fulfillment service is deleted.

Inventory will only be transferred if the TRANSFER inventory action has been chosen.

Anchor to idid

•ID!

required

The ID of the fulfillment service to delete.

Anchor to inventoryActioninventoryAction

•FulfillmentServiceDeleteInventoryAction

Default:TRANSFER

The action to take with the location after the fulfillment service is deleted.

Was this section helpful?

Anchor to FulfillmentServiceDeletePayload returnsFulfillmentServiceDeletePayload returns

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

Was this section helpful?

Examples

Remove an existing FulfillmentService

Description

Delete a fulfillment service and relocate inventory and commitments to a new location.

Query

mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
  fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "destinationLocationId": "gid://shopify/Location/124656943",
  "id": "gid://shopify/FulfillmentService/198258461"
}

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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) { fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) { deletedId userErrors { field message } } }",
 "variables": {
    "destinationLocationId": "gid://shopify/Location/124656943",
    "id": "gid://shopify/FulfillmentService/198258461"
  }
}'

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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "destinationLocationId": "gid://shopify/Location/124656943",
        "id": "gid://shopify/FulfillmentService/198258461"
    },
  },
  );
  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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "destinationLocationId": "gid://shopify/Location/124656943",
  "id": "gid://shopify/FulfillmentService/198258461"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
      fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "destinationLocationId": "gid://shopify/Location/124656943",
        "id": "gid://shopify/FulfillmentService/198258461"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
  fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
    deletedId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "destinationLocationId": "gid://shopify/Location/124656943",
  "id": "gid://shopify/FulfillmentService/198258461"
}'

Direct API Access

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

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

Response

{
  "fulfillmentServiceDelete": {
    "deletedId": "gid://shopify/FulfillmentService/198258461",
    "userErrors": []
  }
}

fulfillmentServiceDelete 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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {

fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {

deletedId

userErrors {

field

message

}

}`,

{

variables: {

"destinationLocationId": "gid://shopify/Location/124656943",

"id": "gid://shopify/FulfillmentService/198258461"

);

const json = await response.json();

return json.data;

}

GQL

mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
  fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
    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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) { fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) { deletedId userErrors { field message } } }",
 "variables": {
    "destinationLocationId": "gid://shopify/Location/124656943",
    "id": "gid://shopify/FulfillmentService/198258461"
  }
}'

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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "destinationLocationId": "gid://shopify/Location/124656943",
        "id": "gid://shopify/FulfillmentService/198258461"
    },
  },
  );
  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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
      fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "destinationLocationId": "gid://shopify/Location/124656943",
        "id": "gid://shopify/FulfillmentService/198258461"
    },
  },
});

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

variables = {
  "destinationLocationId": "gid://shopify/Location/124656943",
  "id": "gid://shopify/FulfillmentService/198258461"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {
  fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {
    deletedId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "destinationLocationId": "gid://shopify/Location/124656943",
  "id": "gid://shopify/FulfillmentService/198258461"
}'

Direct API Access

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

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

Input variables

JSON

{

"destinationLocationId": "gid://shopify/Location/124656943",

"id": "gid://shopify/FulfillmentService/198258461"

}

Response

JSON

{

"fulfillmentServiceDelete": {

"deletedId": "gid://shopify/FulfillmentService/198258461",

"userErrors": []

}