Materials & logistics
Logistics
Explore the data types and operations available in Logistics.
180 types · Used in operation arguments and return values.
The `Boolean` scalar type represents `true` or `false`.
CarrierConnectionObjectPaginated list of carriers
CarrierFilterInputInputFilter input for carrier queries
CarrierIDScalarUnique identifier for a carrier
CarrierSortInputInputSort input for carrier queries
CarrierStateObjectA shipping carrier
CreateCarrierInputInputInput for creating a carrier
CreateEntityNoteInputInputEntity note input; no knowledge extraction or lifecycle instruction
CreateJobMaterialReservationInputInputInput for creating a job material reservation
CreatePurchaseOrderInputInputInput for `createPurchaseOrder`. The order is created in DRAFT status with tax of zero, so its total equals the sum of its line totals.
CreatePurchaseOrderPayloadObjectResult of `createPurchaseOrder`: the new order and its lines, or the validation errors that blocked it.
CreateShipmentInputInputInput for creating a shipment
CreateShipmentItemInputInputInput for creating a shipment item
CreateShipmentPackageInputInputInput for creating a shipment package
CreateWarehouseLocationInputInputFields for creating a new warehouse location; its id is assigned by the server.
CreateWarehouseStockInputInputInput for `createWarehouseStock`: a new stock record is always created, with a server-assigned WarehouseStock TypeID, in the caller's tenant.
CreateWarehouseTransferInputInputInput for creating a warehouse transfer; the server allocates its id.
CustomerFulfillmentDefaultObjectCustomerFulfillmentDefault record with typed value and explicit source relationships
CustomerFulfillmentDefaultConnectionObjectTyped ResourceConnection<CustomerFulfillmentDefaultState> value
CustomerFulfillmentDefaultIDScalarTyped identifier for CustomerFulfillmentDefault
CustomerFulfillmentDefaultInputInputTyped CustomerFulfillmentDefaultInput value
CustomerFulfillmentDefaultPayloadObjectTyped MutationPayload<CustomerFulfillmentDefaultState> value
CustomerIDScalarUnique identifier for a customer
DailyDispatchManifestPayloadObjectEverything dispatched on one calendar day: each shipment with its packages, items and order, plus shipment and package counts for the day.
DataChangeEventObjectA real-time data change event delivered via subscription
DataChangeEventGroupObjectA group of data change event topics for a single resource
DeletePayloadObjectResult of a delete operation
DeliveryTimeInputInputPreserves source time precision
DispatchShipmentInputInputEverything needed to dispatch a shipment in one call: the shipment header, its packages, and each package's items. All-or-nothing — validation failures persist nothing.
DispatchShipmentPayloadObjectResult of dispatching a shipment: the shipment and everything created with it, or the validation errors that stopped it.
EntityNoteObjectEntity notes inherit current access from their target
EntityNoteFilterInputEntity note input; no knowledge extraction or lifecycle instruction
EntityNoteIDSpecTypedIDScalarOperational entity note identity
EntityNotePageObjectEntity notes inherit current access from their target
EntityNotePayloadObjectNote mutation result
EntityNoteReindexResultObjectEntity notes inherit current access from their target
EntityNoteSearchPageObjectEntity notes inherit current access from their target
FulfillmentCompletionPointEnumTenant completion milestone; does not rewrite physical facts or completed records
FulfillmentRequirementObjectFulfillmentRequirement record with typed value and explicit source relationships
FulfillmentRequirementAssessmentObjectRequirement evidence and derived assessment; no mutation of execution or completion
FulfillmentRequirementCompositionObjectRequirement composition and explicit resolution completeness
FulfillmentRequirementConnectionObjectTyped ResourceConnection<FulfillmentRequirementState> value
FulfillmentRequirementIDScalarTyped identifier for FulfillmentRequirement
FulfillmentRequirementInputInputTyped FulfillmentRequirementInput value
FulfillmentRequirementPayloadObjectTyped MutationPayload<FulfillmentRequirementState> value
FulfillmentRequirementScopeInputInputTyped FulfillmentRequirementScopeInput value
FulfillmentSettingsInputInputReplaces only the fulfillment settings section
GraphNodeObjectA single entity in a graph query (fulfillment, provenance, or structural), status-enriched from its domain table.
GraphTraceObjectThe subgraph (nodes + edges) around a queried entity.
HelpChapterObjectPublished manual content for the Help reader.