fulfillmentOrderCancel mutation

Marks a fulfillment order as canceled.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation fulfillmentOrderCancel($id: ID!) { fulfillmentOrderCancel(id: $id) { 
  1. <font style="color:#1F61A0;">fulfillmentOrder</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">replacementFulfillmentOrder</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the fulfillment order to mark as canceled.

Return fields

  • fulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    The fulfillment order that was marked as canceled.
  • replacementFulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    The fulfillment order that was created to replace the canceled fulfillment order.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.