GraphQL API
Warehouse API
Warehouse / Types/ object

Fulfillment

Account of a person who utilizes this application.

Fields

27 fields
cursorString!

A unique cursor that can be used for pagination.

The FulfillmentLineAllocation node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

adviceReasonString

Advice reason of the available fulfillment material.

advisedQuantityInt

Advised quantity of the available fulfillment material.

The brand overrides associated with this fulfillment material.

createdAtDateTimeTz!

When the fulfillment material was created.

descriptionString

Description of the fulfillment material.

dimensionsDimensions

Dimensions of the fulfillment material.

formFactorPackagingFormFactor

Form factor of the fulfillment material.

BOXENVELOPELETTERBOX_BOXMAILEROTHER
idID!

Unique primary key.

isActiveBoolean!

Whether this fulfillment material is active.

nameString!

Name of the fulfillment material.

organizationOrganization

Organization of the fulfillment material.

productProduct

Product of the fulfillment material.

State of the fulfillment material.

ALLOWEDBLOCKED

Type of the fulfillment material.

HANDLINGINSERTPACKAGING
updatedAtDateTimeTz!

When the fulfillment material was last updated.

weightWeight

Weight of the fulfillment material.

State of the available fulfillment material.

ALLOWEDBLOCKEDPREFERREDREQUIRED
cursorString!

A unique cursor that can be used for pagination.

The ShippingServiceMethod node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

nodeBin!

The Bin node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

createdAtDateTimeTz!

When the fulfillment was created.

cursorString!

A unique cursor that can be used for pagination.

nodeEvent!

The Event node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

The FulfillmentPicklist node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

idID!

Unique primary key.

cursorString!

A unique cursor that can be used for pagination.

The FulfillmentLine node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

The FulfillmentLoadCarrier node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

avatarAvatar

Avatar of the brand.

createdAtDateTimeTz!

When the order was created.

idID!

Unique primary key.

nameString!

Non-unique name.

organizationOrganization

Organization of the brand.

updatedAtDateTimeTz!

When the order was last updated.

createdAtDateTimeTz!

When the order was created.

A list of OrderException edges.

pageInfoPageInfo!

Pagination information about the list of edges.

allocationStrategyOrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

BULK_NON_PICKABLEFEFOLEFO
fulfillmentModeFulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
printPackingSlipBoolean

Print packing slip of the order fulfillment preferences.

returnShippingServiceMethodIdID

ID of the return shipping service method.

shippingServiceMethodIdID

ID of the shipping service method.

idID!

Unique primary key.

A list of OrderLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Metafield edges.

pageInfoPageInfo!

Pagination information about the list of edges.

avatarAvatar

Avatar of the organization.

createdAtDateTimeTz!

When the order was created.

idID!

Unique primary key.

nameString!

Non-unique name.

updatedAtDateTimeTz!

When the order was last updated.

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the order

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
updatedAtDateTimeTz!

When the order was last updated.

cursorString!

A unique cursor that can be used for pagination.

The OrderException node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

nodeOrder!

The Order node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

urlString!

URL of the avatar.

createdAtDateTimeTz!

When the order was created.

idID!

Unique primary key.

nameString!

Non-unique name.

updatedAtDateTimeTz!

When the order was last updated.

materialIdID!

ID of the material.

quantityInt

Quantity of the fulfillment packing advised material.

reasonString

Reason of the fulfillment packing advised material.

allowedMaterialIds[ID!]!

IDs of the allowed material records.

blockedFormFactors[PackagingFormFactor!]!

Packaging form factors prohibited by the fulfillment's packing preferences.

BOXENVELOPELETTERBOX_BOXMAILEROTHER
blockedMaterialIds[ID!]!

IDs of the blocked material records.

preferredFormFactorPackagingFormFactor

Preferred form factor of the fulfillment packing preferences.

BOXENVELOPELETTERBOX_BOXMAILEROTHER
preferredMaterialIds[ID!]!

IDs of the preferred material records.

materialIdID!

ID of the material.

quantityInt!

Quantity of the fulfillment packing required material.

productIds[ID!]!

Cached product id's in fulfillment, available when fulfillment is queued

cursorString!

A unique cursor that can be used for pagination.

nodeProduct!

The Product node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

quantityInt!

Total number of items in fulfillment

quantityExceptionInt!

Total number of items that are in an exception

quantityPickedInt!

Total number of items that are picked

referenceString

Non-unique reference.

releaseAtDateTimeTz

When the fulfillment was (scheduled for) released for the warehouse to process.

cursorString!

A unique cursor that can be used for pagination.

nodeShipment!

The Shipment node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

shippedAtDateTimeTz

When the fulfillment was shipped.

Current status of the fulfillment.

CALCULATINGON_HOLDPACKINGPENDINGPICKEDPICKINGQUEUEDRELEASESHIPPEDUNSCHEDULED
updatedAtDateTimeTz!

When the fulfillment was last updated.

cursorString!

A unique cursor that can be used for pagination.

The FulfillmentUsedMaterial node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.