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

fulfillmentOrderMove mutation

Version unstable

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Moves a fulfillment order to a new location.

Required access

write_merchant_managed_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 be moved.
newLocationId ( ID! ) required

The ID of the location where the fulfillment order will be moved.

Return fields

  • movedFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing all items that were able to be moved to the new location.

  • originalFulfillmentOrder (FulfillmentOrder)

    The fulfillment order that was moved. On success, this fulfillment order will be closed.

  • remainingFulfillmentOrder (FulfillmentOrder)

    A new fulfillment order representing any items still assigned to the original location. This is created if all line items on the original fulfillment order could not be moved to the new location due to not being stocked there.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.