Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
2024-04
Requires write access scope. Also: The user must have fulfill_and_ship_orders permission.
Deletes a fulfillment service.
Anchor to section titled 'Arguments'
Arguments
- Anchor to destinationLocationIddestinationLocationId
The ID of the location where inventory and commitments will be relocated after the fulfillment service is deleted.
The ID of the fulfillment service to delete.
Was this section helpful?
Anchor to section titled 'FulfillmentServiceDeletePayload returns'
FulfillmentServiceDeletePayload returns
The ID of the deleted fulfillment service.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fulfillmentServiceDelete
Query Reference for MUTATION: fulfillmentServiceDelete
"mutation fulfillmentServiceDelete($id: ID!) {\n fulfillmentServiceDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentServiceDelete
"{\n \"destinationLocationId\": \"gid://shopify/<objectName>/10079785100\",\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: fulfillmentServiceDelete
""
Display Examples for MUTATION: fulfillmentServiceDelete
[
{
"example": {
"type_name": "fulfillmentservicedelete",
"title": "Delete a fulfillment service",
"description": "Delete a fulfillment service and relocate inventory and commitments to a new location.",
"query_string": "mutation fulfillmentServiceDelete($id: ID!, $destinationLocationId: ID) {\n fulfillmentServiceDelete(id: $id, destinationLocationId: $destinationLocationId) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"destinationLocationId": "gid://shopify/Location/124656943",
"id": "gid://shopify/FulfillmentService/198258461"
},
"response": {
"data": {
"fulfillmentServiceDelete": {
"deletedId": "gid://shopify/FulfillmentService/198258461",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_service_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "destinationLocationId",
"description": "The ID of the location where inventory and commitments will be relocated\nafter the fulfillment service is deleted.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "ID",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "destinationLocationId",
"argValue": " \"gid://shopify/Location/124656943\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "id",
"description": "The ID of the fulfillment service to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/FulfillmentService/198258461\"",
"typeKind": "MUTATION"
}
]
}
]