Fulfillment

Required access

read_orders access scope

Show definition
type Fulfillment implements Node {
  # Globally unique identifier.
  id: ID!

  # The date and time when the fulfillment was created.
  createdAt: DateTime!

  # The date that this fulfillment was delivered.
  deliveredAt: DateTime

  # Human readable display status for this fulfillment.
  displayStatus: FulfillmentDisplayStatus

  # The estimated date that this fulfillment will arrive.
  estimatedDeliveryAt: DateTime

  # The history of events associated with this fulfillment.
  events(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: FulfillmentEventSortKeys = HAPPENED_AT
  ): FulfillmentEventConnection!

  # List of the fulfillment's line items.
  fulfillmentLineItems(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): FulfillmentLineItemConnection!

  # The date and time when the fulfillment went into transit.
  inTransitAt: DateTime

  # The location that the fulfillment was processed at.
  location: Location

  # Human readable reference identifier for this fulfillment.
  name: String!

  # Fulfillment service associated with the fulfillment.
  service: FulfillmentService

  # The status of the fulfillment.
  status: FulfillmentStatus!

  # Sum of all line item quantities for the fulfillment.
  totalQuantity: Int!

  # Tracking information associated with the fulfillment,
  # such as the tracking company, tracking number, and tracking URL.
  trackingInfo(
    # Truncate the array result to this size.
    first: Int
  ): [FulfillmentTrackingInfo!]!

  # The date and time when the fulfillment was last modified.
  updatedAt: DateTime!
}

Implements

Connections

events   (FulfillmentEventConnection!)

The history of events associated with this fulfillment.

Argument Type Default Description
after String

Returns the elements that come after the specified cursor.

before String

Returns the elements that come before the specified cursor.

first Int

Returns up to the first n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

sortKey FulfillmentEventSortKeys HAPPENED_AT

Sort the underlying list by the given key.

fulfillmentLineItems   (FulfillmentLineItemConnection!)

List of the fulfillment's line items.

Argument Type Default Description
after String

Returns the elements that come after the specified cursor.

before String

Returns the elements that come before the specified cursor.

first Int

Returns up to the first n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

Fields

createdAt   (DateTime!)

The date and time when the fulfillment was created.

deliveredAt   (DateTime)

The date that this fulfillment was delivered.

displayStatus   (FulfillmentDisplayStatus)

Human readable display status for this fulfillment.

estimatedDeliveryAt   (DateTime)

The estimated date that this fulfillment will arrive.

id   (ID!)

Globally unique identifier.

inTransitAt   (DateTime)

The date and time when the fulfillment went into transit.

location   (Location)

The location that the fulfillment was processed at.

name   (String!)

Human readable reference identifier for this fulfillment.

service   (FulfillmentService)

Fulfillment service associated with the fulfillment.

status   (FulfillmentStatus!)

The status of the fulfillment.

totalQuantity   (Int!)

Sum of all line item quantities for the fulfillment.

trackingInfo   ([FulfillmentTrackingInfo!]!)

Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.

Argument Type Default Description
first Int

Truncate the array result to this size.

updatedAt   (DateTime!)

The date and time when the fulfillment was last modified.