FulfillmentOrder

The assignment of an order's line items, in specific quantities, to exactly one location they are to be fulfilled from. One order can have several fulfillment orders, also at the same location. A fulfillment order assigned to a location Pickware does not manage is to be fulfilled externally (type: ExternalToOrder).

type FulfillmentOrder implements Node {
  id: ID!
  createdAt: DateTime!
  destinationOrderId: ID
  externalLocationName: String
  isPartiallyFulfilled: Boolean!
  number: String!
  shippingAddress: JSON
  shippingMethodId: ID
  shippingMethodName: String
  shopifyId: String
  sourceWarehouseLocationId: ID
  state: FulfillmentOrderState!
  type: FulfillmentOrderType!
  updatedAt: DateTime
  destinationOrder: Order
  fulfillments(
    first: Int = 10
    after: String
  ): FulfillmentConnection
  lineItems(
    first: Int = 10
    after: String
    filter: FulfillmentOrderLineItemFilterInput
  ): FulfillmentOrderLineItemConnection
  shippingLabels(
    first: Int = 10
    after: String
  ): ShippingLabelConnection
  sourceWarehouseLocation: Location
}

Fields

`FulfillmentOrder.id` ● `ID!` non-null scalar

Global identifier for this entity.

`FulfillmentOrder.createdAt` ● `DateTime!` non-null scalar

Timestamp the fulfillment order was created.

`FulfillmentOrder.destinationOrderId` ● `ID` scalar

ID of the order the fulfillment order belongs to.

`FulfillmentOrder.externalLocationName` ● `String` scalar

Name of the Shopify location a fulfillment order that is to be fulfilled externally is assigned to, e.g. an unmapped Shopify location or Amazon FBA. Such a fulfillment order has no sourceWarehouseLocation in Pickware. Null for a fulfillment order fulfilled in Pickware.

`FulfillmentOrder.isPartiallyFulfilled` ● `Boolean!` non-null scalar

True when at least one fulfillment exists for the fulfillment order while some of its quantities are still open.

`FulfillmentOrder.number` ● `String!` non-null scalar

Human-readable fulfillment order number.

`FulfillmentOrder.shippingAddress` ● `JSON` scalar

Shipping address of the fulfillment order, captured when the fulfillment order was created. It can differ from the order's current shipping address and is null when the order had no shipping address. An object with the keys company, department, firstName, lastName, street, additionalAddressLine1, additionalAddressLine2, zipcode, city, countryName, countryIso, countryStateName, countryStateShortCode and phoneNumber. Every value is a string or null.

`FulfillmentOrder.shippingMethodId` ● `ID` scalar

ID of the shipping method the fulfillment order is to be shipped with.

`FulfillmentOrder.shippingMethodName` ● `String` scalar

Name of the shipping method the fulfillment order is to be shipped with.

`FulfillmentOrder.shopifyId` ● `String` scalar

Shopify GID of the fulfillment order, e.g. gid://shopify/FulfillmentOrder/4123. Null for a fulfillment order that does not belong to an order imported from Shopify.

`FulfillmentOrder.sourceWarehouseLocationId` ● `ID` scalar

ID of the location the fulfillment order is fulfilled from. Null for a fulfillment order that is to be fulfilled externally from a location Pickware does not manage, and for one whose location was deleted.

`FulfillmentOrder.state` ● `FulfillmentOrderState!` non-null enum

State of the fulfillment order.

`FulfillmentOrder.type` ● `FulfillmentOrderType!` non-null enum

Whether the fulfillment order is fulfilled in Pickware or is to be fulfilled externally. See the FulfillmentOrderType enum for the meaning of each value.