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

`id` ● `ID!`

ID of the fulfillment.

`privateMetadata` ● `[MetadataItem!]!`

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

`privateMetafield` ● `String`

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

Tip: Use GraphQL aliases to fetch multiple keys.

`key` ● `String!`

`privateMetafields` ● `Metadata`

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

`keys` ● `[String!]`

`metadata` ● `[MetadataItem!]!`

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

`metafield` ● `String`

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

`key` ● `String!`

`metafields` ● `Metadata`

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

`keys` ● `[String!]`

`fulfillmentOrder` ● `Int!`

Sequence in which the fulfillments were created for an order.

`status` ● `FulfillmentStatus!`

Status of fulfillment.

`trackingNumber` ● `String!`

Fulfillment tracking number.

`created` ● `DateTime!`

Date and time when fulfillment was created.

`lines` ● `[FulfillmentLine!]`

List of lines for the fulfillment.

`statusDisplay` ● `String`

User-friendly fulfillment status.

`warehouse` ● `Warehouse`

Warehouse from fulfillment was fulfilled.

`shippingRefundedAmount` ● `Money`

Amount of refunded shipping price.

`totalRefundedAmount` ● `Money`

Total refunded amount assigned to this fulfillment.

Interfaces

`Node`

An object with an ID

`ObjectWithMetadata`

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