Skip to main content
Shopify.devShopify.devDocs
Log inSign up
Anchor to fulfillmentOrdersReroute

fulfillmentOrdersReroute

mutation

Requires write_assigned_fulfillment_orders access scope, write_merchant_managed_fulfillment_orders access scope or write_third_party_fulfillment_orders access scope. Also: The user must have the fulfill_and_ship_orders permission or the calling API client must be Shopify POS.

Route the fulfillment orders to an alternative location, according to the shop's order routing settings. This involves:

  • Finding an alternate location that can fulfill the fulfillment orders.
  • Assigning the fulfillment orders to the new location.
Anchor to Arguments

Arguments

Anchor to excludedLocationIdsexcludedLocationIds
•
[ID!]

The list of IDs of the locations to exclude for rerouting. Excluded locations specified here take precedence over included locations provided through included_location_ids.

Anchor to fulfillmentOrderIdsfulfillmentOrderIds
•
[ID!]!required

The list of IDs of the fulfillment orders.

Anchor to includedLocationIdsincludedLocationIds
•
[ID!]

The list of IDs of the locations to include for rerouting. By default, all locations are included.

Was this section helpful?

Anchor to FulfillmentOrdersReroutePayload returnsFulfillmentOrdersReroutePayload returns

Anchor to movedFulfillmentOrdersmovedFulfillmentOrders
•
[FulfillmentOrder!]

The fulfillment orders which contains the moved line items.

Anchor to userErrorsuserErrors
•
[FulfillmentOrdersRerouteUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?