bulkShip
Find a single bulk ship by an identifying attribute.
Arguments
idID!Search by primary key.
Returns
cursorString!A unique cursor that can be used for pagination.
quantityInt!Quantity of the bulk ship allocation.
quantityAllocatedInt!Quantity allocated of the bulk ship allocation.
quantityPickedInt!Quantity picked of the bulk ship allocation.
stockStockStock of the bulk ship allocation.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
adviceReasonStringAdvice reason of the available fulfillment material.
advisedQuantityIntAdvised quantity of the available fulfillment material.
A list of FulfillmentMaterialBrandOverride edges.
pageInfoPageInfo!Pagination information about the list of edges.
createdAtDateTimeTz!When the fulfillment material was created.
descriptionStringDescription of the fulfillment material.
formFactorPackagingFormFactorForm factor of the fulfillment material.
BOXENVELOPELETTERBOX_BOXMAILEROTHERidID!Unique primary key.
isActiveBoolean!Whether this fulfillment material is active.
nameString!Name of the fulfillment material.
avatarAvatarAvatar of the organization.
createdAtDateTimeTz!When the order was created.
idID!Unique primary key.
nameString!Non-unique name.
updatedAtDateTimeTz!When the order was last updated.
assemblyAdviceAssemblyAdviceAssembly advice of the product.
barcodes[ProductBarcode!]Barcodes linked to this product
brandNameStringBrand name of the product
codeStringArticle number of the product
countryCodeOfOriginStringCountry code of origin of the product
createdAtDateTimeTz!When the product was created.
descriptionStringGoods description for customs in English
dimensionsDimensionsDimensions of the product
hsCodeStringHS code of the product
idID!Unique primary key.
The media associated with this product.
nameStringName of the product
organizationOrganization!Organization of the product.
List parts for assembly
productWarehouseProductWarehouseProduct warehouse of the product.
stockRecommendationStockRecommendationStock recommendation of the product.
stocksStockConnection!Stocks to this product
tagsTagConnection!Tags linked to this product
updatedAtDateTimeTz!When the product was last updated.
weightWeightWeight of the product
updatedAtDateTimeTz!When the fulfillment material was last updated.
valueFloat!Weight value
State of the available fulfillment material.
ALLOWEDBLOCKEDPREFERREDREQUIREDcursorString!A unique cursor that can be used for pagination.
allocationsFulfillmentLineAllocationConnection!The allocations associated with this fulfillment.
availableMaterials[AvailableFulfillmentMaterial!]!The available materials associated with this fulfillment.
availableShippingMethodsShippingServiceMethodConnection!The available shipping methods associated with this fulfillment.
binsBinConnection!The bins associated with this fulfillment.
canApplyOrderAddressBoolean!Whether an order address can be applied before picking starts.
canUpdateAddressBoolean!Whether address management is available, subject to membership confirmation.
createdAtDateTimeTz!When the fulfillment was created.
eventsEventConnection!Events related to this fulfillment
fulfillmentPicklistsFulfillmentPicklistConnection!Picklists linked to the fulfillment with pivot
fulfillmentPreferencesFulfillmentPreferences!Choices saved on this fulfillment, affecting all included orders.
hasDeliveryAddressMismatchBoolean!Whether included orders have conflicting delivery addresses.
idID!Unique primary key.
Lines to fulfill in this fulfillment
loadCarriersFulfillmentLoadCarrierConnection!The load carriers associated with this fulfillment.
mainOrderOrder!Main order
orderExceptionsOrderExceptionConnection!Order exceptions related to this fulfillment
ordersOrderConnection!List related orders
organizationOrganizationOrganization
packingPreferencesFulfillmentPackingPreferences!Packing preferences of the fulfillment.
productIds[ID!]!Cached product id's in fulfillment, available when fulfillment is queued
productsProductConnection!Products of the fulfillment.
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
referenceStringNon-unique reference.
releaseAtDateTimeTzWhen the fulfillment was (scheduled for) released for the warehouse to process.
shipmentsShipmentConnection!Shipments of the fulfillment.
shippedAtDateTimeTzWhen the fulfillment was shipped.
shippingPreferencesShippingPreferences!Shipping requirements saved on this fulfillment.
statusFulfillmentStatus!Current status of the fulfillment.
CALCULATINGON_HOLDPACKINGPENDINGPICKEDPICKINGQUEUEDRELEASESHIPPEDUNSCHEDULEDupdatedAtDateTimeTz!When the fulfillment was last updated.
usedMaterialsFulfillmentUsedMaterialConnection!The used materials associated with this fulfillment.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
fulfillmentsCountInt!Fulfillments count of the bulk ship.
idID!Unique primary key.
createdAtDateTimeTz!When the bulk ship load carrier was created.
idID!Unique primary key.
labelStringLabel of the bulk ship load carrier.
createdAtDateTimeTz!When the bulk ship load carrier material was created.
idID!Unique primary key.
brandOverridesFulfillmentMaterialBrandOverrideConnection!The brand overrides associated with this fulfillment material.
createdAtDateTimeTz!When the fulfillment material was created.
descriptionStringDescription of the fulfillment material.
dimensionsDimensionsDimensions of the fulfillment material.
formFactorPackagingFormFactorForm factor of the fulfillment material.
BOXENVELOPELETTERBOX_BOXMAILEROTHERidID!Unique primary key.
isActiveBoolean!Whether this fulfillment material is active.
nameString!Name of the fulfillment material.
organizationOrganizationOrganization of the fulfillment material.
productProductProduct of the fulfillment material.
updatedAtDateTimeTz!When the fulfillment material was last updated.
weightWeightWeight of the fulfillment material.
quantityInt!Quantity of the bulk ship load carrier material.
updatedAtDateTimeTz!When the bulk ship load carrier material was last updated.
A list of FulfillmentMaterialBrandOverride edges.
pageInfoPageInfo!Pagination information about the list of edges.
createdAtDateTimeTz!When the fulfillment material was created.
descriptionStringDescription of the fulfillment material.
formFactorPackagingFormFactorForm factor of the fulfillment material.
BOXENVELOPELETTERBOX_BOXMAILEROTHERidID!Unique primary key.
isActiveBoolean!Whether this fulfillment material is active.
nameString!Name of the fulfillment material.
avatarAvatarAvatar of the organization.
createdAtDateTimeTz!When the order was created.
idID!Unique primary key.
nameString!Non-unique name.
updatedAtDateTimeTz!When the order was last updated.
assemblyAdviceAssemblyAdviceAssembly advice of the product.
barcodes[ProductBarcode!]Barcodes linked to this product
brandNameStringBrand name of the product
codeStringArticle number of the product
countryCodeOfOriginStringCountry code of origin of the product
createdAtDateTimeTz!When the product was created.
descriptionStringGoods description for customs in English
dimensionsDimensionsDimensions of the product
hsCodeStringHS code of the product
idID!Unique primary key.
The media associated with this product.
nameStringName of the product
organizationOrganization!Organization of the product.
List parts for assembly
productWarehouseProductWarehouseProduct warehouse of the product.
stockRecommendationStockRecommendationStock recommendation of the product.
stocksStockConnection!Stocks to this product
tagsTagConnection!Tags linked to this product
updatedAtDateTimeTz!When the product was last updated.
weightWeightWeight of the product
updatedAtDateTimeTz!When the fulfillment material was last updated.
valueFloat!Weight value
createdAtDateTimeTz!When the bulk ship load carrier product was created.
idID!Unique primary key.
assemblyAdviceAssemblyAdviceAssembly advice of the product.
barcodes[ProductBarcode!]Barcodes linked to this product
brandNameStringBrand name of the product
codeStringArticle number of the product
countryCodeOfOriginStringCountry code of origin of the product
createdAtDateTimeTz!When the product was created.
descriptionStringGoods description for customs in English
dimensionsDimensionsDimensions of the product
hsCodeStringHS code of the product
idID!Unique primary key.
The media associated with this product.
nameStringName of the product
organizationOrganization!Organization of the product.
List parts for assembly
productWarehouseProductWarehouseProduct warehouse of the product.
stockRecommendationStockRecommendationStock recommendation of the product.
stocksStockConnection!Stocks to this product
tagsTagConnection!Tags linked to this product
updatedAtDateTimeTz!When the product was last updated.
weightWeightWeight of the product
quantityInt!Quantity of the bulk ship load carrier product.
updatedAtDateTimeTz!When the bulk ship load carrier product was last updated.
sequenceInt!Sequence of the bulk ship load carrier.
updatedAtDateTimeTz!When the bulk ship load carrier was last updated.
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.
cursorString!A unique cursor that can be used for pagination.
allocations[BulkShipAllocation!]!The allocations associated with this bulk ship product.
productProduct!Product of the bulk ship product.
quantityInt!Quantity of the bulk ship product.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
referenceString!Reference of the bulk ship.