Anchor to fulfillmentOrderCancelfulfillment
fulfillmentOrderCancel
mutation
Requires access scope or
access scope. Also: The user must have fulfill_and_ship_orders permission.
Marks a fulfillment order as canceled.
Anchor to Arguments
Arguments
- •ID!required
The ID of the fulfillment order to mark as canceled.
Was this section helpful?
Anchor to FulfillmentOrderCancelPayload returnsFulfillmentOrderCancelPayload returns
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order that was marked as canceled.
- Anchor to replacementFulfillmentOrderreplacement•
Fulfillment Order The fulfillment order that was created to replace the canceled fulfillment order.
- Anchor to userErrorsuser•
Errors [UserError!]! non-null The list of errors that occurred from executing the mutation.
Was this section helpful?
- Cancel a fulfillment order
- fulfillmentOrderCancel reference
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 mutation fulfillmentOrderCancel($id: ID!) {6 fulfillmentOrderCancel(id: $id) {7 fulfillmentOrder {8 id9 status10 requestStatus11 }12 replacementFulfillmentOrder {13 id14 status15 requestStatus16 }17 userErrors {18 field19 message20 }21 }22 }`,23 {24 variables: {25 "id": "gid://shopify/FulfillmentOrder/1046000804"26 },27 },28);2930const data = await response.json();31
mutation fulfillmentOrderCancel($id: ID!) {
fulfillmentOrderCancel(id: $id) {
fulfillmentOrder {
id
status
requestStatus
}
replacementFulfillmentOrder {
id
status
requestStatus
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderCancel($id: ID!) { fulfillmentOrderCancel(id: $id) { fulfillmentOrder { id status requestStatus } replacementFulfillmentOrder { id status requestStatus } userErrors { field message } } }",
"variables": {
"id": "gid://shopify/FulfillmentOrder/1046000804"
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation fulfillmentOrderCancel($id: ID!) {
fulfillmentOrderCancel(id: $id) {
fulfillmentOrder {
id
status
requestStatus
}
replacementFulfillmentOrder {
id
status
requestStatus
}
userErrors {
field
message
}
}
}`,
{
variables: {
"id": "gid://shopify/FulfillmentOrder/1046000804"
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation fulfillmentOrderCancel($id: ID!) {
fulfillmentOrderCancel(id: $id) {
fulfillmentOrder {
id
status
requestStatus
}
replacementFulfillmentOrder {
id
status
requestStatus
}
userErrors {
field
message
}
}
}`,
"variables": {
"id": "gid://shopify/FulfillmentOrder/1046000804"
},
},
});
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 fulfillmentOrderCancel($id: ID!) {
fulfillmentOrderCancel(id: $id) {
fulfillmentOrder {
id
status
requestStatus
}
replacementFulfillmentOrder {
id
status
requestStatus
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"id": "gid://shopify/FulfillmentOrder/1046000804"
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "id": "gid://shopify/FulfillmentOrder/1046000804"3}
Response
JSON1{2 "fulfillmentOrderCancel": {3 "fulfillmentOrder": {4 "id": "gid://shopify/FulfillmentOrder/1046000804",5 "status": "CLOSED",6 "requestStatus": "SUBMITTED"7 },8 "replacementFulfillmentOrder": {9 "id": "gid://shopify/FulfillmentOrder/1046000805",10 "status": "OPEN",11 "requestStatus": "UNSUBMITTED"12 },13 "userErrors": []14 }15}