Work Order
SCHEMA
WorkOrderRecordDto▶identifiersobjectHow this work order is identified.
- idstringYour unique reference for this work order.
- businessIdstringYour Fuse business ID. Must match the businessId you authenticate with.
- businessWorkOrderIdstring
- customerIdstringThe customer account the work is for.
- businessCustomerIdstring
- shipmentIdstring
- salesOrderstring
- consignmentIdstring
- pickGroupIdstring
- primestring
▶workOrderobjectWhat kind of work this is and how it is referenced.
- typeenumone of "kitting", "rework", "quality_check", "special_handling", "disposition"The work type — kitting (build a bundle from components), rework, quality_check, special_handling, or disposition.
- classstringWork-order class code from your onboarding configuration.
- statusstring
- stagestring
- priorityPrimestring
- priorityAllocationstring
- priorityDespatchstring
- customerRefstringmandatoryThe customer-facing work-order reference.
- instructionsstringFree-text build instructions for the warehouse team.
- notesstring
- supervisorstring
- generalReasonstring
- returnReasonstring
- maintenanceIndicatorstring
▶customerobject
- groupstring
- namestring
- referencestring
▶locationobjectWhere the work happens.
- sitestringSite code, from your onboarding configuration.
- warehousestringWarehouse code within the site.
- ownerIdstringmandatoryStock owner the work books against.
- stockStatusstring
- regionstring
- distributionCenterstring
- storestring
▶qualityControlobject
- qualityControlstring
- shortageCodestring
- quantityVariancestring
- cutOffIndstring
▶quantitiesobject
- totalLinesnumber
- totalComponentsnumber
- totalFinishedGoodsnumber
- totalQuantitynumber
- stockTransferUnitQuantitynumber
- volumenumber
- weightnumber
- actualWeightnumber
▶tasksobject
- countNewnumber
- countCurrentnumber
- countActionednumber
▶timingobject
- timeToPicknumber
- timeToPacknumber
- timeToChecknumber
- timeToLoadnumber
- timeOthernumber
- timeToDelivernumber
▶financialobject
- currencystring
▶shippingobject
- shippingLanestring
▶datesobjectWork-order dates.
- createdstringISO 8601 date or date-time
- dueBystringWhen the work must be complete.
- dueOutstringISO 8601 date or date-time
- startedstringISO 8601 date or date-time
- completedstringISO 8601 date or date-time
- shipmentstringISO 8601 date or date-time
- deliverystringISO 8601 date or date-time
- closedstringISO 8601 date or date-time
- suspendedstringISO 8601 date or date-time
▶indicatorsobject
- overduestring
- paperworkstring
▶metadataobject
- notesstring
▶miscobject
- valuesstring
▶customisationsarray of object
- namestring
- valuestring
▶linesarray of objectThe work-order lines — the finished good being built and the components consumed. Component quantities are totals for the whole build, not per kit.
- workOrderIdstringThe work order this line belongs to — repeat the header id.
- linestringmandatoryLine number within the work order, as a string.
- levelstring
- skuIdstringmandatoryThe SKU on this line — the master/kit SKU on the finished-good line, a component SKU otherwise.
- businessSKUstring
- customerSKUstring
- customerOrderstring
- soLineIdnumber
- roleenumone of "component", "finished_good"finished_good marks the master SKU being produced; component marks a stock item consumed to build it.
▶productobject
- upcstring
- upcDescriptionstring
- categorystring
- unitOfMeasurestring
- catchWeightnumber
▶ownershipobject
- lineOwnerstring
- lineStockStatusstring
- ownerIdstring
- stockStatusstring
▶quantitiesobjectLine quantities — ordered on the finished-good line, required on component lines.
- orderednumberQuantity of the finished good to build.
- requirednumberTotal component quantity consumed across the whole build (10 kits needing two each = 20).
- allocatednumber
- taskednumber
- pickednumber
- consumednumber
- producednumber
- shippednumber
- deliverednumber
- dueOutnumber
▶qualityobject
- returnReasonstring
- qualityControlstring
- shortagestring
- quantityVariancestring
▶indicatorsobject
- backOrderIndicatorstring
- attachmentIndstring
- specialConditionIndstring
▶locationobject
- consignmentIdstring
- pickGroupIdstring
- siteIdstring
- warehousestring
▶businessobject
- businessIdstring
▶timingobject
- datePickedstringISO 8601 date or date-time
- dateConsumedstringISO 8601 date or date-time
- dateProducedstringISO 8601 date or date-time
- dateShipmentstringISO 8601 date or date-time
- stagestring
▶miscobject
- lineValuesstring
▶customisationsarray of object
- namestring
- valuestring