Skip to main content

FulfillmentProfile

Fulfillment Profile

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

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

Fields

`FulfillmentProfile.archivedAt` ● `ISO8601DateTime` scalar common

When the fulfillment profile was archived, if applicable.

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

The company that owns this fulfillment profile.

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

ID of the company that owns this fulfillment profile.

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

When the fulfillment profile was created.

`FulfillmentProfile.description` ● `String` scalar common

Optional description of the fulfillment profile.

`FulfillmentProfile.fulfillmentIntegration` ● `Integration` object integrations

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

`FulfillmentProfile.fulfillmentIntegrationId` ● `ID` scalar common

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

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

Unique identifier for the fulfillment profile.

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

The name of the fulfillment profile.

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

The transition validation rules owned by this fulfillment profile.

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

When the fulfillment profile was last updated.

Returned By

archiveFulfillmentProfile mutation ● fulfillmentProfile query ● registerFulfillmentProfile mutation ● updateFulfillmentProfile mutation

Member Of

FulfillmentProfileConnection object ● FulfillmentProfileEdge object ● OrderFulfillment object

Fulfillment Profile