fulfillment
Find a single fulfillment by an identifying attribute.
Arguments
1 argumentid•ID!Search by primary key.
Possible return
cursor•String!A unique cursor that can be used for pagination.
allocationExceptions•ExceptionAllocationConnection!The allocation exceptions associated with this fulfillment line allocation.
createdAt•DateTimeTz!When the allocation was created.
fulfillmentLine•FulfillmentLine!Fulfillment line of the fulfillment line allocation.
id•ID!Unique primary key.
originalStock•StockOriginal stock of the fulfillment line allocation.
product•Product!Product of the fulfillment line allocation.
quantity•Int!Quantity
quantityException•Int!Quantity exception of the fulfillment line allocation.
quantityPicked•Int!Quantity picked of the fulfillment line allocation.
quantityShipped•Int!Quantity shipped of the fulfillment line allocation.
stock•StockStock of the fulfillment line allocation.
updatedAt•DateTimeTz!When the allocation was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
adviceReason•StringAdvice reason of the available fulfillment material.
advisedQuantity•IntAdvised quantity of the available fulfillment material.
A list of FulfillmentMaterialBrandOverride edges.
pageInfo•PageInfo!Pagination information about the list of edges.
createdAt•DateTimeTz!When the fulfillment material was created.
description•StringDescription of the fulfillment material.
formFactor•PackagingFormFactorForm factor of the fulfillment material.
BOXENVELOPELETTERBOX_BOXMAILEROTHERid•ID!Unique primary key.
isActive•Boolean!Whether this fulfillment material is active.
name•String!Name of the fulfillment material.
avatar•AvatarAvatar of the organization.
createdAt•DateTimeTz!When the order was created.
id•ID!Unique primary key.
name•String!Non-unique name.
updatedAt•DateTimeTz!When the order was last updated.
assemblyAdvice•AssemblyAdviceAssembly advice of the product.
barcodes•[ProductBarcode!]Barcodes linked to this product
brandName•StringBrand name of the product
code•StringArticle number of the product
countryCodeOfOrigin•StringCountry code of origin of the product
createdAt•DateTimeTz!When the product was created.
description•StringGoods description for customs in English
dimensions•DimensionsDimensions of the product
hsCode•StringHS code of the product
id•ID!Unique primary key.
media•ProductMediaConnection!The media associated with this product.
name•StringName of the product
organization•Organization!Organization of the product.
parts•ProductPartConnection!List parts for assembly
productWarehouse•ProductWarehouseProduct warehouse of the product.
stockRecommendation•StockRecommendationStock recommendation of the product.
stocks•StockConnection!Stocks to this product
tags•TagConnection!Tags linked to this product
updatedAt•DateTimeTz!When the product was last updated.
weight•WeightWeight of the product
updatedAt•DateTimeTz!When the fulfillment material was last updated.
value•Float!Weight value
State of the available fulfillment material.
ALLOWEDBLOCKEDPREFERREDREQUIREDcursor•String!A unique cursor that can be used for pagination.
carrier•Carrier!Carrier that handles this shipping service method
createdAt•DateTimeTz!When the shipping service was created.
id•ID!Unique primary key.
isCancelable•Boolean!Whether this shipping service method can be cancelled.
name•String!Name of the shipping service method
type•String!Type type
updatedAt•DateTimeTz!When the shipping service was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
binType•BinType!Bin type of the bin.
code•String!Code of the bin.
createdAt•DateTimeTz!When the bin was created.
fulfillments•FulfillmentConnection!Fulfillments linked to the bin
id•ID!Unique primary key.
name•String!Name of the bin.
productsInFulfillments•ProductConnection!Products in fulfillments of the bin.
stocks•StockConnection!Stocks linked to the bin
trolley•TrolleyTrolley of the bin.
trolleyPosition•IntPosition in the linked trolley
updatedAt•DateTimeTz!When the bin was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
createdAt•DateTimeTz!When the fulfillment was created.
cursor•String!A unique cursor that can be used for pagination.
code•EventCodeEvent code
fulfillment_internal_label_generatedfulfillment_pickedfulfillment_pickingfulfillment_picklist_createdfulfillment_picklist_deletedfulfillment_shippedintegration_synchronization_failedintegration_updatedorder_address_corrected_consumerorder_address_incorrect_notificationorder_canceledorder_createdorder_exception_ignoredorder_holdorder_hold_releaseorder_shippedproduct_updatedpurchase_order_createdpurchase_order_status_orderedreturn_receipt_completedreturn_refund_deletedreturn_refund_errorreturn_refund_status_completedreturn_refund_status_createdreturn_refund_status_requestedreturn_request_createdreturn_request_status_acceptedreturn_request_status_canceledreturn_request_status_completedreturn_request_status_pendingreturn_request_status_rejectedshipment_canceledshipment_createdshipment_errorshipment_generatedshipment_readyshipment_requestedcreatedAt•DateTimeTz!When the event was created
createdBy•EventCreatorWho created this event
id•ID!Unique primary key
message•StringEvent message
occurredAt•DateTimeTz!When the event occurred
shippingStatus•ShippingStatusShipping status associated with this event
updatedAt•DateTimeTz!When the event was last updated
workstation•WorkstationWorkstation where event was created
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
picklist•Picklist!Picklist of the fulfillment picklist.
reference•StringReference of the fulfillment in the picklist
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
id•ID!Unique primary key.
cursor•String!A unique cursor that can be used for pagination.
allocations•FulfillmentLineAllocationConnection!The allocations associated with this fulfillment line.
fulfillment•FulfillmentFulfillment of the fulfillment line.
id•ID!Unique primary key.
product•ProductProduct of the fulfillment line.
quantity•Int!Quantity
quantityException•Int!Quantity exception of the fulfillment line.
quantityPicked•Int!Quantity picked of the fulfillment line.
quantityShipped•Int!Quantity shipped of the fulfillment line.
serialNumbers•SerialNumberConnection!The serial numbers associated with this fulfillment line.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
allocations•FulfillmentLoadCarrierAllocationConnection!The allocations associated with this fulfillment load carrier.
createdAt•DateTimeTz!When the fulfillment load carrier was created.
id•ID!Unique primary key.
label•StringLabel of the fulfillment load carrier.
materials•FulfillmentUsedMaterialConnection!The materials associated with this fulfillment load carrier.
packagingMaterial•FulfillmentMaterialPackaging material of the fulfillment load carrier.
sequence•Int!Sequence of the fulfillment load carrier.
updatedAt•DateTimeTz!When the fulfillment load carrier was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
url•String!URL of the avatar.
createdAt•DateTimeTz!When the order was created.
id•ID!Unique primary key.
name•String!Non-unique name.
avatar•AvatarAvatar of the organization.
createdAt•DateTimeTz!When the order was created.
id•ID!Unique primary key.
name•String!Non-unique name.
updatedAt•DateTimeTz!When the order was last updated.
updatedAt•DateTimeTz!When the order was last updated.
createdAt•DateTimeTz!When the order was created.
cursor•String!A unique cursor that can be used for pagination.
node•OrderException!The OrderException node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
allocationStrategy•OrderAllocationStrategyAllocation strategy of the order fulfillment preferences.
BULK_NON_PICKABLEFEFOLEFOfulfillmentMode•FulfillmentModeFulfillment mode of the order fulfillment preferences.
DELIVERYLOCAL_PICKUPprintPackingSlip•BooleanPrint packing slip of the order fulfillment preferences.
returnShippingServiceMethodId•IDID of the return shipping service method.
shippingServiceMethodId•IDID of the shipping service method.
id•ID!Unique primary key.
cursor•String!A unique cursor that can be used for pagination.
node•OrderLine!The OrderLine node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
node•Metafield!The Metafield node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
url•String!URL of the avatar.
createdAt•DateTimeTz!When the order was created.
id•ID!Unique primary key.
name•String!Non-unique name.
updatedAt•DateTimeTz!When the order was last updated.
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
reference•StringReference of the order
cursor•String!A unique cursor that can be used for pagination.
node•Shipment!The Shipment node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDupdatedAt•DateTimeTz!When the order was last updated.
cursor•String!A unique cursor that can be used for pagination.
advice•StringAdvice to resolve the exception
createdAt•DateTimeTz!When the exception was created.
data•MixedAdditional data for the exception
id•ID!Unique primary key.
message•String!Message describing the exception
order•Order!Order this exception belongs to
type•OrderExceptionType!Type of the exception
customs_missing_datafulfillment_shipment_creation_failedfulfillment_shipment_generation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productpreferred_return_shipping_service_method_not_possiblepreferred_shipping_service_method_not_possiblerecipient_address_details_incorrectrecipient_address_incorrectupdatedAt•DateTimeTz!When the exception was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
brand•BrandBrand of the order.
createdAt•DateTimeTz!When the order was created.
exceptions•OrderExceptionConnection!Exceptions related to this order
fulfillmentPreferences•OrderFulfillmentPreferencesFulfillment preferences of the order.
id•ID!Unique primary key.
lines•OrderLineConnection!Order lines
metafields•MetafieldConnection!Metafields attached to this order
organization•OrganizationOrganization of the order.
recipientAddress•AddressRecipient address of the order.
reference•StringReference of the order
shipments•ShipmentConnection!Shipments
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDupdatedAt•DateTimeTz!When the order was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
url•String!URL of the avatar.
createdAt•DateTimeTz!When the order was created.
id•ID!Unique primary key.
name•String!Non-unique name.
updatedAt•DateTimeTz!When the order was last updated.
materialId•ID!ID of the material.
quantity•IntQuantity of the fulfillment packing advised material.
reason•StringReason 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_BOXMAILEROTHERblockedMaterialIds•[ID!]!IDs of the blocked material records.
preferredFormFactor•PackagingFormFactorPreferred form factor of the fulfillment packing preferences.
BOXENVELOPELETTERBOX_BOXMAILEROTHERpreferredMaterialIds•[ID!]!IDs of the preferred material records.
materialId•ID!ID of the material.
quantity•Int!Quantity of the fulfillment packing required material.
productIds•[ID!]!Cached product id's in fulfillment, available when fulfillment is queued
cursor•String!A unique cursor that can be used for pagination.
assemblyAdvice•AssemblyAdviceAssembly advice of the product.
barcodes•[ProductBarcode!]Barcodes linked to this product
brandName•StringBrand name of the product
code•StringArticle number of the product
countryCodeOfOrigin•StringCountry code of origin of the product
createdAt•DateTimeTz!When the product was created.
description•StringGoods description for customs in English
dimensions•DimensionsDimensions of the product
hsCode•StringHS code of the product
id•ID!Unique primary key.
media•ProductMediaConnection!The media associated with this product.
name•StringName of the product
organization•Organization!Organization of the product.
parts•ProductPartConnection!List parts for assembly
productWarehouse•ProductWarehouseProduct warehouse of the product.
stockRecommendation•StockRecommendationStock recommendation of the product.
stocks•StockConnection!Stocks to this product
tags•TagConnection!Tags linked to this product
updatedAt•DateTimeTz!When the product was last updated.
weight•WeightWeight of the product
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
quantity•Int!Total number of items in fulfillment
quantityException•Int!Total number of items that are in an exception
quantityPicked•Int!Total number of items that are picked
reference•StringNon-unique reference.
releaseAt•DateTimeTzWhen the fulfillment was (scheduled for) released for the warehouse to process.
cursor•String!A unique cursor that can be used for pagination.
barcode•StringBarcode of the shipment
canceledAt•DateTimeWhen the shipment was canceled.
carrier•Carrier!Carrier used for the shipment
contents•ShipmentContentConnection!Contents of the shipment for customs
createdAt•DateTimeTz!When the shipment was created.
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEdeliveryAddress•AddressDelivery address of the shipment
events•EventConnection!Events related to this shipment
files•ShipmentFileConnection!Files of the shipment
id•ID!Unique primary key.
labelType•StringRequested label type of the shipment
pieces•ShipmentPieceConnection!Pieces of the shipment
piecesCount•IntNumber of pieces
recipientAddress•AddressRecipient address of the shipment
reference•StringReference of the shipment
returnAddress•Address!Return address of the shipment
senderAddress•Address!Sender address of the shipment
shippingPhase•ShippingPhaseShipping phase of the shipment.
shippingServiceMethod•ShippingServiceMethodShipping service method
shippingStatus•ShippingStatusLatest carrier shipping status of the shipment.
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDtrackingCode•StringTracking code of the shipment
trackingUrl•StringTracking url of the shipment
type•String!Type of the shipment
updatedAt•DateTimeTz!When the shipment was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
shippedAt•DateTimeTzWhen the fulfillment was shipped.
status•FulfillmentStatus!Current status of the fulfillment.
CALCULATINGON_HOLDPACKINGPENDINGPICKEDPICKINGQUEUEDRELEASESHIPPEDUNSCHEDULEDupdatedAt•DateTimeTz!When the fulfillment was last updated.
cursor•String!A unique cursor that can be used for pagination.
createdAt•DateTimeTz!When the fulfillment used material was created.
id•ID!Unique primary key.
loadCarrier•FulfillmentLoadCarrierLoad carrier of the fulfillment used material.
material•FulfillmentMaterial!Material of the fulfillment used material.
quantity•Int!Quantity of the fulfillment used material.
updatedAt•DateTimeTz!When the fulfillment used material was last updated.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.