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

fulfillmentOrderClose mutation

Version 2021-01 (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

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!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (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

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!]!)

List of errors that occurred executing the mutation.

Version 2020-07

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

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!]!)

List of errors that occurred executing the mutation.

Version 2020-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

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!]!)

List of errors that occurred executing the mutation.

Version 2020-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.

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

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!]!)

List of errors that occurred executing the mutation.