Skip to main content

FulfillmentRule

Fulfillment Rule

A reusable set of rules that defines how a fulfillment is processed. A fulfillment rule is owned by a company and is assigned to fulfillments to govern how they progress through the fulfillment state machine.

type FulfillmentRule {
  archivedAt: ISO8601DateTime
  company: Party!
  companyId: ID!
  createdAt: ISO8601DateTime!
  decompositionStrategy: DecompositionStrategyEnum
  description: String
  fulfillmentIntegration: Integration
  fulfillmentIntegrationId: ID
  id: ID!
  name: String!
  transitionValidations: [TransitionValidation!]!
  updatedAt: ISO8601DateTime!
}

Fields

`FulfillmentRule.archivedAt` ● `ISO8601DateTime` scalar common

When the fulfillment rule was archived, if applicable.

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

The company that owns this fulfillment rule.

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

ID of the company that owns this fulfillment rule.

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

When the fulfillment rule was created.

`FulfillmentRule.decompositionStrategy` ● `DecompositionStrategyEnum` enum orders

Controls how fulfillment items are auto-decomposed into components.

`FulfillmentRule.description` ● `String` scalar common

Optional description of the fulfillment rule.

`FulfillmentRule.fulfillmentIntegration` ● `Integration` object integrations

The fulfillment integration used to fulfill, overriding the building's integration.

`FulfillmentRule.fulfillmentIntegrationId` ● `ID` scalar common

Fulfillment integration used to fulfill, overriding the building's integration.

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

Unique identifier for the fulfillment rule.

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

The name of the fulfillment rule.

`FulfillmentRule.transitionValidations` ● `[TransitionValidation!]!` non-null object orders

The transition validation rules owned by this fulfillment rule.

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

When the fulfillment rule was last updated.

Returned By

archiveFulfillmentRule mutation ● fulfillmentRule query ● registerFulfillmentRule mutation ● updateFulfillmentRule mutation

Member Of

FulfillmentRuleConnection object ● FulfillmentRuleEdge object ● OrderFulfillment object

Fulfillment Rule