Materials & logistics
Logistics
Explore the data types and operations available in Logistics.
180 types · Used in operation arguments and return values.
RequirementLogisticsEvent semantics
ReserveJobMaterialsInputInputInput for the reserveJobMaterials macro action
ReserveJobMaterialsPayloadObjectResult of the reserveJobMaterials macro action
ShipmentAttributionInputInputStructural execution input; never an implicit lifecycle transition
ShipmentConnectionObjectPaginated list of shipments
ShipmentEvidenceStageEnumSeparate physical execution stages
ShipmentFilterInputInputFilter input for shipment queries
ShipmentIDScalarUnique identifier for a shipment
ShipmentItemAllocationConnectionObjectShipmentItemAllocation connection
ShipmentItemAllocationIDScalarTyped ShipmentItemAllocation identifier
ShipmentItemAllocationInputInputComplete replacement data; omitted optional values are cleared, counts are integers
ShipmentItemAllocationPayloadObjectShipmentItemAllocation mutation result
ShipmentItemAllocationStateObjectPersisted ShipmentItemAllocation
ShipmentItemConnectionObjectPaginated list of shipment items
ShipmentItemEvidenceObjectShipmentItemEvidence; unknown evidence remains unknown
ShipmentItemEvidenceConnectionObjectPaginated physical evidence
ShipmentItemEvidenceIDSpecTypedIDScalarTyped ShipmentItemEvidence identity
ShipmentItemEvidenceInputInputStructural execution input; never an implicit lifecycle transition
ShipmentItemEvidencePayloadObjectEvidence write result
ShipmentItemExecutionBalanceObjectShipmentItemExecutionBalance; unknown evidence remains unknown
ShipmentItemFilterInputInputFilter input for shipment item queries
ShipmentItemIDScalarUnique identifier for a shipment item
ShipmentItemSortInputInputSort input for shipment item queries
ShipmentItemStateObjectAn item within a shipment package
ShipmentPackageConnectionObjectPaginated list of shipment packages
ShipmentPackageFilterInputInputFilter input for shipment package queries
ShipmentPackageIDScalarUnique identifier for a shipment package
ShipmentPackageSortInputInputSort input for shipment package queries
ShipmentPackageStateObjectA package within a shipment
ShipmentSortInputInputSort input for shipment queries
ShipmentStateObjectA shipment tracking record
StringScalarThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
TopicExampleObjectA validated example. JSON strings contain illustrative inputs and responses, never live customer data.
UpdateCarrierInputInputInput for updating a carrier. Only provided fields are changed.
UpdateEntityNoteInputInputEntity note input; no knowledge extraction or lifecycle instruction
UpdateFulfillmentSettingsPayloadObjectFulfillment settings update result; no lifecycle effects
UpdateJobMaterialReservationInputInputInput for updating a job material reservation. Only provided fields are changed.
UpdateShipmentInputInputInput for updating a shipment
UpdateShipmentItemAllocationInputInputComplete replacement data; omitted optional values are cleared, counts are integers
UpdateShipmentItemInputInputInput for updating a shipment item. Only provided fields are changed.
UpdateShipmentPackageInputInputInput for updating a shipment package — only provided fields are changed
UpdateShipmentTrackingInputInputA carrier tracking update for an existing shipment: the new status plus any tracking details. Omitted optional fields are left as they are, never cleared.
UpdateShipmentTrackingPayloadObjectResult of a locked shipment tracking update; no aggregate completion or item receipt quantities are inferred.
UpdateWarehouseLocationInputInputPartial update of a warehouse location: only the fields supplied are applied, every omitted field keeps its current value.
UpdateWarehouseStockInputInputPatch input for `updateWarehouseStock`: only the fields supplied are applied to the existing record; omitted fields keep their current value.
UpdateWarehouseTransferInputInputPartial update of a warehouse transfer: only the fields supplied are written, and null is indistinguishable from an omitted field.
UpsertCarrierInputInputInput for creating or updating a carrier
UpsertCarrierPayloadObjectResult of a carrier mutation
UpsertJobMaterialReservationInputInputInput for creating or updating a job material reservation
UpsertJobMaterialReservationPayloadObjectResult of creating or updating a job material reservation