ZRM Docs
API ReferenceProduct

product.create

Type: Mutation · Auth: Workspace admin

Input

FieldTypeRequiredDefaultDescription
categoryIdstringYesID of the associated category
namestringYesName
skustringYesSku
descriptionstringYesDescription
manufacturerstringNoManufacturer
modelNumberstringNoModel number
unitPricenumberNoUnit price
costPricenumberNoCost price
msrpnumberNoMsrp
unitenum(each, foot, meter, box, roll, pair, kit)Yes"each"Unit
statusenum(draft, active, discontinued)Yes"draft"Status
attributesobjectYes{}Attributes
imageUrlstring.uriNoImage url
datasheetUrlstring.uriNoDatasheet url
warrantyMonthsintegerNoWarranty months
leadTimeDaysintegerNoLead time days
minOrderQuantityintegerYes1Min order quantity
estimatedLaborHoursnumberNoEstimated labor hours
laborNotesstringNoLabor notes
notesstringNoNotes
productTypeenum(controller, panel, camera, sensor, reader, lock, switch, server, nvr_dvr, workstation, ups, pdu, enclosure, module, cable_run, access_point, intercom_station, other)NoProduct type
cutSheetS3KeystringNoCut sheet s3key
trackInventorybooleanYesfalseTrack inventory
reorderPointunknownNoReorder point
reorderQtyunknownNoReorder qty
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "categoryId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "sku": "example",
  "description": "A description",
  "manufacturer": "example",
  "modelNumber": "example",
  "unit": "each",
  "status": "draft",
  "attributes": {},
  "minOrderQuantity": 1,
  "trackInventory": false,
  "visibilityMode": "global"
}

On this page