Materials & logistics

Logistics

Explore the data types and operations available in Logistics.

180 types · Used in operation arguments and return values.

BooleanScalar

The `Boolean` scalar type represents `true` or `false`.

CarrierConnectionObject

Paginated list of carriers

CarrierFilterInputInput

Filter input for carrier queries

CarrierIDScalar

Unique identifier for a carrier

CarrierSortInputInput

Sort input for carrier queries

CarrierStateObject

A shipping carrier

CreateCarrierInputInput

Input for creating a carrier

CreateEntityNoteInputInput

Entity note input; no knowledge extraction or lifecycle instruction

CreateJobMaterialReservationInputInput

Input for creating a job material reservation

CreatePurchaseOrderInputInput

Input for `createPurchaseOrder`. The order is created in DRAFT status with tax of zero, so its total equals the sum of its line totals.

CreatePurchaseOrderPayloadObject

Result of `createPurchaseOrder`: the new order and its lines, or the validation errors that blocked it.

CreateShipmentInputInput

Input for creating a shipment

CreateShipmentItemInputInput

Input for creating a shipment item

CreateShipmentPackageInputInput

Input for creating a shipment package

CreateWarehouseLocationInputInput

Fields for creating a new warehouse location; its id is assigned by the server.

CreateWarehouseStockInputInput

Input for `createWarehouseStock`: a new stock record is always created, with a server-assigned WarehouseStock TypeID, in the caller's tenant.

CreateWarehouseTransferInputInput

Input for creating a warehouse transfer; the server allocates its id.

CustomerFulfillmentDefaultObject

CustomerFulfillmentDefault record with typed value and explicit source relationships

CustomerFulfillmentDefaultConnectionObject

Typed ResourceConnection<CustomerFulfillmentDefaultState> value

CustomerFulfillmentDefaultIDScalar

Typed identifier for CustomerFulfillmentDefault

CustomerFulfillmentDefaultInputInput

Typed CustomerFulfillmentDefaultInput value

CustomerFulfillmentDefaultPayloadObject

Typed MutationPayload<CustomerFulfillmentDefaultState> value

CustomerIDScalar

Unique identifier for a customer

DailyDispatchManifestPayloadObject

Everything dispatched on one calendar day: each shipment with its packages, items and order, plus shipment and package counts for the day.

DataChangeEventObject

A real-time data change event delivered via subscription

DataChangeEventGroupObject

A group of data change event topics for a single resource

DeletePayloadObject

Result of a delete operation

DeliveryTimeInputInput

Preserves source time precision

DispatchShipmentInputInput

Everything 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.

DispatchShipmentPayloadObject

Result of dispatching a shipment: the shipment and everything created with it, or the validation errors that stopped it.

EntityNoteObject

Entity notes inherit current access from their target

EntityNoteFilterInput

Entity note input; no knowledge extraction or lifecycle instruction

EntityNoteIDSpecTypedIDScalar

Operational entity note identity

EntityNotePageObject

Entity notes inherit current access from their target

EntityNotePayloadObject

Note mutation result

EntityNoteReindexResultObject

Entity notes inherit current access from their target

EntityNoteSearchPageObject

Entity notes inherit current access from their target

FulfillmentCompletionPointEnum

Tenant completion milestone; does not rewrite physical facts or completed records

FulfillmentRequirementObject

FulfillmentRequirement record with typed value and explicit source relationships

FulfillmentRequirementAssessmentObject

Requirement evidence and derived assessment; no mutation of execution or completion

FulfillmentRequirementCompositionObject

Requirement composition and explicit resolution completeness

FulfillmentRequirementConnectionObject

Typed ResourceConnection<FulfillmentRequirementState> value

FulfillmentRequirementIDScalar

Typed identifier for FulfillmentRequirement

FulfillmentRequirementInputInput

Typed FulfillmentRequirementInput value

FulfillmentRequirementPayloadObject

Typed MutationPayload<FulfillmentRequirementState> value

FulfillmentRequirementScopeInputInput

Typed FulfillmentRequirementScopeInput value

FulfillmentSettingsInputInput

Replaces only the fulfillment settings section

GraphNodeObject

A single entity in a graph query (fulfillment, provenance, or structural), status-enriched from its domain table.

GraphTraceObject

The subgraph (nodes + edges) around a queried entity.

HelpChapterObject

Published manual content for the Help reader.