Warehousing and Logistics API reference
Use the Warehousing and Logistics guide for workflows and examples. This reference lists every operation carrying the logistics topic, including shared tools. Infrastructure changes are marked for IaC. Admin marks shared administrative configuration, not job data.
A trailing ! means a value is required; [Type!] means a list whose entries cannot be null. Defaults below are those declared by the API. Additional business rules are explained in the guide.
Read locations and carriers
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getWarehouseLocation |
id: WarehouseLocationID! |
WarehouseLocationState |
Read a warehouse location. | API |
listWarehouseLocations |
first: Int, after: String, filter: WarehouseLocationFilterInput, sort: [WarehouseLocationSortInput!] |
WarehouseLocationConnection! |
Browse warehouse locations. | API |
getCarrier |
id: CarrierID! |
CarrierState |
Read a carrier. | API |
listCarriers |
first: Int, after: String, filter: CarrierFilterInput, sort: [CarrierSortInput!] |
CarrierConnection! |
Browse carriers. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createWarehouseLocation |
input: CreateWarehouseLocationInput! |
WarehouseLocationPayload! |
Create a warehouse location. Manage through IaC. | IaC |
updateWarehouseLocation |
id: WarehouseLocationID!, input: UpdateWarehouseLocationInput! |
WarehouseLocationPayload! |
Change a warehouse location. Manage through IaC. | IaC |
upsertWarehouseLocation |
input: UpsertWarehouseLocationInput! |
WarehouseLocationPayload! |
Advanced: Create or replace a warehouse location. Prefer create/update for routine changes. Manage through IaC. | IaC |
deleteWarehouseLocation |
id: WarehouseLocationID! |
DeletePayload! |
Delete a warehouse location. Manage through IaC. | IaC |
upsertCarrier |
input: UpsertCarrierInput! |
UpsertCarrierPayload! |
Advanced: Create or replace a carrier. Prefer create/update for routine changes. Manage through IaC. | IaC |
createCarrier |
input: CreateCarrierInput! |
UpsertCarrierPayload! |
Create a carrier. Manage through IaC. | IaC |
updateCarrier |
id: CarrierID!, input: UpdateCarrierInput! |
UpsertCarrierPayload! |
Change a carrier. Manage through IaC. | IaC |
deleteCarrier |
id: CarrierID! |
DeletePayload! |
Delete a carrier. Manage through IaC. | IaC |
Receive and count warehouse stock
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getWarehouseStock |
id: WarehouseStockID! |
WarehouseStockState |
Read a warehouse stock. | API |
listWarehouseStocks |
first: Int, after: String, filter: WarehouseStockFilterInput, sort: [WarehouseStockSortInput!] |
WarehouseStockConnection! |
Browse warehouse stocks. | API |
getWarehouseTransfer |
id: WarehouseTransferID! |
WarehouseTransferState |
Read a warehouse transfer. | API |
listWarehouseTransfers |
first: Int, after: String, filter: WarehouseTransferFilterInput, sort: [WarehouseTransferSortInput!] |
WarehouseTransferConnection! |
Browse warehouse transfers. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertWarehouseStock |
input: UpsertWarehouseStockInput! |
WarehouseStockPayload! |
Advanced: Create or replace a warehouse stock. Prefer create/update for routine changes. | API |
createWarehouseStock |
input: CreateWarehouseStockInput! |
WarehouseStockPayload! |
Create a warehouse stock. | API |
updateWarehouseStock |
id: WarehouseStockID!, input: UpdateWarehouseStockInput! |
WarehouseStockPayload! |
Change a warehouse stock. | API |
deleteWarehouseStock |
id: WarehouseStockID! |
DeletePayload! |
Delete a warehouse stock. | API |
upsertWarehouseTransfer |
input: UpsertWarehouseTransferInput! |
WarehouseTransferPayload! |
Advanced: Create or replace a warehouse transfer. Prefer create/update for routine changes. | API |
createWarehouseTransfer |
input: CreateWarehouseTransferInput! |
WarehouseTransferPayload! |
Create a warehouse transfer. | API |
updateWarehouseTransfer |
id: WarehouseTransferID!, input: UpdateWarehouseTransferInput! |
WarehouseTransferPayload! |
Change a warehouse transfer. | API |
deleteWarehouseTransfer |
id: WarehouseTransferID! |
DeletePayload! |
Delete a warehouse transfer. | API |
createPurchaseOrder |
input: CreatePurchaseOrderInput! |
CreatePurchaseOrderPayload! |
Create a purchase order and its lines, calculating the totals. | API |
receivePurchaseOrder |
input: ReceivePurchaseOrderInput! |
ReceivePurchaseOrderPayload! |
Record quantities received against purchase order lines and optionally create stock entries. | API |
performStockCount |
input: PerformStockCountInput! |
PerformStockCountPayload! |
Set counted stock quantities and record the differences. | API |
Supply materials to a printing job
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getJobMaterialReservation |
id: JobMaterialReservationID! |
JobMaterialReservationState |
Read a job material reservation. | API |
listJobMaterialReservations |
first: Int, after: String, filter: JobMaterialReservationFilterInput, sort: [JobMaterialReservationSortInput!] |
JobMaterialReservationConnection! |
Browse job material reservations. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertJobMaterialReservation |
input: UpsertJobMaterialReservationInput! |
UpsertJobMaterialReservationPayload! |
Advanced: Create or replace a job material reservation. Prefer create/update for routine changes. | API |
createJobMaterialReservation |
input: CreateJobMaterialReservationInput! |
UpsertJobMaterialReservationPayload! |
Create a job material reservation. | API |
updateJobMaterialReservation |
id: JobMaterialReservationID!, input: UpdateJobMaterialReservationInput! |
UpsertJobMaterialReservationPayload! |
Change a job material reservation. | API |
deleteJobMaterialReservation |
id: JobMaterialReservationID! |
DeletePayload! |
Delete a job material reservation. | API |
reserveJobMaterials |
input: ReserveJobMaterialsInput! |
ReserveJobMaterialsPayload! |
Attempt to reserve available stock for pending job material requirements. | API |
issueStockToProduction |
input: IssueStockToProductionInput! |
IssueStockToProductionPayload! |
Issue available warehouse stock to production, recording transfers and reducing quantities. | API |
Plan the customer delivery
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getPlannedDelivery |
id: PlannedDeliveryID! |
PlannedDeliveryState |
Read a planned delivery. | API |
getPlannedDeliveryItem |
id: PlannedDeliveryItemID! |
PlannedDeliveryItemState |
Read a planned delivery item. | API |
listPlannedDeliveryItems |
first: Int, after: String, plannedDeliveryId: PlannedDeliveryID, jobId: JobID |
PlannedDeliveryItemConnection! |
Browse planned delivery items. | API |
getShipmentItemAllocation |
id: ShipmentItemAllocationID! |
ShipmentItemAllocationState |
Read a shipment item allocation. | API |
listShipmentItemAllocations |
first: Int, after: String, shipmentItemId: ShipmentItemID, plannedDeliveryItemId: PlannedDeliveryItemID |
ShipmentItemAllocationConnection! |
Browse shipment item allocations. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createPlannedDelivery |
input: PlannedDeliveryInput! |
PlannedDeliveryPayload! |
Create a planned delivery. | API |
updatePlannedDelivery |
id: PlannedDeliveryID!, expectedVersion: Int!, input: PlannedDeliveryInput! |
PlannedDeliveryPayload! |
Change a planned delivery. | API |
deletePlannedDelivery |
id: PlannedDeliveryID!, expectedVersion: Int! |
DeletePayload! |
Delete a planned delivery. | API |
createPlannedDeliveryItem |
input: PlannedDeliveryItemInput! |
PlannedDeliveryItemPayload! |
Create a planned delivery item. | API |
updatePlannedDeliveryItem |
id: PlannedDeliveryItemID!, expectedVersion: Int!, input: PlannedDeliveryItemInput! |
PlannedDeliveryItemPayload! |
Change a planned delivery item. | API |
deletePlannedDeliveryItem |
id: PlannedDeliveryItemID!, expectedVersion: Int! |
DeletePayload! |
Delete a planned delivery item. | API |
createShipmentItemAllocation |
input: ShipmentItemAllocationInput! |
ShipmentItemAllocationPayload! |
Create a shipment item allocation. | API |
updateShipmentItemAllocation |
id: ShipmentItemAllocationID!, expectedVersion: Int!, input: UpdateShipmentItemAllocationInput! |
ShipmentItemAllocationPayload! |
Change a shipment item allocation. | API |
deleteShipmentItemAllocation |
id: ShipmentItemAllocationID!, expectedVersion: Int! |
DeletePayload! |
Delete a shipment item allocation. | API |
Record delivery requirements
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getFulfillmentRequirement |
id: FulfillmentRequirementID! |
FulfillmentRequirement |
Read a fulfillment requirement. | API |
listFulfillmentRequirements |
plannedDeliveryId: PlannedDeliveryID!, includeRetired: Boolean, first: Int, after: String |
FulfillmentRequirementConnection! |
Browse fulfillment requirements. | API |
getCustomerFulfillmentDefault |
id: CustomerFulfillmentDefaultID! |
CustomerFulfillmentDefault |
Read a customer fulfillment default. | API |
listCustomerFulfillmentDefaults |
customerId: CustomerID!, includeRetired: Boolean, first: Int, after: String |
CustomerFulfillmentDefaultConnection! |
Browse customer fulfillment defaults. | API |
effectiveFulfillmentRequirements |
scope: FulfillmentRequirementScopeInput! |
FulfillmentRequirementComposition! |
Read applicable delivery requirements and explicit exceptions. | API |
getRequirementEvidence |
id: RequirementEvidenceIDSpecTypedID! |
RequirementEvidence |
Read a recorded observation about a delivery requirement. | API |
listRequirementEvidence |
requirementId: FulfillmentRequirementID!, first: Int, after: String |
RequirementEvidenceConnection! |
Browse observations about a delivery requirement. | API |
assessFulfillmentRequirements |
scope: FulfillmentRequirementScopeInput!, quantityStage: ShipmentEvidenceStage!, event: RequirementLogisticsEvent, eventTime: DeliveryTimeInput |
FulfillmentRequirementAssessment! |
Assess requirements for the requested quantity stage and logistics event. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createFulfillmentRequirement |
input: FulfillmentRequirementInput! |
FulfillmentRequirementPayload! |
Create a fulfillment requirement. | API |
createCustomerFulfillmentDefault |
input: CustomerFulfillmentDefaultInput! |
CustomerFulfillmentDefaultPayload! |
Create a customer fulfillment default. | API |
updateCustomerFulfillmentDefault |
id: CustomerFulfillmentDefaultID!, expectedVersion: Int!, input: CustomerFulfillmentDefaultInput! |
CustomerFulfillmentDefaultPayload! |
Change a customer fulfillment default. | API |
retireFulfillmentRequirement |
id: FulfillmentRequirementID!, expectedVersion: Int! |
FulfillmentRequirementPayload! |
Retire a fulfillment requirement. | API |
retireCustomerFulfillmentDefault |
id: CustomerFulfillmentDefaultID!, expectedVersion: Int! |
CustomerFulfillmentDefaultPayload! |
Retire a customer fulfillment default. | API |
resolveCustomerFulfillmentDefaults |
plannedDeliveryId: PlannedDeliveryID!, customerId: CustomerID!, expectedVersion: Int! |
PlannedDeliveryPayload! |
Copy the selected customer’s fulfilment defaults into a planned delivery. | API |
recordRequirementEvidence |
input: RecordRequirementEvidenceInput! |
RequirementEvidencePayload! |
Record whether a delivery requirement was met, with its supporting observation. | API |
Prepare shipments and packages
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getShipment |
id: ShipmentID! |
ShipmentState |
Read a shipment. | API |
listShipments |
first: Int, after: String, filter: ShipmentFilterInput, sort: [ShipmentSortInput!] |
ShipmentConnection! |
Browse shipments. | API |
getShipmentPackage |
id: ShipmentPackageID! |
ShipmentPackageState |
Read a shipment package. | API |
listShipmentPackages |
first: Int, after: String, filter: ShipmentPackageFilterInput, sort: [ShipmentPackageSortInput!] |
ShipmentPackageConnection! |
Browse shipment packages. | API |
getShipmentItem |
id: ShipmentItemID! |
ShipmentItemState |
Read a shipment item. | API |
listShipmentItems |
first: Int, after: String, filter: ShipmentItemFilterInput, sort: [ShipmentItemSortInput!] |
ShipmentItemConnection! |
Browse shipment items. | API |
listPlannedDeliveries |
first: Int, after: String, customerId: CustomerID |
PlannedDeliveryConnection! |
Browse planned deliveries. | API |
dailyDispatchManifest |
date: String! |
DailyDispatchManifestPayload! |
Read the day’s shipments with package, item and order details. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertShipment |
input: UpsertShipmentInput! |
UpsertShipmentPayload! |
Advanced: Create or replace a shipment. Prefer create/update for routine changes. | API |
createShipment |
input: CreateShipmentInput! |
UpsertShipmentPayload! |
Create a shipment. | API |
updateShipment |
id: ShipmentID!, input: UpdateShipmentInput! |
UpsertShipmentPayload! |
Change a shipment. | API |
deleteShipment |
id: ShipmentID! |
DeletePayload! |
Delete a shipment. | API |
createShipmentPackage |
input: CreateShipmentPackageInput! |
UpsertShipmentPackagePayload! |
Create a shipment package. | API |
updateShipmentPackage |
id: ShipmentPackageID!, input: UpdateShipmentPackageInput! |
UpsertShipmentPackagePayload! |
Change a shipment package. | API |
upsertShipmentPackage |
input: UpsertShipmentPackageInput! |
UpsertShipmentPackagePayload! |
Advanced: Create or replace a shipment package. Prefer create/update for routine changes. | API |
deleteShipmentPackage |
id: ShipmentPackageID! |
DeletePayload! |
Delete a shipment package. | API |
upsertShipmentItem |
input: UpsertShipmentItemInput! |
UpsertShipmentItemPayload! |
Advanced: Create or replace a shipment item. Prefer create/update for routine changes. | API |
createShipmentItem |
input: CreateShipmentItemInput! |
UpsertShipmentItemPayload! |
Create a shipment item. | API |
updateShipmentItem |
id: ShipmentItemID!, input: UpdateShipmentItemInput! |
UpsertShipmentItemPayload! |
Change a shipment item. | API |
deleteShipmentItem |
id: ShipmentItemID! |
DeletePayload! |
Delete a shipment item. | API |
dispatchShipment |
input: DispatchShipmentInput! |
DispatchShipmentPayload! |
Create a shipment with packages and items already marked as picked up. | API |
updateShipmentTracking |
input: UpdateShipmentTrackingInput! |
UpdateShipmentTrackingPayload! |
Update shipment status and tracking details without completing the order. | API |
Record dispatch, receipt and returns
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getShipmentItemEvidence |
id: ShipmentItemEvidenceIDSpecTypedID! |
ShipmentItemEvidence |
Read a recorded shipment-item quantity observation. | API |
listShipmentItemEvidence |
shipmentItemId: ShipmentItemID!, first: Int, after: String |
ShipmentItemEvidenceConnection! |
Browse shipment-item quantity observations. | API |
shipmentItemExecutionBalance |
shipmentItemId: ShipmentItemID! |
ShipmentItemExecutionBalance! |
Review observed and attributed quantities for a shipment item. | API |
plannedItemFulfillmentBalance |
plannedDeliveryItemId: PlannedDeliveryItemID! |
PlannedItemFulfillmentBalance! |
Review allocated and credited quantities for a planned delivery item. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
recordShipmentItemEvidence |
input: ShipmentItemEvidenceInput! |
ShipmentItemEvidencePayload! |
Record an observed dispatch, receipt or return quantity. | API |
attributeShipmentItemEvidence |
evidenceId: ShipmentItemEvidenceIDSpecTypedID!, expectedVersion: Int!, requestKey: String!, input: ShipmentAttributionInput! |
ShipmentItemEvidencePayload! |
Credit an observed quantity to its planned delivery item. | API |
Review fulfilment and complete the order
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
plannedItemReview |
plannedDeliveryItemId: PlannedDeliveryItemID!, quantityStage: ShipmentEvidenceStage!, notesFirst: Int, notesAfter: String |
PlannedItemReview! |
Review quantities, requirements and authorised notes for a planned delivery item. | API |
orderFulfillmentCompletion |
orderId: OrderID! |
OrderFulfillmentCompletion! |
Check whether every order line meets the current completion milestone | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
updateFulfillmentSettings |
input: FulfillmentSettingsInput! |
UpdateFulfillmentSettingsPayload! |
Change shared order completion policy. Administrative configuration. | Admin |
completeOrderFulfillment |
orderId: OrderID!, expectedCompletionPoint: FulfillmentCompletionPoint! |
UpsertOrderPayload! |
Complete an order after checking its fulfilment milestone | API |
Trace the work and its impact
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
fulfillmentTrace |
entityId: ID!, maxDepth: Int, direction: String |
GraphTrace! |
Trace relationships around a delivery or shipment record. | API |
fulfillmentImpact |
entityId: ID!, direction: String, maxDepth: Int |
[GraphNode!]! |
Find delivery records affected upstream or downstream of a record. | API |
provenanceTrace |
entityId: ID!, maxDepth: Int, direction: String |
GraphTrace! |
Trace relationships across production, fulfilment and material provenance. | API |
provenanceImpact |
entityId: ID!, direction: String, maxDepth: Int |
[GraphNode!]! |
Find related records that could be affected across those relationships. | API |
whatIf |
seeds: [ID!]!, extraEdges: [WhatIfEdgeInput!]!, direction: String, maxDepth: Int, graph: String |
WhatIfResult! |
Explore the effect of proposed relationship links without saving them. | API |
Keep handling instructions with the records
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getEntityNote |
id: EntityNoteIDSpecTypedID! |
EntityNote |
Read a note attached to a record you can access | API |
getEntityNoteBySource |
integrationInstanceId: IntegrationInstanceID!, key: String! |
EntityNote |
Find a note by its source integration and key | API |
entityNotes |
filter: EntityNoteFilter, first: Int, after: String |
EntityNotePage! |
Browse notes on a record | API |
searchEntityNotes |
query: String!, filter: EntityNoteFilter, first: Int, after: String |
EntityNoteSearchPage! |
Search notes you are allowed to read | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createEntityNote |
input: CreateEntityNoteInput! |
EntityNotePayload! |
Add a note to a record | API |
updateEntityNote |
id: EntityNoteIDSpecTypedID!, expectedVersion: Int!, input: UpdateEntityNoteInput! |
EntityNotePayload! |
Edit a note using its current version | API |
deleteEntityNote |
id: EntityNoteIDSpecTypedID!, expectedVersion: Int! |
DeletePayload! |
Delete a note using its current version | API |
reindexEntityNotes |
filter: EntityNoteFilter, first: Int, after: String |
EntityNoteReindexResult! |
Request refreshed search indexing for a selected set of notes | API |
Discover the API and get help
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
magicQuery |
query: QueryScalar! |
JSON! |
Read data with a compact named query | API |
getMagicQuerySchema |
query: QueryScalar! |
MagicQuerySchema! |
Inspect the inputs and result of a compact named query | API |
listMagicQueries |
None | [MagicQueryInfo!]! |
Discover the available compact named queries | API |
getMagicQueryGraphQL |
query: QueryScalar! |
MagicQueryOperation! |
Inspect the GraphQL operation for a compact named query | API |
listDataChangeEventTopics |
None | [DataChangeEventGroup!]! |
Discover record-change event topics | API |
generateDefaultDataQuery |
topic: String! |
String |
Prepare a query for a record-change event | API |
ping |
None | String! |
Check whether the API responds | API |
iacSchema |
None | IaCSchemaDocument! |
Read the infrastructure schema for IaC tooling | API |
iacValidate |
validator: String!, source: String!, role: String |
IaCValidationResult! |
Validate an IaC source document | API |
iacGuides |
None | [IaCGuide!]! |
Read IaC authoring guides | API |
helpChapters |
None | [HelpChapterInfo!]! |
Discover help chapters | API |
helpChapter |
family: String!, slug: String! |
HelpChapter |
Read a help chapter | API |
searchHelp |
query: String!, family: String |
HelpSearchResult! |
Find help by search term | API |
schemaAuthoringCatalog |
None | JSON! |
Discover supported schema authoring features | API |
compileSchemaXML |
sourceXML: String! |
String! |
Convert an authored XML schema to JSON Schema | API |
renderSchemaXML |
schemaJSON: String! |
String! |
Convert JSON Schema to authored XML | API |
iacSchemaDocument |
ref: String! |
IaCSchemaDocumentPayload! |
Read a schema document used by IaC tooling | API |
topicExamples |
names: [String!]! |
[TopicExample!]! |
Retrieve named examples with their operations and variables. | API |
Subscription
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
dataChangeEvents |
topics: [String!]! |
DataChangeEvent! |
Subscribe to record-change events | API |
Types
These tables cover operation inputs, their nested inputs, result envelopes, records and immediate related results. Type names also identify relationships to other topics; consult those topics for their workflows. Scalar names such as OrderID, ISO8601 and CurrencyISO describe the expected identifier, date-time or currency value.
AddressState
| Field | Type | Default | Arguments |
|---|---|---|---|
timezone |
String |
— | — |
id |
AddressID! |
— | — |
customerId |
CustomerID |
— | — |
contactId |
ContactID |
— | — |
supplierId |
SupplierID |
— | — |
externalId |
String |
— | — |
addressType |
AddressType! |
— | — |
street1 |
String! |
— | — |
street2 |
String |
— | — |
city |
String! |
— | — |
state |
String |
— | — |
postalCode |
String |
— | — |
country |
String! |
— | — |
isDefault |
Boolean! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
AddressType
BILLING, SHIPPING, BOTH
AppointmentObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
confirmed |
Boolean! |
— | — |
ApprovalObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
taskId |
TaskID |
— | — |
taskOutcome |
String |
— | — |
approved |
Boolean! |
— | — |
approverContactId |
ContactID |
— | — |
approvingRole |
String |
— | — |
event |
RequirementLogisticsEvent! |
— | — |
assetId |
FileID |
— | — |
ApprovalPrerequisiteRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
subject |
String! |
— | — |
approverContactId |
ContactID |
— | — |
approvingRole |
String |
— | — |
event |
RequirementLogisticsEvent! |
— | — |
assetId |
FileID |
— | — |
ArrivalWindowRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
schedule |
RequirementScheduleReference! |
— | — |
BoolFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
Boolean |
— | — |
CarrierConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[CarrierEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
CarrierEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
CarrierState! |
— | — |
cursor |
String! |
— | — |
CarrierFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
isActive |
BoolFilter |
— | — |
CarrierSortField
NAME, CREATED_AT
CarrierSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
CarrierSortField! |
— | — |
direction |
SortDirection! |
— | — |
CarrierState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
CarrierID! |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
serviceName |
String |
— | — |
trackingUrlTemplate |
String |
— | — |
pickUpCutoff |
String |
— | — |
transitDays |
Int |
— | — |
accountNumber |
String |
— | — |
contactName |
String |
— | — |
contactPhone |
String |
— | — |
contactEmail |
String |
— | — |
isActive |
Boolean! |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
ConsolidationCompatibility
| Field | Type | Default | Arguments |
|---|---|---|---|
outcome |
RequirementAssessmentOutcome! |
— | — |
diagnostics |
[String!]! |
— | — |
ContactObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
contactId |
ContactID |
— | — |
recipientRole |
String |
— | — |
event |
RequirementLogisticsEvent! |
— | — |
channel |
RequirementContactChannel! |
— | — |
achieved |
RequirementContactSatisfaction |
— | — |
failed |
Boolean! |
— | — |
ContactState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ContactID! |
— | — |
customerId |
CustomerID! |
— | — |
externalId |
String |
— | — |
firstName |
String! |
— | — |
lastName |
String! |
— | — |
email |
String |
— | — |
phone |
String |
— | — |
jobTitle |
String |
— | — |
isPrimary |
Boolean! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
CreateCarrierInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
code |
String |
— | — |
serviceName |
String |
— | — |
trackingUrlTemplate |
String |
— | — |
pickUpCutoff |
String |
— | — |
transitDays |
Int |
— | — |
accountNumber |
String |
— | — |
contactName |
String |
— | — |
contactPhone |
String |
— | — |
contactEmail |
String |
— | — |
isActive |
Boolean |
— | — |
notes |
String |
— | — |
CreateEntityNoteInput
| Field | Type | Default | Arguments |
|---|---|---|---|
targetId |
ID! |
— | — |
body |
String! |
— | — |
attribution |
EntityNoteAttributionInput |
— | — |
source |
EntityNoteSourceInput |
— | — |
CreateJobMaterialReservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
requiredQuantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
preferredLocationId |
WarehouseLocationID |
— | — |
notes |
String |
— | — |
CreatePurchaseOrderInput
| Field | Type | Default | Arguments |
|---|---|---|---|
supplierId |
SupplierID! |
— | — |
poNumber |
String! |
— | — |
deliveryAddressId |
AddressID |
— | — |
currency |
CurrencyISO! |
— | — |
orderDate |
String |
— | — |
expectedDeliveryDate |
String |
— | — |
jobId |
JobID |
— | — |
notes |
String |
— | — |
lines |
[PurchaseOrderLineInput!]! |
— | — |
CreatePurchaseOrderPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
purchaseOrder |
PurchaseOrderState |
— | — |
purchaseOrderLines |
[PurchaseOrderLineState!] |
— | — |
errors |
[FieldError!]! |
— | — |
CreateShipmentInput
| Field | Type | Default | Arguments |
|---|---|---|---|
orderId |
OrderID |
— | — |
carrierId |
CarrierID |
— | — |
destinationSnapshot |
DeliveryAddressSnapshotInput |
— | — |
shippingAddressId |
AddressID |
— | — |
shipmentNumber |
String |
— | — |
trackingNumber |
String |
— | — |
trackingUrl |
String |
— | — |
status |
ShipmentStatus |
— | — |
totalWeight |
Float |
— | — |
totalPackages |
Int |
— | — |
shippingCost |
Float |
— | — |
currency |
CurrencyISO |
— | — |
estimatedDeliveryAt |
ISO8601 |
— | — |
shippedAt |
ISO8601 |
— | — |
deliveredAt |
ISO8601 |
— | — |
notes |
String |
— | — |
CreateShipmentItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
packageId |
ShipmentPackageID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
quantity |
Int! |
— | — |
CreateShipmentPackageInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentId |
ShipmentID! |
— | — |
packageNumber |
Int! |
— | — |
trackingNumber |
String |
— | — |
length |
Float |
— | — |
width |
Float |
— | — |
height |
Float |
— | — |
weight |
Float |
— | — |
packagingType |
String |
— | — |
notes |
String |
— | — |
CreateWarehouseLocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
parentId |
WarehouseLocationID |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
locationType |
WarehouseLocationType |
— | — |
description |
String |
— | — |
maxWeight |
Float |
— | — |
maxVolume |
Float |
— | — |
isActive |
Boolean |
— | — |
sortOrder |
Int |
— | — |
CreateWarehouseStockInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLot |
NewMaterialLotInput |
— | — |
materialLotId |
MaterialLotID |
— | — |
locationId |
WarehouseLocationID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit |
— | — |
reservedQuantity |
Float |
— | — |
batchNumber |
String |
— | — |
expiryDate |
ISO8601 |
— | — |
lastCountedAt |
ISO8601 |
— | — |
notes |
String |
— | — |
CreateWarehouseTransferInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLotId |
MaterialLotID |
— | — |
sourceLocationId |
WarehouseLocationID! |
— | — |
destinationLocationId |
WarehouseLocationID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit |
— | — |
reason |
StockMovementReason! |
— | — |
notes |
String |
— | — |
referenceType |
String |
— | — |
referenceId |
String |
— | — |
status |
TransferStatus |
— | — |
requestedByUserId |
UserID |
— | — |
approvedByUserId |
UserID |
— | — |
completedByUserId |
UserID |
— | — |
requestedAt |
ISO8601 |
— | — |
approvedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
CustomerFulfillmentDefault
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
CustomerFulfillmentDefaultID! |
— | — |
customerId |
CustomerID! |
— | — |
name |
String! |
— | — |
scope |
RequirementDefaultScope! |
— | — |
originalUserId |
UserID |
— | — |
recordedByUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceReference |
String |
— | — |
version |
Int! |
— | — |
retiredAt |
ISO8601 |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
value |
FulfillmentRequirementValue! |
— | — |
CustomerFulfillmentDefaultConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[CustomerFulfillmentDefaultEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
CustomerFulfillmentDefaultEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
CustomerFulfillmentDefault! |
— | — |
cursor |
String! |
— | — |
CustomerFulfillmentDefaultInput
| Field | Type | Default | Arguments |
|---|---|---|---|
customerId |
CustomerID! |
— | — |
name |
String! |
— | — |
scope |
RequirementDefaultScope! |
— | — |
value |
RequirementValueInput! |
— | — |
attribution |
RequirementAttributionInput |
— | — |
CustomerFulfillmentDefaultPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
customerFulfillmentDefault |
CustomerFulfillmentDefault |
— | — |
errors |
[FieldError!]! |
— | — |
CustomerState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
CustomerID! |
— | — |
name |
String! |
— | — |
externalId |
String |
— | — |
email |
String |
— | — |
phone |
String |
— | — |
notes |
String |
— | — |
isActive |
Boolean! |
— | — |
creditLimit |
Float |
— | — |
creditCurrency |
CurrencyISO |
— | — |
paymentTermsDays |
Int |
— | — |
isCreditHold |
Boolean! |
— | — |
creditHoldReason |
String |
— | — |
defaultTaxCodeId |
TaxCodeID |
— | — |
isTaxExempt |
Boolean! |
— | — |
taxExemptReference |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
contacts |
[ContactState!]! |
— | — |
addresses |
[AddressState!]! |
— | — |
DailyDispatchManifestPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
entries |
[DispatchManifestEntry!]! |
— | — |
totalShipments |
Int! |
— | — |
totalPackages |
Int! |
— | — |
errors |
[FieldError!]! |
— | — |
DeletePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeliveryAddressSnapshot
| Field | Type | Default | Arguments |
|---|---|---|---|
recipientName |
String |
— | — |
recipientOrganization |
String |
— | — |
recipientContactId |
ContactID |
— | — |
street1 |
String |
— | — |
street2 |
String |
— | — |
city |
String |
— | — |
region |
String |
— | — |
postalCode |
String |
— | — |
country |
String |
— | — |
DeliveryAddressSnapshotInput
| Field | Type | Default | Arguments |
|---|---|---|---|
recipientName |
String |
— | — |
recipientOrganization |
String |
— | — |
recipientContactId |
ContactID |
— | — |
street1 |
String |
— | — |
street2 |
String |
— | — |
city |
String |
— | — |
region |
String |
— | — |
postalCode |
String |
— | — |
country |
String |
— | — |
DeliveryArrivalInput
| Field | Type | Default | Arguments |
|---|---|---|---|
meaning |
DeliveryArrivalMeaning! |
— | — |
earliest |
DeliveryTimeInput |
— | — |
latest |
DeliveryTimeInput |
— | — |
timezone |
String |
— | — |
DeliveryArrivalMeaning
REQUESTED, REQUIRED_BY, WINDOW, APPOINTMENT
DeliveryArrivalOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
timezoneSource |
String |
— | — |
meaning |
DeliveryArrivalMeaning! |
— | — |
earliest |
DeliveryTimeOutput |
— | — |
latest |
DeliveryTimeOutput |
— | — |
timezone |
String |
— | — |
DeliveryTimeInput
| Field | Type | Default | Arguments |
|---|---|---|---|
date |
String |
— | — |
instant |
String |
— | — |
DeliveryTimeOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
date |
String |
— | — |
instant |
String |
— | — |
DispatchManifestEntry
| Field | Type | Default | Arguments |
|---|---|---|---|
shipment |
ShipmentState! |
— | — |
packages |
[ShipmentPackageState!]! |
— | — |
items |
[ShipmentItemState!]! |
— | — |
order |
OrderState |
— | — |
DispatchPlannedAllocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
expectedVersion |
Int! |
— | — |
quantity |
Int! |
— | — |
DispatchRequirementCheckInput
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
requirement |
RequirementReferenceInput! |
— | — |
DispatchShipmentInput
| Field | Type | Default | Arguments |
|---|---|---|---|
requireCompatibility |
Boolean |
— | — |
destinationSnapshot |
DeliveryAddressSnapshotInput |
— | — |
requirementChecks |
[DispatchRequirementCheckInput!] |
— | — |
orderId |
OrderID |
— | — |
carrierId |
CarrierID |
— | — |
shippingAddressId |
AddressID |
— | — |
shipmentNumber |
String |
— | — |
trackingNumber |
String |
— | — |
shippingCost |
Float |
— | — |
currency |
CurrencyISO |
— | — |
notes |
String |
— | — |
packages |
[DispatchShipmentPackageInput!]! |
— | — |
DispatchShipmentItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedAllocations |
[DispatchPlannedAllocationInput!] |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
quantity |
Int! |
— | — |
DispatchShipmentPackageInput
| Field | Type | Default | Arguments |
|---|---|---|---|
weight |
Float |
— | — |
length |
Float |
— | — |
width |
Float |
— | — |
height |
Float |
— | — |
packagingType |
String |
— | — |
trackingNumber |
String |
— | — |
items |
[DispatchShipmentItemInput!]! |
— | — |
DispatchShipmentPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipment |
ShipmentState |
— | — |
packages |
[ShipmentPackageState!] |
— | — |
items |
[ShipmentItemState!] |
— | — |
errors |
[FieldError!]! |
— | — |
DispatchWindowRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
dispatchAddressId |
AddressID |
— | — |
earliest |
DeliveryTimeInput |
— | — |
latest |
DeliveryTimeInput |
— | — |
timezone |
String |
— | — |
DocumentAttachmentRole
ORIGINAL_DOCUMENT, ACKNOWLEDGEMENT, SPECIFICATION, RECEIPT, CORRESPONDENCE, OTHER
EffectiveFulfillmentRequirement
| Field | Type | Default | Arguments |
|---|---|---|---|
requirement |
FulfillmentRequirement! |
— | — |
applicable |
Boolean! |
— | — |
requiresReview |
Boolean! |
— | — |
diagnostics |
[String!]! |
— | — |
EntityNote
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
EntityNoteIDSpecTypedID! |
— | — |
targetId |
ID! |
— | — |
body |
String! |
— | — |
version |
Int! |
— | — |
contentVersion |
Int! |
— | — |
authorUserId |
UserID |
— | — |
externalAuthorId |
String |
— | — |
externalAuthorName |
String |
— | — |
authoredAt |
ISO8601 |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceKey |
String |
— | — |
sourceRevision |
String |
— | — |
createdByUserId |
UserID |
— | — |
updatedByUserId |
UserID |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
EntityNoteAttributionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
userId |
UserID |
— | — |
externalAuthorId |
String |
— | — |
externalAuthorName |
String |
— | — |
authoredAt |
ISO8601 |
— | — |
EntityNoteFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
targetId |
ID |
— | — |
authorUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
EntityNotePage
| Field | Type | Default | Arguments |
|---|---|---|---|
notes |
[EntityNote!]! |
— | — |
nextCursor |
String |
— | — |
totalCount |
Int! |
— | — |
EntityNotePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
entityNote |
EntityNote |
— | — |
errors |
[FieldError!]! |
— | — |
EntityNoteReindexResult
| Field | Type | Default | Arguments |
|---|---|---|---|
queuedCount |
Int! |
— | — |
nextCursor |
String |
— | — |
EntityNoteSearchHit
| Field | Type | Default | Arguments |
|---|---|---|---|
note |
EntityNote! |
— | — |
similarity |
Float! |
— | — |
EntityNoteSearchPage
| Field | Type | Default | Arguments |
|---|---|---|---|
hits |
[EntityNoteSearchHit!]! |
— | — |
nextCursor |
String |
— | — |
visibleCount |
Int! |
— | — |
indexedCount |
Int! |
— | — |
indexingComplete |
Boolean! |
— | — |
embeddingAvailable |
Boolean! |
— | — |
EntityNoteSourceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
integrationInstanceId |
IntegrationInstanceID! |
— | — |
key |
String! |
— | — |
revision |
String |
— | — |
ExistingDeliveryAddressInput
| Field | Type | Default | Arguments |
|---|---|---|---|
addressId |
AddressID! |
— | — |
recipientName |
String |
— | — |
recipientOrganization |
String |
— | — |
recipientContactId |
ContactID |
— | — |
FieldError
| Field | Type | Default | Arguments |
|---|---|---|---|
code |
String |
— | — |
source |
SourceDiagnostic |
— | — |
path |
String! |
— | — |
message |
String! |
— | — |
FulfillmentCompletionPoint
DISPATCH, DELIVERY
FulfillmentRequirement
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
FulfillmentRequirementID! |
— | — |
plannedDeliveryId |
PlannedDeliveryID! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
sourceDefaultId |
CustomerFulfillmentDefaultID |
— | — |
sourceDefaultVersion |
Int |
— | — |
replacesRequirementId |
FulfillmentRequirementID |
— | — |
replacesRequirementVersion |
Int |
— | — |
replacementReason |
String |
— | — |
originalUserId |
UserID |
— | — |
recordedByUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceReference |
String |
— | — |
version |
Int! |
— | — |
retiredAt |
ISO8601 |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
value |
FulfillmentRequirementValue! |
— | — |
FulfillmentRequirementAssessment
| Field | Type | Default | Arguments |
|---|---|---|---|
results |
[RequirementAssessmentResult!]! |
— | — |
needsResolution |
Boolean! |
— | — |
diagnostics |
[String!]! |
— | — |
evaluatedAt |
ISO8601! |
— | — |
FulfillmentRequirementComposition
| Field | Type | Default | Arguments |
|---|---|---|---|
requirements |
[EffectiveFulfillmentRequirement!]! |
— | — |
needsResolution |
Boolean! |
— | — |
diagnostics |
[String!]! |
— | — |
FulfillmentRequirementConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[FulfillmentRequirementEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
FulfillmentRequirementEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
FulfillmentRequirement! |
— | — |
cursor |
String! |
— | — |
FulfillmentRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
scope |
FulfillmentRequirementScopeInput! |
— | — |
value |
RequirementValueInput! |
— | — |
replaces |
RequirementReferenceInput |
— | — |
replacementReason |
String |
— | — |
attribution |
RequirementAttributionInput |
— | — |
FulfillmentRequirementPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
fulfillmentRequirement |
FulfillmentRequirement |
— | — |
errors |
[FieldError!]! |
— | — |
FulfillmentRequirementScopeInput
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryId |
PlannedDeliveryID |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
FulfillmentRequirementValue
FulfillmentRequirementValue
FulfillmentSettings
| Field | Type | Default | Arguments |
|---|---|---|---|
completionPoint |
FulfillmentCompletionPoint! |
— | — |
lastChange |
SettingsChange |
— | — |
FulfillmentSettingsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
completionPoint |
FulfillmentCompletionPoint! |
— | — |
GraphEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
source |
String! |
— | — |
target |
String! |
— | — |
rel |
String! |
— | — |
GraphNode
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
type |
String! |
— | — |
status |
String |
— | — |
label |
String |
— | — |
depth |
Int |
— | — |
GraphTrace
| Field | Type | Default | Arguments |
|---|---|---|---|
nodes |
[GraphNode!]! |
— | — |
edges |
[GraphEdge!]! |
— | — |
HandlingObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
supportedCapabilityIds |
[CapabilityID!]! |
— | — |
unsupportedCapabilityIds |
[CapabilityID!]! |
— | — |
HandlingServiceRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
capabilityIds |
[CapabilityID!]! |
— | — |
IDFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
ID |
— | — |
neq |
ID |
— | — |
in |
[ID!] |
— | — |
notIn |
[ID!] |
— | — |
IssueStockItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
warehouseStockId |
WarehouseStockID! |
— | — |
quantity |
Float! |
— | — |
jobId |
JobID |
— | — |
notes |
String |
— | — |
IssueStockToProductionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
items |
[IssueStockItemInput!]! |
— | — |
IssueStockToProductionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
transfers |
[WarehouseTransferState!] |
— | — |
updatedStocks |
[WarehouseStockState!] |
— | — |
errors |
[FieldError!]! |
— | — |
JobMaterialReservationConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[JobMaterialReservationEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
JobMaterialReservationEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
JobMaterialReservationState! |
— | — |
cursor |
String! |
— | — |
JobMaterialReservationFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
IDFilter |
— | — |
status |
MaterialReservationStatusFilter |
— | — |
stockableType |
StringFilter |
— | — |
JobMaterialReservationSortField
STATUS, REQUIRED_QUANTITY, CREATED_AT, UPDATED_AT
JobMaterialReservationSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
JobMaterialReservationSortField! |
— | — |
direction |
SortDirection! |
— | — |
JobMaterialReservationState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
JobMaterialReservationID! |
— | — |
jobId |
JobID! |
— | — |
stockable |
Stockable! |
— | — |
requiredQuantity |
Float! |
— | — |
reservedQuantity |
Float! |
— | — |
availableToReserve |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
preferredLocationId |
WarehouseLocationID |
— | — |
notes |
String |
— | — |
status |
MaterialReservationStatus! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
LabelingRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
templateVersionId |
TemplateVersionID! |
— | — |
level |
RequirementPackingLevel! |
— | — |
placement |
RequirementLabelPlacement! |
— | — |
removable |
Boolean! |
— | — |
LabelObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
applied |
Boolean! |
— | — |
templateVersionId |
TemplateVersionID |
— | — |
level |
RequirementPackingLevel! |
— | — |
placement |
RequirementLabelPlacement |
— | — |
removable |
Boolean |
— | — |
MaterialLot
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
MaterialLotID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
unit |
MeasurementUnit! |
— | — |
stage |
MaterialStage! |
— | — |
batchReference |
String! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
createdAt |
ISO8601! |
— | — |
MaterialReservationStatus
PENDING, RESERVED, PARTIALLY_RESERVED, CONSUMED, CANCELLED
MaterialReservationStatusFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
MaterialReservationStatus |
— | — |
neq |
MaterialReservationStatus |
— | — |
in |
[MaterialReservationStatus!] |
— | — |
notIn |
[MaterialReservationStatus!] |
— | — |
MaterialStage
RAW, PRINTED, FINISHED, PACKAGED, WASTE
MeasurementUnit
CLICK, CM, FT, G, IMPRESSION, IN, KG, LB, M, MM, OZ, PC, PT, SHEET
NewMaterialLotInput
| Field | Type | Default | Arguments |
|---|---|---|---|
batchReference |
String! |
— | — |
stage |
MaterialStage |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
NotificationObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
notice |
RequirementNotice! |
— | — |
recipientId |
NotificationRecipientID |
— | — |
recipientRole |
String |
— | — |
event |
RequirementLogisticsEvent! |
— | — |
status |
RequirementNoticeObservation! |
— | — |
NotificationRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
notice |
RequirementNotice! |
— | — |
required |
Boolean! |
— | — |
recipientId |
NotificationRecipientID |
— | — |
recipientRole |
String |
— | — |
event |
RequirementLogisticsEvent |
— | — |
OrderFulfillmentCompletion
| Field | Type | Default | Arguments |
|---|---|---|---|
orderId |
OrderID! |
— | — |
completionPoint |
FulfillmentCompletionPoint! |
— | — |
outcome |
RequirementAssessmentOutcome! |
— | — |
items |
[PlannedItemCompletion!]! |
— | — |
diagnostics |
[String!]! |
— | — |
diagnosticSummary |
String! |
— | — |
OrderLineState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
OrderLineID! |
— | — |
tenantId |
TenantID! |
— | — |
orderId |
OrderID! |
— | — |
lineNumber |
Int! |
— | — |
productId |
ProductID |
— | — |
productSku |
String |
— | — |
productName |
String! |
— | — |
description |
String |
— | — |
quantity |
Int! |
— | — |
unitPrice |
Float! |
— | — |
discountPercent |
Float |
— | — |
discountAmount |
Float |
— | — |
taxRate |
Float |
— | — |
lineTotal |
Float! |
— | — |
jobId |
JobID |
— | — |
estimateLineId |
EstimateLineID |
— | — |
productTemplateId |
ProductTemplateID |
— | — |
productTemplateVersion |
Int |
— | — |
templateConfig |
JSON |
— | — |
currency |
CurrencyISO! |
— | — |
notes |
String |
— | — |
groupKey |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
order |
OrderState |
— | — |
product |
ProductState |
— | — |
job |
JobState |
— | — |
attachments |
[OrderLineFileAttachment!]! |
— | — |
OrderState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
OrderID! |
— | — |
tenantId |
TenantID! |
— | — |
orderNumber |
String! |
— | — |
externalId |
String |
— | — |
poReference |
String |
— | — |
customerId |
CustomerID! |
— | — |
contactId |
ContactID |
— | — |
billingAddressId |
AddressID |
— | — |
shippingAddressId |
AddressID |
— | — |
estimateId |
EstimateID |
— | — |
status |
OrderStatus! |
— | — |
paymentStatus |
PaymentStatus! |
— | — |
orderDate |
ISO8601! |
— | — |
requiredDeliveryDate |
ISO8601 |
— | — |
promisedDeliveryDate |
ISO8601 |
— | — |
confirmedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
cancelledAt |
ISO8601 |
— | — |
subtotalAmount |
Float! |
— | — |
taxAmount |
Float! |
— | — |
totalAmount |
Float! |
— | — |
currency |
CurrencyISO! |
— | — |
taxRate |
Float |
— | — |
shippingMethod |
String |
— | — |
shippingCost |
Float |
— | — |
notes |
String |
— | — |
internalNotes |
String |
— | — |
tags |
[String!] |
— | — |
createdByUserId |
UserID |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
customer |
CustomerState |
— | — |
contact |
ContactState |
— | — |
billingAddress |
AddressState |
— | — |
shippingAddress |
AddressState |
— | — |
orderLines |
[OrderLineState!]! |
— | — |
createdByUser |
UserState |
— | — |
OrderStatus
DRAFT, CONFIRMED, IN_PRODUCTION, PARTIALLY_SHIPPED, SHIPPED, DELIVERED, COMPLETED, CANCELLED, ON_HOLD
PackagingObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
level |
RequirementPackingLevel! |
— | — |
methods |
[String!]! |
— | — |
PackagingRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
level |
RequirementPackingLevel! |
— | — |
method |
String! |
— | — |
rule |
RequirementPackagingRule! |
— | — |
PackingObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
level |
RequirementPackingLevel! |
— | — |
contents |
RequirementPackingContents! |
— | — |
counts |
[Int!]! |
— | — |
PackQuantityRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
level |
RequirementPackingLevel! |
— | — |
contents |
RequirementPackingContents! |
— | — |
quantity |
Int! |
— | — |
partialPacks |
RequirementPartialPacks! |
— | — |
PageInfo
| Field | Type | Default | Arguments |
|---|---|---|---|
hasNextPage |
Boolean! |
— | — |
hasPreviousPage |
Boolean! |
— | — |
startCursor |
String |
— | — |
endCursor |
String |
— | — |
PaymentStatus
UNPAID, PARTIALLY_PAID, PAID, OVERDUE, REFUNDED, WRITTEN_OFF
PerformStockCountInput
| Field | Type | Default | Arguments |
|---|---|---|---|
locationId |
WarehouseLocationID! |
— | — |
counts |
[StockCountItemInput!]! |
— | — |
PerformStockCountPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
updatedStocks |
[WarehouseStockState!] |
— | — |
adjustments |
[WarehouseTransferState!] |
— | — |
errors |
[FieldError!]! |
— | — |
PlannedDeliveryConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[PlannedDeliveryEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
PlannedDeliveryDestinationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
existingAddress |
ExistingDeliveryAddressInput |
— | — |
snapshot |
DeliveryAddressSnapshotInput |
— | — |
PlannedDeliveryEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
PlannedDeliveryState! |
— | — |
cursor |
String! |
— | — |
PlannedDeliveryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
customerId |
CustomerID |
— | — |
destination |
PlannedDeliveryDestinationInput! |
— | — |
requestedArrival |
DeliveryArrivalInput |
— | — |
PlannedDeliveryItemConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[PlannedDeliveryItemEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
PlannedDeliveryItemEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
PlannedDeliveryItemState! |
— | — |
cursor |
String! |
— | — |
PlannedDeliveryItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryId |
PlannedDeliveryID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
requestedQuantity |
Int! |
— | — |
PlannedDeliveryItemPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItem |
PlannedDeliveryItemState |
— | — |
errors |
[FieldError!]! |
— | — |
PlannedDeliveryItemState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PlannedDeliveryItemID! |
— | — |
plannedDeliveryId |
PlannedDeliveryID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
requestedQuantity |
Int! |
— | — |
version |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
allocatedQuantity |
Int! |
— | — |
PlannedDeliveryPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDelivery |
PlannedDeliveryState |
— | — |
errors |
[FieldError!]! |
— | — |
PlannedDeliveryState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PlannedDeliveryID! |
— | — |
customerId |
CustomerID |
— | — |
defaultsCustomerId |
CustomerID |
— | — |
defaultsResolvedAt |
ISO8601 |
— | — |
sourceAddressId |
AddressID |
— | — |
destination |
DeliveryAddressSnapshot! |
— | — |
requestedArrival |
DeliveryArrivalOutput |
— | — |
version |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
PlannedItemCompletion
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
completionPoint |
FulfillmentCompletionPoint! |
— | — |
outcome |
RequirementAssessmentOutcome! |
— | — |
knownCreditedQuantity |
Int! |
— | — |
outstandingQuantity |
Int |
— | — |
diagnostics |
[String!]! |
— | — |
PlannedItemFulfillmentBalance
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
requestedQuantity |
Int! |
— | — |
allocatedQuantity |
Int! |
— | — |
stages |
[PlannedStageBalance!]! |
— | — |
netRetainedQuantity |
Int |
— | — |
netAttributionComplete |
Boolean! |
— | — |
PlannedItemReview
| Field | Type | Default | Arguments |
|---|---|---|---|
completion |
PlannedItemCompletion! |
— | — |
delivery |
PlannedDeliveryState! |
— | — |
item |
PlannedDeliveryItemState! |
— | — |
balance |
PlannedItemFulfillmentBalance! |
— | — |
requirements |
FulfillmentRequirementComposition! |
— | — |
assessment |
FulfillmentRequirementAssessment! |
— | — |
notes |
EntityNotePage! |
— | — |
PlannedStageBalance
| Field | Type | Default | Arguments |
|---|---|---|---|
stage |
ShipmentEvidenceStage! |
— | — |
knownCreditedQuantity |
Int! |
— | — |
attributionComplete |
Boolean! |
— | — |
remainingQuantity |
Int |
— | — |
PriorContactRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
contactId |
ContactID |
— | — |
recipientRole |
String |
— | — |
event |
RequirementLogisticsEvent! |
— | — |
channel |
RequirementContactChannel! |
— | — |
satisfaction |
RequirementContactSatisfaction! |
— | — |
PurchaseOrderFileAttachment
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PurchaseOrderFileID! |
— | — |
purchaseOrderId |
PurchaseOrderID! |
— | — |
fileId |
FileID! |
— | — |
documentRole |
DocumentAttachmentRole! |
— | — |
description |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
PurchaseOrderLineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
substrateId |
SubstrateID |
— | — |
description |
String! |
— | — |
supplierProductCode |
String |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
unitPrice |
Float! |
— | — |
PurchaseOrderLineState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PurchaseOrderLineID! |
— | — |
purchaseOrderId |
PurchaseOrderID! |
— | — |
lineNumber |
Int! |
— | — |
substrateId |
SubstrateID |
— | — |
description |
String! |
— | — |
supplierProductCode |
String |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
unitPrice |
Float! |
— | — |
lineTotal |
Float! |
— | — |
currency |
CurrencyISO! |
— | — |
receivedQuantity |
Float! |
— | — |
receivedAt |
ISO8601 |
— | — |
notes |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
purchaseOrder |
PurchaseOrderState |
— | — |
PurchaseOrderState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PurchaseOrderID! |
— | — |
poNumber |
String! |
— | — |
supplierId |
SupplierID! |
— | — |
deliveryAddressId |
AddressID |
— | — |
status |
PurchaseOrderStatus! |
— | — |
orderDate |
ISO8601! |
— | — |
expectedDeliveryDate |
ISO8601 |
— | — |
receivedAt |
ISO8601 |
— | — |
subtotalAmount |
Float! |
— | — |
taxAmount |
Float! |
— | — |
totalAmount |
Float! |
— | — |
currency |
CurrencyISO! |
— | — |
jobId |
JobID |
— | — |
notes |
String |
— | — |
internalNotes |
String |
— | — |
createdByUserId |
UserID |
— | — |
approvedByUserId |
UserID |
— | — |
approvedAt |
ISO8601 |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
supplier |
SupplierState |
— | — |
purchaseOrderLines |
[PurchaseOrderLineState!]! |
— | — |
createdByUser |
UserState |
— | — |
attachments |
[PurchaseOrderFileAttachment!]! |
— | — |
PurchaseOrderStatus
DRAFT, SUBMITTED, ACKNOWLEDGED, PARTIALLY_RECEIVED, RECEIVED, CANCELLED, DISPUTED
QuantityToleranceRequirementInput
| Field | Type | Default | Arguments |
|---|---|---|---|
baseline |
RequirementBaselineInput! |
— | — |
lower |
RequirementToleranceBoundInput |
— | — |
upper |
RequirementToleranceBoundInput |
— | — |
ReceivePurchaseOrderInput
| Field | Type | Default | Arguments |
|---|---|---|---|
purchaseOrderId |
PurchaseOrderID! |
— | — |
warehouseLocationId |
WarehouseLocationID |
— | — |
receivedLines |
[ReceivePurchaseOrderLineInput!]! |
— | — |
ReceivePurchaseOrderLineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
purchaseOrderLineId |
PurchaseOrderLineID! |
— | — |
receivedQuantity |
Float! |
— | — |
ReceivePurchaseOrderPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
purchaseOrder |
PurchaseOrderState |
— | — |
updatedLines |
[PurchaseOrderLineState!] |
— | — |
stockEntries |
[WarehouseStockState!] |
— | — |
errors |
[FieldError!]! |
— | — |
RecordRequirementEvidenceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
requirement |
RequirementReferenceInput! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
observation |
RequirementObservationInput! |
— | — |
complete |
Boolean! |
— | — |
occurredAt |
DeliveryTimeInput |
— | — |
attribution |
RequirementAttributionInput |
— | — |
requestKey |
String! |
— | — |
correctsEvidenceId |
RequirementEvidenceIDSpecTypedID |
— | — |
reason |
String |
— | — |
RequirementAssessmentOutcome
SATISFIED, UNSATISFIED, UNKNOWN, NOT_APPLICABLE
RequirementAssessmentResult
| Field | Type | Default | Arguments |
|---|---|---|---|
diagnosticSummary |
String! |
— | — |
requirementId |
FulfillmentRequirementID! |
— | — |
requirementVersion |
Int! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
outcome |
RequirementAssessmentOutcome! |
— | — |
diagnostics |
[String!]! |
— | — |
evidenceIds |
[RequirementEvidenceIDSpecTypedID!]! |
— | — |
shipmentEvidenceIds |
[ShipmentItemEvidenceIDSpecTypedID!]! |
— | — |
assessedQuantity |
Int |
— | — |
RequirementAttributionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
originalUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceReference |
String |
— | — |
RequirementBaselineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
scopedItemJob |
Boolean |
— | — |
scopedItemQuantity |
Boolean |
— | — |
RequirementContactChannel
EMAIL, PHONE
RequirementContactSatisfaction
SENT, CONTACTED, CONFIRMED
RequirementDefaultScope
DELIVERY, EACH_ITEM
RequirementEvidence
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
RequirementEvidenceIDSpecTypedID! |
— | — |
requirementId |
FulfillmentRequirementID! |
— | — |
requirementVersion |
Int! |
— | — |
plannedDeliveryId |
PlannedDeliveryID! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID |
— | — |
complete |
Boolean! |
— | — |
correctsEvidenceId |
RequirementEvidenceIDSpecTypedID |
— | — |
reason |
String |
— | — |
originalUserId |
UserID |
— | — |
recordedByUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceReference |
String |
— | — |
coveredItems |
[RequirementEvidenceCoveredItem!]! |
— | — |
observation |
RequirementObservation! |
— | — |
occurredAt |
DeliveryTimeOutput |
— | — |
createdAt |
String! |
— | — |
supersededBy |
RequirementEvidenceIDSpecTypedID |
— | — |
RequirementEvidenceConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[RequirementEvidenceEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
RequirementEvidenceCoveredItem
| Field | Type | Default | Arguments |
|---|---|---|---|
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
quantity |
Int! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
RequirementEvidenceEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
RequirementEvidence! |
— | — |
cursor |
String! |
— | — |
RequirementEvidencePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
requirementEvidence |
RequirementEvidence |
— | — |
errors |
[FieldError!]! |
— | — |
RequirementLabelPlacement
FRONT, BACK, BACK_UPPER_HALF, PACK_EXTERIOR, PALLET_EXTERIOR, TEMPLATE_DEFINED
RequirementLogisticsEvent
DISPATCH, DELIVERY, COLLECTION
RequirementNotice
ADVANCE_SHIPPING_NOTICE, DISPATCH_CONFIRMATION, DELIVERY_CONFIRMATION
RequirementNoticeObservation
QUEUED, SENT, DELIVERED, ACKNOWLEDGED, FAILED
RequirementObservation
RequirementObservation
RequirementObservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
packing |
PackingObservationInput |
— | — |
packaging |
PackagingObservationInput |
— | — |
labeling |
LabelObservationInput |
— | — |
handling |
HandlingObservationInput |
— | — |
contact |
ContactObservationInput |
— | — |
approval |
ApprovalObservationInput |
— | — |
notification |
NotificationObservationInput |
— | — |
appointment |
AppointmentObservationInput |
— | — |
RequirementPackagingRule
REQUIRED, PROHIBITED
RequirementPackingContents
PER_ITEM, COMBINED
RequirementPackingLevel
PRODUCT, PACK, CARTON, PALLET
RequirementPartialPacks
ALLOWED, FORBIDDEN
RequirementPendingInput
| Field | Type | Default | Arguments |
|---|---|---|---|
quantityTolerance |
RequirementPendingReasonInput |
— | — |
dispatchWindow |
RequirementPendingReasonInput |
— | — |
arrivalWindow |
RequirementPendingReasonInput |
— | — |
packQuantity |
RequirementPendingReasonInput |
— | — |
packaging |
RequirementPendingReasonInput |
— | — |
labeling |
RequirementPendingReasonInput |
— | — |
handlingService |
RequirementPendingReasonInput |
— | — |
priorContact |
RequirementPendingReasonInput |
— | — |
approvalPrerequisite |
RequirementPendingReasonInput |
— | — |
notification |
RequirementPendingReasonInput |
— | — |
RequirementPendingReasonInput
| Field | Type | Default | Arguments |
|---|---|---|---|
reason |
String! |
— | — |
RequirementReferenceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
FulfillmentRequirementID! |
— | — |
version |
Int! |
— | — |
RequirementScheduleReference
PLANNED_DELIVERY
RequirementSpecInput
| Field | Type | Default | Arguments |
|---|---|---|---|
quantityTolerance |
QuantityToleranceRequirementInput |
— | — |
dispatchWindow |
DispatchWindowRequirementInput |
— | — |
arrivalWindow |
ArrivalWindowRequirementInput |
— | — |
packQuantity |
PackQuantityRequirementInput |
— | — |
packaging |
PackagingRequirementInput |
— | — |
labeling |
LabelingRequirementInput |
— | — |
handlingService |
HandlingServiceRequirementInput |
— | — |
priorContact |
PriorContactRequirementInput |
— | — |
approvalPrerequisite |
ApprovalPrerequisiteRequirementInput |
— | — |
notification |
NotificationRequirementInput |
— | — |
RequirementToleranceBoundInput
| Field | Type | Default | Arguments |
|---|---|---|---|
count |
Int |
— | — |
percent |
Float |
— | — |
RequirementValueInput
| Field | Type | Default | Arguments |
|---|---|---|---|
resolved |
RequirementSpecInput |
— | — |
pending |
RequirementPendingInput |
— | — |
waiver |
RequirementWaiverInput |
— | — |
RequirementWaiverInput
| Field | Type | Default | Arguments |
|---|---|---|---|
reason |
String! |
— | — |
ReserveJobMaterialsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID! |
— | — |
ReserveJobMaterialsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
reservations |
[JobMaterialReservationState!] |
— | — |
fullyReservedCount |
Int! |
— | — |
partiallyReservedCount |
Int! |
— | — |
unmetCount |
Int! |
— | — |
errors |
[FieldError!]! |
— | — |
SettingsChange
| Field | Type | Default | Arguments |
|---|---|---|---|
at |
ISO8601! |
— | — |
user |
UserID! |
— | — |
userName |
String |
— | — |
ShipmentAllocationReferenceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemAllocationID! |
— | — |
version |
Int! |
— | — |
ShipmentAttributionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
source |
ShipmentAttributionSourceInput! |
— | — |
quantity |
Int! |
— | — |
ShipmentAttributionSourceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
allocation |
ShipmentAllocationReferenceInput |
— | — |
previousAttributionId |
ShipmentItemAttributionIDSpecTypedID |
— | — |
ShipmentConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ShipmentEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ShipmentEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ShipmentState! |
— | — |
cursor |
String! |
— | — |
ShipmentEvidenceReferenceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemEvidenceIDSpecTypedID! |
— | — |
version |
Int! |
— | — |
ShipmentEvidenceStage
DISPATCH, RECEIPT, RETURN
ShipmentFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
ShipmentStatusFilter |
— | — |
orderId |
IDFilter |
— | — |
carrierId |
IDFilter |
— | — |
ShipmentItemAllocationConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ShipmentItemAllocationEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ShipmentItemAllocationEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ShipmentItemAllocationState! |
— | — |
cursor |
String! |
— | — |
ShipmentItemAllocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItemId |
ShipmentItemID! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
quantity |
Int! |
— | — |
ShipmentItemAllocationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItemAllocation |
ShipmentItemAllocationState |
— | — |
errors |
[FieldError!]! |
— | — |
ShipmentItemAllocationState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemAllocationID! |
— | — |
shipmentItemId |
ShipmentItemID! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
quantity |
Int! |
— | — |
version |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
ShipmentItemAttribution
| Field | Type | Default | Arguments |
|---|---|---|---|
isAllocationSnapshot |
Boolean! |
— | — |
id |
ShipmentItemAttributionIDSpecTypedID! |
— | — |
evidenceId |
ShipmentItemEvidenceIDSpecTypedID! |
— | — |
shipmentItemId |
ShipmentItemID! |
— | — |
allocationId |
ShipmentItemAllocationID! |
— | — |
allocationVersion |
Int! |
— | — |
allocationQuantity |
Int! |
— | — |
plannedDeliveryId |
PlannedDeliveryID! |
— | — |
plannedDeliveryItemId |
PlannedDeliveryItemID! |
— | — |
quantity |
Int! |
— | — |
previousAttributionId |
ShipmentItemAttributionIDSpecTypedID |
— | — |
recordedByUserId |
UserID |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
ShipmentItemConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ShipmentItemEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ShipmentItemEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ShipmentItemState! |
— | — |
cursor |
String! |
— | — |
ShipmentItemEvidence
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemEvidenceIDSpecTypedID! |
— | — |
shipmentItemId |
ShipmentItemID! |
— | — |
shipmentId |
ShipmentID! |
— | — |
stage |
ShipmentEvidenceStage! |
— | — |
quantity |
Int! |
— | — |
occurredAt |
DeliveryTimeOutput |
— | — |
correctsEvidenceId |
ShipmentItemEvidenceIDSpecTypedID |
— | — |
receiptEvidenceId |
ShipmentItemEvidenceIDSpecTypedID |
— | — |
reason |
String |
— | — |
originalUserId |
UserID |
— | — |
recordedByUserId |
UserID |
— | — |
sourceIntegrationInstanceId |
IntegrationInstanceID |
— | — |
sourceReference |
String |
— | — |
version |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
attributions |
[ShipmentItemAttribution!]! |
— | — |
supersededBy |
ShipmentItemEvidenceIDSpecTypedID |
— | — |
ShipmentItemEvidenceConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ShipmentItemEvidenceEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ShipmentItemEvidenceEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ShipmentItemEvidence! |
— | — |
cursor |
String! |
— | — |
ShipmentItemEvidenceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItemId |
ShipmentItemID! |
— | — |
stage |
ShipmentEvidenceStage! |
— | — |
quantity |
Int! |
— | — |
occurredAt |
DeliveryTimeInput |
— | — |
corrects |
ShipmentEvidenceReferenceInput |
— | — |
receiptEvidenceId |
ShipmentItemEvidenceIDSpecTypedID |
— | — |
reason |
String |
— | — |
requestKey |
String! |
— | — |
attribution |
RequirementAttributionInput |
— | — |
allocations |
[ShipmentAttributionInput!] |
— | — |
ShipmentItemEvidencePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItemEvidence |
ShipmentItemEvidence |
— | — |
errors |
[FieldError!]! |
— | — |
ShipmentItemExecutionBalance
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItemId |
ShipmentItemID! |
— | — |
stages |
[ShipmentStageBalance!]! |
— | — |
netRetainedQuantity |
Int |
— | — |
ShipmentItemFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
packageId |
IDFilter |
— | — |
jobId |
IDFilter |
— | — |
ShipmentItemSortField
QUANTITY, CREATED_AT
ShipmentItemSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
ShipmentItemSortField! |
— | — |
direction |
SortDirection! |
— | — |
ShipmentItemState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemID! |
— | — |
packageId |
ShipmentPackageID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
quantity |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
package |
ShipmentPackageState |
— | — |
ShipmentPackageConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ShipmentPackageEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ShipmentPackageEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ShipmentPackageState! |
— | — |
cursor |
String! |
— | — |
ShipmentPackageFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentId |
IDFilter |
— | — |
ShipmentPackageSortField
PACKAGE_NUMBER, CREATED_AT
ShipmentPackageSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
ShipmentPackageSortField! |
— | — |
direction |
SortDirection! |
— | — |
ShipmentPackageState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentPackageID! |
— | — |
shipmentId |
ShipmentID! |
— | — |
packageNumber |
Int! |
— | — |
trackingNumber |
String |
— | — |
length |
Float |
— | — |
width |
Float |
— | — |
height |
Float |
— | — |
weight |
Float |
— | — |
packagingType |
String |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
shipment |
ShipmentState |
— | — |
items |
[ShipmentItemState!]! |
— | — |
ShipmentSortField
STATUS, SHIPMENT_NUMBER, CREATED_AT
ShipmentSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
ShipmentSortField! |
— | — |
direction |
SortDirection! |
— | — |
ShipmentStageBalance
| Field | Type | Default | Arguments |
|---|---|---|---|
stage |
ShipmentEvidenceStage! |
— | — |
observedQuantity |
Int |
— | — |
creditedQuantity |
Int! |
— | — |
unattributedQuantity |
Int |
— | — |
attributionComplete |
Boolean! |
— | — |
ShipmentState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentID! |
— | — |
orderId |
OrderID |
— | — |
carrierId |
CarrierID |
— | — |
destinationSnapshot |
DeliveryAddressSnapshot |
— | — |
consolidationCompatibility |
ConsolidationCompatibility! |
— | — |
shippingAddressId |
AddressID |
— | — |
shipmentNumber |
String |
— | — |
trackingNumber |
String |
— | — |
trackingUrl |
String |
— | — |
status |
ShipmentStatus! |
— | — |
totalWeight |
Float |
— | — |
totalPackages |
Int |
— | — |
shippingCost |
Float |
— | — |
currency |
CurrencyISO |
— | — |
estimatedDeliveryAt |
ISO8601 |
— | — |
shippedAt |
ISO8601 |
— | — |
deliveredAt |
ISO8601 |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
order |
OrderState |
— | — |
carrier |
CarrierState |
— | — |
packages |
[ShipmentPackageState!]! |
— | — |
ShipmentStatus
DRAFT, READY_FOR_PICKUP, PICKED_UP, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, FAILED_DELIVERY, RETURNED, CANCELLED
ShipmentStatusFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
ShipmentStatus |
— | — |
neq |
ShipmentStatus |
— | — |
in |
[ShipmentStatus!] |
— | — |
notIn |
[ShipmentStatus!] |
— | — |
SortDirection
ASC, DESC
SourceDiagnostic
| Field | Type | Default | Arguments |
|---|---|---|---|
document |
String! |
— | — |
startLine |
Int! |
— | — |
startColumn |
Int! |
— | — |
endLine |
Int! |
— | — |
endColumn |
Int! |
— | — |
startOffset |
Int! |
— | — |
endOffset |
Int! |
— | — |
elementID |
String |
— | — |
attribute |
String |
— | — |
inputPath |
String |
— | — |
Stockable
Stockable
StockableType
SUBSTRATE, COMPONENT, FINISHED_GOODS, TOOL, INK, CONSUMABLE
StockCountItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
warehouseStockId |
WarehouseStockID! |
— | — |
countedQuantity |
Float! |
— | — |
StockMovementReason
RECEIVED, TRANSFERRED, ISSUED_TO_PRODUCTION, RETURNED_FROM_PRODUCTION, SHIPPED, ADJUSTED, SCRAPPED, DAMAGED
StringFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
String |
— | — |
neq |
String |
— | — |
contains |
String |
— | — |
startsWith |
String |
— | — |
endsWith |
String |
— | — |
in |
[String!] |
— | — |
notIn |
[String!] |
— | — |
SupplierCategory
SUBSTRATE, INK, CONSUMABLES, OUTSOURCE, EQUIPMENT, LOGISTICS, OTHER
SupplierState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
SupplierID! |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
category |
SupplierCategory! |
— | — |
externalId |
String |
— | — |
contactName |
String |
— | — |
email |
String |
— | — |
phone |
String |
— | — |
website |
String |
— | — |
accountNumber |
String |
— | — |
paymentTerms |
String |
— | — |
currency |
CurrencyISO |
— | — |
leadTimeDays |
Int |
— | — |
isActive |
Boolean! |
— | — |
notes |
String |
— | — |
tags |
[String!] |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
TransferStatus
REQUESTED, APPROVED, IN_PROGRESS, COMPLETED, CANCELLED
TransferStatusFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
TransferStatus |
— | — |
neq |
TransferStatus |
— | — |
in |
[TransferStatus!] |
— | — |
notIn |
[TransferStatus!] |
— | — |
UpdateCarrierInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
code |
String |
— | — |
serviceName |
String |
— | — |
trackingUrlTemplate |
String |
— | — |
pickUpCutoff |
String |
— | — |
transitDays |
Int |
— | — |
accountNumber |
String |
— | — |
contactName |
String |
— | — |
contactPhone |
String |
— | — |
contactEmail |
String |
— | — |
isActive |
Boolean |
— | — |
notes |
String |
— | — |
UpdateEntityNoteInput
| Field | Type | Default | Arguments |
|---|---|---|---|
body |
String! |
— | — |
attribution |
EntityNoteAttributionInput |
— | — |
sourceRevision |
String |
— | — |
UpdateFulfillmentSettingsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
fulfillment |
FulfillmentSettings |
— | — |
errors |
[FieldError!]! |
— | — |
UpdateJobMaterialReservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID |
— | — |
stockableType |
StockableType |
— | — |
stockableId |
String |
— | — |
requiredQuantity |
Float |
— | — |
unit |
MeasurementUnit |
— | — |
preferredLocationId |
WarehouseLocationID |
— | — |
notes |
String |
— | — |
UpdateShipmentInput
| Field | Type | Default | Arguments |
|---|---|---|---|
orderId |
OrderID |
— | — |
carrierId |
CarrierID |
— | — |
destinationSnapshot |
DeliveryAddressSnapshotInput |
— | — |
shippingAddressId |
AddressID |
— | — |
shipmentNumber |
String |
— | — |
trackingNumber |
String |
— | — |
trackingUrl |
String |
— | — |
status |
ShipmentStatus |
— | — |
totalWeight |
Float |
— | — |
totalPackages |
Int |
— | — |
shippingCost |
Float |
— | — |
currency |
CurrencyISO |
— | — |
estimatedDeliveryAt |
ISO8601 |
— | — |
shippedAt |
ISO8601 |
— | — |
deliveredAt |
ISO8601 |
— | — |
notes |
String |
— | — |
UpdateShipmentItemAllocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
quantity |
Int! |
— | — |
UpdateShipmentItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
packageId |
ShipmentPackageID |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
quantity |
Int |
— | — |
UpdateShipmentPackageInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentId |
ShipmentID |
— | — |
packageNumber |
Int |
— | — |
trackingNumber |
String |
— | — |
length |
Float |
— | — |
width |
Float |
— | — |
height |
Float |
— | — |
weight |
Float |
— | — |
packagingType |
String |
— | — |
notes |
String |
— | — |
UpdateShipmentTrackingInput
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentId |
ShipmentID! |
— | — |
status |
ShipmentStatus! |
— | — |
trackingNumber |
String |
— | — |
trackingUrl |
String |
— | — |
estimatedDeliveryAt |
String |
— | — |
deliveredAt |
String |
— | — |
notes |
String |
— | — |
UpdateShipmentTrackingPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipment |
ShipmentState |
— | — |
order |
OrderState |
— | — |
errors |
[FieldError!]! |
— | — |
UpdateWarehouseLocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
parentId |
WarehouseLocationID |
— | — |
name |
String |
— | — |
code |
String |
— | — |
locationType |
WarehouseLocationType |
— | — |
description |
String |
— | — |
maxWeight |
Float |
— | — |
maxVolume |
Float |
— | — |
isActive |
Boolean |
— | — |
sortOrder |
Int |
— | — |
UpdateWarehouseStockInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLotId |
MaterialLotID |
— | — |
locationId |
WarehouseLocationID |
— | — |
stockableType |
StockableType |
— | — |
stockableId |
String |
— | — |
quantity |
Float |
— | — |
unit |
MeasurementUnit |
— | — |
reservedQuantity |
Float |
— | — |
batchNumber |
String |
— | — |
expiryDate |
ISO8601 |
— | — |
lastCountedAt |
ISO8601 |
— | — |
notes |
String |
— | — |
UpdateWarehouseTransferInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLotId |
MaterialLotID |
— | — |
sourceLocationId |
WarehouseLocationID |
— | — |
destinationLocationId |
WarehouseLocationID |
— | — |
stockableType |
StockableType |
— | — |
stockableId |
String |
— | — |
quantity |
Float |
— | — |
unit |
MeasurementUnit |
— | — |
reason |
StockMovementReason |
— | — |
notes |
String |
— | — |
referenceType |
String |
— | — |
referenceId |
String |
— | — |
status |
TransferStatus |
— | — |
requestedByUserId |
UserID |
— | — |
approvedByUserId |
UserID |
— | — |
completedByUserId |
UserID |
— | — |
requestedAt |
ISO8601 |
— | — |
approvedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
UpsertCarrierInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
CarrierID |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
serviceName |
String |
— | — |
trackingUrlTemplate |
String |
— | — |
pickUpCutoff |
String |
— | — |
transitDays |
Int |
— | — |
accountNumber |
String |
— | — |
contactName |
String |
— | — |
contactPhone |
String |
— | — |
contactEmail |
String |
— | — |
isActive |
Boolean |
— | — |
notes |
String |
— | — |
UpsertCarrierPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
carrier |
CarrierState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertJobMaterialReservationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
JobMaterialReservationID |
— | — |
jobId |
JobID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
requiredQuantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
preferredLocationId |
WarehouseLocationID |
— | — |
notes |
String |
— | — |
UpsertJobMaterialReservationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
jobMaterialReservation |
JobMaterialReservationState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertOrderPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
order |
OrderState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertShipmentInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentID |
— | — |
orderId |
OrderID |
— | — |
carrierId |
CarrierID |
— | — |
destinationSnapshot |
DeliveryAddressSnapshotInput |
— | — |
shippingAddressId |
AddressID |
— | — |
shipmentNumber |
String |
— | — |
trackingNumber |
String |
— | — |
trackingUrl |
String |
— | — |
status |
ShipmentStatus |
— | — |
totalWeight |
Float |
— | — |
totalPackages |
Int |
— | — |
shippingCost |
Float |
— | — |
currency |
CurrencyISO |
— | — |
estimatedDeliveryAt |
ISO8601 |
— | — |
shippedAt |
ISO8601 |
— | — |
deliveredAt |
ISO8601 |
— | — |
notes |
String |
— | — |
UpsertShipmentItemInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentItemID |
— | — |
packageId |
ShipmentPackageID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderLineId |
OrderLineID |
— | — |
description |
String |
— | — |
quantity |
Int! |
— | — |
UpsertShipmentItemPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentItem |
ShipmentItemState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertShipmentPackageInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ShipmentPackageID |
— | — |
shipmentId |
ShipmentID! |
— | — |
packageNumber |
Int! |
— | — |
trackingNumber |
String |
— | — |
length |
Float |
— | — |
width |
Float |
— | — |
height |
Float |
— | — |
weight |
Float |
— | — |
packagingType |
String |
— | — |
notes |
String |
— | — |
UpsertShipmentPackagePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipmentPackage |
ShipmentPackageState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertShipmentPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
shipment |
ShipmentState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertWarehouseLocationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WarehouseLocationID |
— | — |
parentId |
WarehouseLocationID |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
locationType |
WarehouseLocationType |
— | — |
description |
String |
— | — |
maxWeight |
Float |
— | — |
maxVolume |
Float |
— | — |
isActive |
Boolean |
— | — |
sortOrder |
Int |
— | — |
UpsertWarehouseStockInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLot |
NewMaterialLotInput |
— | — |
materialLotId |
MaterialLotID |
— | — |
id |
WarehouseStockID |
— | — |
locationId |
WarehouseLocationID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit |
— | — |
reservedQuantity |
Float |
— | — |
batchNumber |
String |
— | — |
expiryDate |
ISO8601 |
— | — |
lastCountedAt |
ISO8601 |
— | — |
notes |
String |
— | — |
UpsertWarehouseTransferInput
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLotId |
MaterialLotID |
— | — |
id |
WarehouseTransferID |
— | — |
sourceLocationId |
WarehouseLocationID! |
— | — |
destinationLocationId |
WarehouseLocationID! |
— | — |
stockableType |
StockableType! |
— | — |
stockableId |
String! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit |
— | — |
reason |
StockMovementReason! |
— | — |
notes |
String |
— | — |
referenceType |
String |
— | — |
referenceId |
String |
— | — |
status |
TransferStatus |
— | — |
requestedByUserId |
UserID |
— | — |
approvedByUserId |
UserID |
— | — |
completedByUserId |
UserID |
— | — |
requestedAt |
ISO8601 |
— | — |
approvedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
UserKind
HUMAN, BOT
UserState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
UserID! |
— | — |
externalId |
String |
— | — |
email |
String! |
— | — |
name |
String |
— | — |
kind |
UserKind! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
WarehouseLocationConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WarehouseLocationEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WarehouseLocationEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WarehouseLocationState! |
— | — |
cursor |
String! |
— | — |
WarehouseLocationFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
locationType |
StringFilter |
— | — |
isActive |
BoolFilter |
— | — |
parentId |
IDFilter |
— | — |
WarehouseLocationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
warehouseLocation |
WarehouseLocationState |
— | — |
errors |
[FieldError!]! |
— | — |
WarehouseLocationSortField
NAME, LOCATION_TYPE, CREATED_AT
WarehouseLocationSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WarehouseLocationSortField! |
— | — |
direction |
SortDirection! |
— | — |
WarehouseLocationState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WarehouseLocationID! |
— | — |
parentId |
WarehouseLocationID |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
locationType |
WarehouseLocationType! |
— | — |
description |
String |
— | — |
maxWeight |
Float |
— | — |
maxVolume |
Float |
— | — |
isActive |
Boolean! |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
WarehouseLocationType
WAREHOUSE, ZONE, AISLE, RACK, SHELF, BIN, STAGING, GOODS_IN, GOODS_OUT, QUARANTINE, PRODUCTION
WarehouseStockConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WarehouseStockEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WarehouseStockEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WarehouseStockState! |
— | — |
cursor |
String! |
— | — |
WarehouseStockFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
stockableType |
StringFilter |
— | — |
stockableId |
StringFilter |
— | — |
locationId |
IDFilter |
— | — |
WarehouseStockPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
warehouseStock |
WarehouseStockState |
— | — |
errors |
[FieldError!]! |
— | — |
WarehouseStockSortField
STOCKABLE_TYPE, QUANTITY, CREATED_AT
WarehouseStockSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WarehouseStockSortField! |
— | — |
direction |
SortDirection! |
— | — |
WarehouseStockState
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLot |
MaterialLot |
— | — |
materialLotId |
MaterialLotID |
— | — |
id |
WarehouseStockID! |
— | — |
locationId |
WarehouseLocationID! |
— | — |
stockable |
Stockable! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
reservedQuantity |
Float! |
— | — |
availableQuantity |
Float! |
— | — |
batchNumber |
String |
— | — |
expiryDate |
ISO8601 |
— | — |
lastCountedAt |
ISO8601 |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
WarehouseTransferConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WarehouseTransferEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WarehouseTransferEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WarehouseTransferState! |
— | — |
cursor |
String! |
— | — |
WarehouseTransferFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
TransferStatusFilter |
— | — |
reason |
StringFilter |
— | — |
sourceLocationId |
IDFilter |
— | — |
destinationLocationId |
IDFilter |
— | — |
WarehouseTransferPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
warehouseTransfer |
WarehouseTransferState |
— | — |
errors |
[FieldError!]! |
— | — |
WarehouseTransferSortField
STATUS, REASON, REQUESTED_AT, CREATED_AT
WarehouseTransferSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WarehouseTransferSortField! |
— | — |
direction |
SortDirection! |
— | — |
WarehouseTransferState
| Field | Type | Default | Arguments |
|---|---|---|---|
materialLotId |
MaterialLotID |
— | — |
id |
WarehouseTransferID! |
— | — |
sourceLocationId |
WarehouseLocationID! |
— | — |
destinationLocationId |
WarehouseLocationID! |
— | — |
stockable |
Stockable! |
— | — |
quantity |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
reason |
StockMovementReason! |
— | — |
notes |
String |
— | — |
referenceType |
String |
— | — |
referenceId |
String |
— | — |
status |
TransferStatus! |
— | — |
requestedByUserId |
UserID |
— | — |
approvedByUserId |
UserID |
— | — |
completedByUserId |
UserID |
— | — |
requestedAt |
ISO8601! |
— | — |
approvedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
WhatIfEdgeInput
| Field | Type | Default | Arguments |
|---|---|---|---|
source |
ID! |
— | — |
target |
ID! |
— | — |
rel |
String |
— | — |
weight |
Float |
— | — |
WhatIfNode
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
type |
String! |
— | — |
status |
String |
— | — |
label |
String |
— | — |
depth |
Int |
— | — |
newlyReachable |
Boolean! |
— | — |
WhatIfResult
| Field | Type | Default | Arguments |
|---|---|---|---|
affected |
[WhatIfNode!]! |
— | — |
introducesCycle |
Boolean! |
— | — |
Published platform manual · revision d7f1f3939d71