Skip to main content

Fulfillment Object

Represents order fulfillment.

type Fulfillment implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  fulfillmentOrder: Int!
  status: FulfillmentStatus!
  trackingNumber: String!
  created: DateTime!
  lines: [FulfillmentLine!]
  statusDisplay: String
  warehouse: Warehouse
  shippingRefundedAmount: Money
  totalRefundedAmount: Money
}

Fields

`Fulfillment.id` ● `ID!` non-null scalar miscellaneous

ID of the fulfillment.

`Fulfillment.privateMetadata` ● `[MetadataItem!]!` non-null object miscellaneous

List of private metadata items. Requires staff permissions to access.

`Fulfillment.privateMetafield` ● `String` scalar miscellaneous

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

`Fulfillment.privateMetafield.key` ● `String!` non-null scalar miscellaneous

`Fulfillment.privateMetafields` ● `Metadata` scalar miscellaneous

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

`Fulfillment.privateMetafields.keys` ● `[String!]` list scalar miscellaneous

`Fulfillment.metadata` ● `[MetadataItem!]!` non-null object miscellaneous

List of public metadata items. Can be accessed without permissions.

`Fulfillment.metafield` ● `String` scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

`Fulfillment.metafield.key` ● `String!` non-null scalar miscellaneous

`Fulfillment.metafields` ● `Metadata` scalar miscellaneous

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

`Fulfillment.metafields.keys` ● `[String!]` list scalar miscellaneous

`Fulfillment.fulfillmentOrder` ● `Int!` non-null scalar miscellaneous

Sequence in which the fulfillments were created for an order.

`Fulfillment.status` ● `FulfillmentStatus!` non-null enum orders

Status of fulfillment.

`Fulfillment.trackingNumber` ● `String!` non-null scalar miscellaneous

Fulfillment tracking number.

`Fulfillment.created` ● `DateTime!` non-null scalar miscellaneous

Date and time when fulfillment was created.

`Fulfillment.lines` ● `[FulfillmentLine!]` list object orders

List of lines for the fulfillment.

`Fulfillment.statusDisplay` ● `String` scalar miscellaneous

User-friendly fulfillment status.

`Fulfillment.warehouse` ● `Warehouse` object products

Warehouse from fulfillment was fulfilled.

`Fulfillment.shippingRefundedAmount` ● `Money` object miscellaneous

Amount of refunded shipping price.

`Fulfillment.totalRefundedAmount` ● `Money` object miscellaneous

Total refunded amount assigned to this fulfillment.

Interfaces

`Node` interface miscellaneous

An object with an ID

`ObjectWithMetadata` interface miscellaneous

Member Of

FulfillmentApprove object ● FulfillmentApproved object ● FulfillmentCancel object ● FulfillmentCanceled object ● FulfillmentCreated object ● FulfillmentMetadataUpdated object ● FulfillmentRefundProducts object ● FulfillmentReturnProducts object ● FulfillmentTrackingNumberUpdated object ● FulfillmentUpdateTracking object ● Order object ● OrderFulfill object

Fields
Interfaces
Member Of