fulfillmentOrderSubmitCancellationRequest mutation

Sends a cancellation request to the fulfillment service of a fulfillment order.

Required access

write_third_party_fulfillment_orders access scope.

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 fulfillmentOrderSubmitCancellationRequest($id: ID!) { fulfillmentOrderSubmitCancellationRequest(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;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <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 associated with the cancellation request.
message
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    The fulfillment order whose cancellation was requested.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.