fulfillmentServiceDelete - admin-graphql - MUTATION

Version: 2024-10

Description:

Deletes a fulfillment service.

Access Scopes

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

Arguments

• destinationLocationId: ID - The ID of the location where inventory and commitments will be relocated after the fulfillment service is deleted.
• id: ID! - The ID of the fulfillment service to delete.
• inventoryAction: FulfillmentServiceDeleteInventoryAction - The action to take with the location after the fulfillment service is deleted.

Returns

• deletedId: ID The ID of the deleted fulfillment service.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Remove an existing FulfillmentService

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) { fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) { deletedId userErrors { field message } } }\",\n \"variables\": {\n    \"destinationLocationId\": \"gid://shopify/Location/124656943\",\n    \"id\": \"gid://shopify/FulfillmentService/198258461\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n      fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n        deletedId\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"destinationLocationId\": \"gid://shopify/Location/124656943\",\n      \"id\": \"gid://shopify/FulfillmentService/198258461\"\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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n      deletedId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"destinationLocationId\": \"gid://shopify/Location/124656943\",\n  \"id\": \"gid://shopify/FulfillmentService/198258461\"\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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n      deletedId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"destinationLocationId\" => \"gid://shopify/Location/124656943\",\n  \"id\" => \"gid://shopify/FulfillmentService/198258461\",\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 fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n    fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n      deletedId\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"destinationLocationId\": \"gid://shopify/Location/124656943\",\n      \"id\": \"gid://shopify/FulfillmentService/198258461\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n  fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n    deletedId\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

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