Skip to main content

RoutingStrategy

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.

type RoutingStrategy {
  archivedAt: ISO8601DateTime
  buildings: [RoutingBuilding!]!
  company: Party!
  companyId: ID!
  createdAt: ISO8601DateTime!
  description: String
  fulfillmentStrategy: FulfillmentStrategyEnum!
  id: ID!
  maxFulfillments: Int!
  name: String!
  updatedAt: ISO8601DateTime!
}

Fields

`RoutingStrategy.archivedAt` ● `ISO8601DateTime` scalar common

When the routing strategy was archived, if applicable.

`RoutingStrategy.buildings` ● `[RoutingBuilding!]!` non-null object orders

The buildings this strategy routes over, with priority and exclusion.

`RoutingStrategy.company` ● `Party!` non-null object common

The company that owns this routing strategy.

`RoutingStrategy.companyId` ● `ID!` non-null scalar common

ID of the company that owns this routing strategy.

`RoutingStrategy.createdAt` ● `ISO8601DateTime!` non-null scalar common

When the routing strategy was created.

`RoutingStrategy.description` ● `String` scalar common

Optional description of the routing strategy.

`RoutingStrategy.fulfillmentStrategy` ● `FulfillmentStrategyEnum!` non-null enum orders

How the strategy chooses buildings and splits the order.

`RoutingStrategy.id` ● `ID!` non-null scalar common

Unique identifier for the routing strategy.

`RoutingStrategy.maxFulfillments` ● `Int!` non-null scalar common

Maximum number of fulfillments to create for a single order.

`RoutingStrategy.name` ● `String!` non-null scalar common

The name of the routing strategy.

`RoutingStrategy.updatedAt` ● `ISO8601DateTime!` non-null scalar common

When the routing strategy was last updated.

Returned By

archiveRoutingStrategy mutation ● registerRoutingStrategy mutation ● routingStrategy query ● updateRoutingStrategy mutation

Member Of

RoutingBuilding object ● RoutingStrategyConnection object ● RoutingStrategyEdge object

Routing Strategy