Skip to main content

registerRoutingStrategy

Registers a new routing strategy for the current company.

Business Rules​

  • The name is required, must be 1-255 characters, and unique within the company.
  • Every building must belong to the current company.
  • maxFulfillments cannot exceed the number of included buildings.

Error Scenarios​

  • **NOT_FOUND**: when the company or a building does not exist.
  • **BAD_REQUEST**: when the name is missing, too long or already in use, the strategy is unknown, or maxFulfillments exceeds the included buildings.

Permissions Required​

  • orders:register_routing_strategy permission
registerRoutingStrategy(
  input: RegisterRoutingStrategyInput!
): RoutingStrategy

Arguments​

registerRoutingStrategy.input ● RegisterRoutingStrategyInput! non-null input common​

Parameters for RegisterRoutingStrategy

Type​

RoutingStrategy object orders​

Routing Strategy​

A reusable, company-owned definition of how an order's fulfillments are split across buildings: which buildings and in what priority, the algorithm, and the maximum number of fulfillments. Applied to an order to create its fulfillments.