API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

fulfillmentOrderSubmitCancellationRequest mutation

Version unstable

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

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

Required access

write_third_party_fulfillment_orders access scope.

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.


Arguments

Argument Description
id ( ID! ) required

The ID of the fulfillment order associated with the cancellation request.

message ( String )

An optional reason for the cancellation request.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order whose cancellation was requested.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.