fulfillmentOrderClose mutation

Version unstable

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Required access

write_assigned_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 to mark as incomplete.

message ( String )

An optional reason for marking the fulfillment order as incomplete.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was marked as incomplete.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Required access

write_assigned_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 to mark as incomplete.

message ( String )

An optional reason for marking the fulfillment order as incomplete.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was marked as incomplete.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Required access

write_assigned_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 to mark as incomplete.

message ( String )

An optional reason for marking the fulfillment order as incomplete.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was marked as incomplete.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-04

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Required access

write_assigned_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 to mark as incomplete.

message ( String )

An optional reason for marking the fulfillment order as incomplete.

Return fields

  • fulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was marked as incomplete.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-01

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Required access

write_assigned_fulfillment_orders access scope.