Skip to main content

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
isPartiallyFulfilled: Boolean!
number: String!
shippingAddress: JSON
shippingMethodId: ID
shippingMethodName: 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
shippingMethod: ShippingMethod
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.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.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.

FulfillmentOrder.updatedAt ● DateTime scalar​

Timestamp the fulfillment order was last changed.

FulfillmentOrder.destinationOrder ● Order object​

FulfillmentOrder.fulfillments ● FulfillmentConnection object​

FulfillmentOrder.fulfillments.first ● Int scalar​
FulfillmentOrder.fulfillments.after ● String scalar​

FulfillmentOrder.lineItems ● FulfillmentOrderLineItemConnection object​

FulfillmentOrder.lineItems.first ● Int scalar​
FulfillmentOrder.lineItems.after ● String scalar​
FulfillmentOrder.lineItems.filter ● FulfillmentOrderLineItemFilterInput input​

FulfillmentOrder.shippingLabels ● ShippingLabelConnection object​

FulfillmentOrder.shippingLabels.first ● Int scalar​
FulfillmentOrder.shippingLabels.after ● String scalar​

FulfillmentOrder.shippingMethod ● ShippingMethod object​

FulfillmentOrder.sourceWarehouseLocation ● Location object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

changeFulfillmentOrderShippingAddress mutation ● fulfillFulfillmentOrder mutation ● fulfillmentOrder query ● moveFulfillmentOrderToLocation mutation

Member Of​

FulfillmentOrderEdge object ● FulfillmentOrderLineItem object

Webhook topics​

TopicFires when
fulfillment-order/cancelled
Required scopefulfillment_orders:read
A fulfillment order is cancelled.
fulfillment-order/fulfilled
Required scopefulfillment_orders:read
The last open quantity of a fulfillment order is fulfilled. The same shipment also fires order/partially-shipped or order/completely-shipped, see Order or fulfillment order topics.
fulfillment-order/hold-released
Required scopefulfillment_orders:read
The hold on a fulfillment order is released, so it can be fulfilled again.
fulfillment-order/partially-fulfilled
Required scopefulfillment_orders:read
Fires for each fulfillment that leaves quantities of the fulfillment order open. The same shipment also fires order/partially-shipped, see Order or fulfillment order topics.
fulfillment-order/picking-started
Required scopefulfillment_orders:read
Picking of the fulfillment order starts in the Pickware WMS app, once for every fulfillment order picked together in the same picking process. Pausing, resuming or taking over the picking does not fire again.
fulfillment-order/placed-on-hold
Required scopefulfillment_orders:read
A fulfillment order is put on hold, in Pickware or in Shopify.

The webhooks guide explains how to subscribe to a topic and verify the notifications it sends.