FulfillmentOrder

Version unstable

Represents a fulfillment order. In Shopify a fulfillment order represents a group of one or more items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.

Required access

This resource requires at least one of the following access scopes:

  • read_assigned_fulfillment_orders
  • read_merchant_managed_fulfillment_orders
  • read_third_party_fulfillment_orders

Depending on which access scopes are present, a different set of resources will be returned.

Show definition
"""
Represents a fulfillment order. In Shopify a fulfillment order represents a group of one or more items
in an order that are to be fulfilled from the same location. There can be more than one fulfillment order
for an order at a given location.
"""
type FulfillmentOrder implements Node {
  """
  The destination where the items should be sent.
  """
  destination: FulfillmentOrderDestination
  """
  Fulfillment service the fulfillment order is assigned to.
  """
  fulfillmentService: FulfillmentService
  """
  List of fulfillments for the fulfillment order.
  """
  fulfillments(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): FulfillmentConnection!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  List of the fulfillment order's line items.
  """
  lineItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): FulfillmentOrderLineItemConnection!
  """
  List of requests sent by the merchant to the fulfillment service for this fulfillment order.
  """
  merchantRequests(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    The kind of request the merchant sent.
    """
    kind: FulfillmentOrderMerchantRequestKind
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): FulfillmentOrderMerchantRequestConnection!
  """
  The order to which the fulfillment order belongs.
  """
  order: Order!
  """
  The fulfillment order's origin location that has been assigned to do the work.
  """
  origin: FulfillmentOrderOrigin!
  """
  The request status of the fulfillment order.
  """
  requestStatus: FulfillmentOrderRequestStatus!
  """
  The status of the fulfillment order.
  """
  status: FulfillmentOrderStatus!
  """
  Actions that can be performed on this fulfillment order.
  """
  supportedActions: [FulfillmentOrderSupportedAction!]!
}

Implements

Connections

fulfillments (FulfillmentConnection!)

List of fulfillments for the fulfillment order.

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 )

Reverse the order of the underlying list.
Default value: true

lineItems (FulfillmentOrderLineItemConnection!)

List of the fulfillment order's line items.

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 )

Reverse the order of the underlying list.
Default value: true

merchantRequests (FulfillmentOrderMerchantRequestConnection!)

List of requests sent by the merchant to the fulfillment service for this fulfillment order.

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.

kind ( FulfillmentOrderMerchantRequestKind )

The kind of request the merchant sent.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

destination (FulfillmentOrderDestination)

The destination where the items should be sent.

fulfillmentService (FulfillmentService)

Fulfillment service the fulfillment order is assigned to.

id (ID!)

Globally unique identifier.

order (Order!)

The order to which the fulfillment order belongs.

origin (FulfillmentOrderOrigin!)

The fulfillment order's origin location that has been assigned to do the work.

requestStatus (FulfillmentOrderRequestStatus!)

The request status of the fulfillment order.

status (FulfillmentOrderStatus!)

The status of the fulfillment order.

supportedActions ([FulfillmentOrderSupportedAction!]!)

Actions that can be performed on this fulfillment order.

Sign up for a Partner account to get started.

Sign up