Skip to main content

RegisterRoutingStrategyInput

Autogenerated input type of RegisterRoutingStrategy

input RegisterRoutingStrategyInput {
  buildings: [RoutingBuildingInput!]!
  clientMutationId: String
  description: String
  destinationGrouping: DestinationGroupingEnum
  fallbackWarehouseId: ID @deprecated
  fulfillmentStrategy: FulfillmentStrategyEnum!
  maxFulfillments: Int!
  name: String!
  shortfallPolicy: ShortfallPolicyEnum
}

Fields​

RegisterRoutingStrategyInput.buildings ● [RoutingBuildingInput!]! non-null input orders​

The buildings this strategy routes over.

RegisterRoutingStrategyInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

RegisterRoutingStrategyInput.description ● String scalar common​

Optional description of the routing strategy.

RegisterRoutingStrategyInput.destinationGrouping ● DestinationGroupingEnum enum orders​

How to group the order's destinations into fulfillments. Omit for a single destination.

RegisterRoutingStrategyInput.fallbackWarehouseId ● ID deprecated scalar common​

DEPRECATED

No longer affects routing. Use shortfallPolicy instead.

Formerly the building that took an order inventory could not cover.

RegisterRoutingStrategyInput.fulfillmentStrategy ● FulfillmentStrategyEnum! non-null enum orders​

How the strategy chooses buildings and splits the order.

RegisterRoutingStrategyInput.maxFulfillments ● Int! non-null scalar common​

Maximum number of inventory-backed fulfillments for a single order, or for each destination when destinationGrouping is set. A backorder created by shortfallPolicy does not count toward it, so an order may end up with one more fulfillment than this.

RegisterRoutingStrategyInput.name ● String! non-null scalar common​

The name of the routing strategy.

RegisterRoutingStrategyInput.shortfallPolicy ● ShortfallPolicyEnum enum orders​

What to do when no allowed set of buildings can source the whole order. Defaults to shipping what is available and backordering the rest. Only BACKORDER_REMAINDER and SINGLE_FULFILLMENT are valid when destinationGrouping is set, because a destination has to be planned in full.

Member Of​

registerRoutingStrategy mutation